# REST API endpoints for Project items Use the REST API to manage Project items ## List items for an organization owned project ``` GET /orgs/{org}/projectsV2/{project_number}/items ``` List all items for a specific organization-owned project accessible by the authenticated user. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`project_number`** (integer) (required) The project's number. * **`org`** (string) (required) The organization name. The name is not case sensitive. * **`q`** (string) Search query to filter items, see Filtering projects for more information. * **`fields`** (string) Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: fields\[]=123\&fields\[]=456\&fields\[]=789 or fields=123,456,789 * **`before`** (string) A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API." * **`after`** (string) A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API." * **`per_page`** (integer) The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30` ### HTTP response status codes * **200** - OK * **304** - Not modified * **401** - Requires authentication * **403** - Forbidden ### Code examples #### Example **Request:** ```curl curl -L \ -X GET \ https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" ``` **Response schema:** ```json Status: 200 { "type": "array", "items": { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", "description": "The API URL of the project that contains this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "content": { "type": [ "object", "null" ], "additionalProperties": true, "description": "The content of the item, which varies by content type." }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "item_url": { "type": [ "string", "null" ], "format": "uri", "description": "The API URL of this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "The fields and values associated with this item." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } } ``` ## Add item to organization owned project ``` POST /orgs/{org}/projectsV2/{project_number}/items ``` Add an issue or pull request item to the specified organization owned project. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`org`** (string) (required) The organization name. The name is not case sensitive. * **`project_number`** (integer) (required) The project's number. ### HTTP response status codes * **201** - Created * **304** - Not modified * **401** - Requires authentication * **403** - Forbidden ### Code examples #### Add an issue using its unique ID **Request:** ```curl curl -L \ -X POST \ https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "type": "Issue", "id": 3 }' ``` **Response schema:** ```json Status: 201 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "content": { "oneOf": [ { "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", "format": "int64" }, "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", "duplicate", 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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" }, "type": { "title": "Issue Type", "description": "The type of issue.", "type": [ "object", "null" ], "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue type." }, "node_id": { "type": "string", "description": "The node identifier of the issue type." }, "name": { "type": "string", "description": "The name of the issue type." }, "description": { "type": [ "string", "null" ], "description": "The description of the issue type." }, "color": { "type": [ "string", "null" ], "description": "The color of the issue type.", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, "created_at": { "type": "string", "description": "The time the issue type created.", "format": "date-time" }, "updated_at": { "type": "string", "description": "The time the issue type last updated.", "format": "date-time" }, "is_enabled": { "type": "boolean", "description": "The enabled state of the issue type." } }, "required": [ "id", "node_id", "name", "description" ] }, "repository": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "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", "null" ], "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==" ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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 on GitHub.", "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" ] } ] }, "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. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "type": "integer", "examples": [ 5 ] } }, "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" ] }, "sub_issues_summary": { "title": "Sub-issues Summary", "type": "object", "properties": { "total": { "type": "integer" }, "completed": { "type": "integer" }, "percent_completed": { "type": "integer" } }, "required": [ "total", "completed", "percent_completed" ] }, "parent_issue_url": { "description": "URL to get the parent issue of this issue, if it is a sub-issue", "type": [ "string", "null" ], "format": "uri" }, "issue_dependencies_summary": { "title": "Issue Dependencies Summary", "type": "object", "properties": { "blocked_by": { "type": "integer" }, "blocking": { "type": "integer" }, "total_blocked_by": { "type": "integer" }, "total_blocking": { "type": "integer" } }, "required": [ "blocked_by", "blocking", "total_blocked_by", "total_blocking" ] }, "issue_field_values": { "type": "array", "items": { "title": "Issue Field Value", "description": "A value assigned to an issue field", "type": "object", "properties": { "issue_field_id": { "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "IFT_GDKND" ] }, "data_type": { "description": "The data type of the issue field", "type": "string", "enum": [ "text", "single_select", "number", "date" ], "examples": [ "text" ] }, "value": { "description": "The value of the issue field", "anyOf": [ { "type": "string", "examples": [ "Sample text" ] }, { "type": "number", "examples": [ 42.5 ] }, { "type": "integer", "examples": [ 1 ] } ], "type": [ "null", "string", "number", "integer" ] }, "single_select_option": { "description": "Details about the selected option (only present for single_select fields)", "type": [ "object", "null" ], "properties": { "id": { "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "examples": [ 1 ] }, "name": { "description": "The name of the option", "type": "string", "examples": [ "High" ] }, "color": { "description": "The color of the option", "type": "string", "examples": [ "red" ] } }, "required": [ "id", "name", "color" ] } }, "required": [ "issue_field_id", "node_id", "data_type", "value" ] } } }, "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", "created_at", "updated_at" ] }, { "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", "format": "int64", "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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" }, "notification_setting": { "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" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [ 37 ] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ 42 ] }, "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" ] }, "notification_setting": { "description": "The notification setting the team has set", "type": "string", "examples": [ "notifications_enabled" ] }, "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" ] }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [ 37 ] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ 42 ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "type" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent", "type" ] } }, "head": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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 repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" ] }, { "title": "Draft Issue", "description": "A draft issue in a project", "type": "object", "properties": { "id": { "type": "number", "description": "The ID of the draft issue" }, "node_id": { "type": "string", "description": "The node ID of the draft issue" }, "title": { "type": "string", "description": "The title of the draft issue" }, "body": { "type": [ "string", "null" ], "description": "The body content of the draft issue" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time the draft issue was created" }, "updated_at": { "type": "string", "format": "date-time", "description": "The time the draft issue was last updated" } }, "required": [ "id", "node_id", "title", "user", "created_at", "updated_at" ] } ], "description": "The content represented by the item." }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "project_url": { "type": "string", "format": "uri", "description": "The URL of the project this item belongs to." }, "item_url": { "type": "string", "format": "uri", "description": "The URL of the item in the project." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` #### Add a pull request using its unique ID **Request:** ```curl curl -L \ -X POST \ https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "type": "PullRequest", "id": 3 }' ``` **Response schema:** ```json Status: 201 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "content": { "oneOf": [ { "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", "format": "int64" }, "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", "duplicate", 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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" }, "type": { "title": "Issue Type", "description": "The type of issue.", "type": [ "object", "null" ], "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue type." }, "node_id": { "type": "string", "description": "The node identifier of the issue type." }, "name": { "type": "string", "description": "The name of the issue type." }, "description": { "type": [ "string", "null" ], "description": "The description of the issue type." }, "color": { "type": [ "string", "null" ], "description": "The color of the issue type.", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, "created_at": { "type": "string", "description": "The time the issue type created.", "format": "date-time" }, "updated_at": { "type": "string", "description": "The time the issue type last updated.", "format": "date-time" }, "is_enabled": { "type": "boolean", "description": "The enabled state of the issue type." } }, "required": [ "id", "node_id", "name", "description" ] }, "repository": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "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", "null" ], "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==" ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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 on GitHub.", "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" ] } ] }, "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. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "type": "integer", "examples": [ 5 ] } }, "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" ] }, "sub_issues_summary": { "title": "Sub-issues Summary", "type": "object", "properties": { "total": { "type": "integer" }, "completed": { "type": "integer" }, "percent_completed": { "type": "integer" } }, "required": [ "total", "completed", "percent_completed" ] }, "parent_issue_url": { "description": "URL to get the parent issue of this issue, if it is a sub-issue", "type": [ "string", "null" ], "format": "uri" }, "issue_dependencies_summary": { "title": "Issue Dependencies Summary", "type": "object", "properties": { "blocked_by": { "type": "integer" }, "blocking": { "type": "integer" }, "total_blocked_by": { "type": "integer" }, "total_blocking": { "type": "integer" } }, "required": [ "blocked_by", "blocking", "total_blocked_by", "total_blocking" ] }, "issue_field_values": { "type": "array", "items": { "title": "Issue Field Value", "description": "A value assigned to an issue field", "type": "object", "properties": { "issue_field_id": { "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "IFT_GDKND" ] }, "data_type": { "description": "The data type of the issue field", "type": "string", "enum": [ "text", "single_select", "number", "date" ], "examples": [ "text" ] }, "value": { "description": "The value of the issue field", "anyOf": [ { "type": "string", "examples": [ "Sample text" ] }, { "type": "number", "examples": [ 42.5 ] }, { "type": "integer", "examples": [ 1 ] } ], "type": [ "null", "string", "number", "integer" ] }, "single_select_option": { "description": "Details about the selected option (only present for single_select fields)", "type": [ "object", "null" ], "properties": { "id": { "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "examples": [ 1 ] }, "name": { "description": "The name of the option", "type": "string", "examples": [ "High" ] }, "color": { "description": "The color of the option", "type": "string", "examples": [ "red" ] } }, "required": [ "id", "name", "color" ] } }, "required": [ "issue_field_id", "node_id", "data_type", "value" ] } } }, "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", "created_at", "updated_at" ] }, { "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", "format": "int64", "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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" }, "notification_setting": { "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" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [ 37 ] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ 42 ] }, "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" ] }, "notification_setting": { "description": "The notification setting the team has set", "type": "string", "examples": [ "notifications_enabled" ] }, "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" ] }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [ 37 ] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ 42 ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "type" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent", "type" ] } }, "head": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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 repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" ] }, { "title": "Draft Issue", "description": "A draft issue in a project", "type": "object", "properties": { "id": { "type": "number", "description": "The ID of the draft issue" }, "node_id": { "type": "string", "description": "The node ID of the draft issue" }, "title": { "type": "string", "description": "The title of the draft issue" }, "body": { "type": [ "string", "null" ], "description": "The body content of the draft issue" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time the draft issue was created" }, "updated_at": { "type": "string", "format": "date-time", "description": "The time the draft issue was last updated" } }, "required": [ "id", "node_id", "title", "user", "created_at", "updated_at" ] } ], "description": "The content represented by the item." }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "project_url": { "type": "string", "format": "uri", "description": "The URL of the project this item belongs to." }, "item_url": { "type": "string", "format": "uri", "description": "The URL of the item in the project." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` #### Add an issue using repository owner, name, and issue number **Request:** ```curl curl -L \ -X POST \ https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "type": "Issue", "owner": "octocat", "repo": "hello-world", "number": 42 }' ``` **Response schema:** ```json Status: 201 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "content": { "oneOf": [ { "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", "format": "int64" }, "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", "duplicate", 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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" }, "type": { "title": "Issue Type", "description": "The type of issue.", "type": [ "object", "null" ], "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue type." }, "node_id": { "type": "string", "description": "The node identifier of the issue type." }, "name": { "type": "string", "description": "The name of the issue type." }, "description": { "type": [ "string", "null" ], "description": "The description of the issue type." }, "color": { "type": [ "string", "null" ], "description": "The color of the issue type.", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, "created_at": { "type": "string", "description": "The time the issue type created.", "format": "date-time" }, "updated_at": { "type": "string", "description": "The time the issue type last updated.", "format": "date-time" }, "is_enabled": { "type": "boolean", "description": "The enabled state of the issue type." } }, "required": [ "id", "node_id", "name", "description" ] }, "repository": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "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", "null" ], "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==" ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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 on GitHub.", "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" ] } ] }, "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. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "type": "integer", "examples": [ 5 ] } }, "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" ] }, "sub_issues_summary": { "title": "Sub-issues Summary", "type": "object", "properties": { "total": { "type": "integer" }, "completed": { "type": "integer" }, "percent_completed": { "type": "integer" } }, "required": [ "total", "completed", "percent_completed" ] }, "parent_issue_url": { "description": "URL to get the parent issue of this issue, if it is a sub-issue", "type": [ "string", "null" ], "format": "uri" }, "issue_dependencies_summary": { "title": "Issue Dependencies Summary", "type": "object", "properties": { "blocked_by": { "type": "integer" }, "blocking": { "type": "integer" }, "total_blocked_by": { "type": "integer" }, "total_blocking": { "type": "integer" } }, "required": [ "blocked_by", "blocking", "total_blocked_by", "total_blocking" ] }, "issue_field_values": { "type": "array", "items": { "title": "Issue Field Value", "description": "A value assigned to an issue field", "type": "object", "properties": { "issue_field_id": { "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "IFT_GDKND" ] }, "data_type": { "description": "The data type of the issue field", "type": "string", "enum": [ "text", "single_select", "number", "date" ], "examples": [ "text" ] }, "value": { "description": "The value of the issue field", "anyOf": [ { "type": "string", "examples": [ "Sample text" ] }, { "type": "number", "examples": [ 42.5 ] }, { "type": "integer", "examples": [ 1 ] } ], "type": [ "null", "string", "number", "integer" ] }, "single_select_option": { "description": "Details about the selected option (only present for single_select fields)", "type": [ "object", "null" ], "properties": { "id": { "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "examples": [ 1 ] }, "name": { "description": "The name of the option", "type": "string", "examples": [ "High" ] }, "color": { "description": "The color of the option", "type": "string", "examples": [ "red" ] } }, "required": [ "id", "name", "color" ] } }, "required": [ "issue_field_id", "node_id", "data_type", "value" ] } } }, "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", "created_at", "updated_at" ] }, { "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", "format": "int64", "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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" }, "notification_setting": { "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" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [ 37 ] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ 42 ] }, "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" ] }, "notification_setting": { "description": "The notification setting the team has set", "type": "string", "examples": [ "notifications_enabled" ] }, "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" ] }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [ 37 ] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ 42 ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "type" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent", "type" ] } }, "head": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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 repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" ] }, { "title": "Draft Issue", "description": "A draft issue in a project", "type": "object", "properties": { "id": { "type": "number", "description": "The ID of the draft issue" }, "node_id": { "type": "string", "description": "The node ID of the draft issue" }, "title": { "type": "string", "description": "The title of the draft issue" }, "body": { "type": [ "string", "null" ], "description": "The body content of the draft issue" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time the draft issue was created" }, "updated_at": { "type": "string", "format": "date-time", "description": "The time the draft issue was last updated" } }, "required": [ "id", "node_id", "title", "user", "created_at", "updated_at" ] } ], "description": "The content represented by the item." }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "project_url": { "type": "string", "format": "uri", "description": "The URL of the project this item belongs to." }, "item_url": { "type": "string", "format": "uri", "description": "The URL of the item in the project." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` #### Add a pull request using repository owner, name, and PR number **Request:** ```curl curl -L \ -X POST \ https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "type": "PullRequest", "owner": "octocat", "repo": "hello-world", "number": 123 }' ``` **Response schema:** ```json Status: 201 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "content": { "oneOf": [ { "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", "format": "int64" }, "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", "duplicate", 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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" }, "type": { "title": "Issue Type", "description": "The type of issue.", "type": [ "object", "null" ], "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue type." }, "node_id": { "type": "string", "description": "The node identifier of the issue type." }, "name": { "type": "string", "description": "The name of the issue type." }, "description": { "type": [ "string", "null" ], "description": "The description of the issue type." }, "color": { "type": [ "string", "null" ], "description": "The color of the issue type.", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, "created_at": { "type": "string", "description": "The time the issue type created.", "format": "date-time" }, "updated_at": { "type": "string", "description": "The time the issue type last updated.", "format": "date-time" }, "is_enabled": { "type": "boolean", "description": "The enabled state of the issue type." } }, "required": [ "id", "node_id", "name", "description" ] }, "repository": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "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", "null" ], "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==" ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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 on GitHub.", "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" ] } ] }, "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. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "type": "integer", "examples": [ 5 ] } }, "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" ] }, "sub_issues_summary": { "title": "Sub-issues Summary", "type": "object", "properties": { "total": { "type": "integer" }, "completed": { "type": "integer" }, "percent_completed": { "type": "integer" } }, "required": [ "total", "completed", "percent_completed" ] }, "parent_issue_url": { "description": "URL to get the parent issue of this issue, if it is a sub-issue", "type": [ "string", "null" ], "format": "uri" }, "issue_dependencies_summary": { "title": "Issue Dependencies Summary", "type": "object", "properties": { "blocked_by": { "type": "integer" }, "blocking": { "type": "integer" }, "total_blocked_by": { "type": "integer" }, "total_blocking": { "type": "integer" } }, "required": [ "blocked_by", "blocking", "total_blocked_by", "total_blocking" ] }, "issue_field_values": { "type": "array", "items": { "title": "Issue Field Value", "description": "A value assigned to an issue field", "type": "object", "properties": { "issue_field_id": { "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "IFT_GDKND" ] }, "data_type": { "description": "The data type of the issue field", "type": "string", "enum": [ "text", "single_select", "number", "date" ], "examples": [ "text" ] }, "value": { "description": "The value of the issue field", "anyOf": [ { "type": "string", "examples": [ "Sample text" ] }, { "type": "number", "examples": [ 42.5 ] }, { "type": "integer", "examples": [ 1 ] } ], "type": [ "null", "string", "number", "integer" ] }, "single_select_option": { "description": "Details about the selected option (only present for single_select fields)", "type": [ "object", "null" ], "properties": { "id": { "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "examples": [ 1 ] }, "name": { "description": "The name of the option", "type": "string", "examples": [ "High" ] }, "color": { "description": "The color of the option", "type": "string", "examples": [ "red" ] } }, "required": [ "id", "name", "color" ] } }, "required": [ "issue_field_id", "node_id", "data_type", "value" ] } } }, "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", "created_at", "updated_at" ] }, { "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", "format": "int64", "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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" }, "notification_setting": { "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" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [ 37 ] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ 42 ] }, "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" ] }, "notification_setting": { "description": "The notification setting the team has set", "type": "string", "examples": [ "notifications_enabled" ] }, "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" ] }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [ 37 ] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ 42 ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "type" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent", "type" ] } }, "head": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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 repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" ] }, { "title": "Draft Issue", "description": "A draft issue in a project", "type": "object", "properties": { "id": { "type": "number", "description": "The ID of the draft issue" }, "node_id": { "type": "string", "description": "The node ID of the draft issue" }, "title": { "type": "string", "description": "The title of the draft issue" }, "body": { "type": [ "string", "null" ], "description": "The body content of the draft issue" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time the draft issue was created" }, "updated_at": { "type": "string", "format": "date-time", "description": "The time the draft issue was last updated" } }, "required": [ "id", "node_id", "title", "user", "created_at", "updated_at" ] } ], "description": "The content represented by the item." }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "project_url": { "type": "string", "format": "uri", "description": "The URL of the project this item belongs to." }, "item_url": { "type": "string", "format": "uri", "description": "The URL of the item in the project." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` ## Get an item for an organization owned project ``` GET /orgs/{org}/projectsV2/{project_number}/items/{item_id} ``` Get a specific item from an organization-owned project. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`project_number`** (integer) (required) The project's number. * **`org`** (string) (required) The organization name. The name is not case sensitive. * **`item_id`** (integer) (required) The unique identifier of the project item. * **`fields`** (string) Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: fields\[]=123\&fields\[]=456\&fields\[]=789 or fields=123,456,789 ### HTTP response status codes * **200** - OK * **304** - Not modified * **401** - Requires authentication * **403** - Forbidden ### Code examples #### Example **Request:** ```curl curl -L \ -X GET \ https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items/ITEM_ID \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" ``` **Response schema:** ```json Status: 200 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", "description": "The API URL of the project that contains this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "content": { "type": [ "object", "null" ], "additionalProperties": true, "description": "The content of the item, which varies by content type." }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "item_url": { "type": [ "string", "null" ], "format": "uri", "description": "The API URL of this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "The fields and values associated with this item." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` ## Update project item for organization ``` PATCH /orgs/{org}/projectsV2/{project_number}/items/{item_id} ``` Update a specific item in an organization-owned project. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`project_number`** (integer) (required) The project's number. * **`org`** (string) (required) The organization name. The name is not case sensitive. * **`item_id`** (integer) (required) The unique identifier of the project item. #### Body parameters * **`fields`** (array of objects) (required) A list of field updates to apply. * **`id`** (integer) (required) The ID of the project field to update. * **`value`** (null or string or number) (required) The new value for the field: For text, number, and date fields, provide the new value directly. For single select and iteration fields, provide the ID of the option or iteration. To clear the field, set this to null. ### HTTP response status codes * **200** - OK * **401** - Requires authentication * **403** - Forbidden * **404** - Resource not found * **422** - Validation failed, or the endpoint has been spammed. ### Code examples #### Update a text field **Request:** ```curl curl -L \ -X PATCH \ https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items/ITEM_ID \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "fields": [ { "id": 123, "value": "Updated text value" } ] }' ``` **Response schema:** ```json Status: 200 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", "description": "The API URL of the project that contains this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "content": { "type": [ "object", "null" ], "additionalProperties": true, "description": "The content of the item, which varies by content type." }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "item_url": { "type": [ "string", "null" ], "format": "uri", "description": "The API URL of this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "The fields and values associated with this item." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` #### Update a number field **Request:** ```curl curl -L \ -X PATCH \ https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items/ITEM_ID \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "fields": [ { "id": 456, "value": 42.5 } ] }' ``` **Response schema:** ```json Status: 200 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", "description": "The API URL of the project that contains this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "content": { "type": [ "object", "null" ], "additionalProperties": true, "description": "The content of the item, which varies by content type." }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "item_url": { "type": [ "string", "null" ], "format": "uri", "description": "The API URL of this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "The fields and values associated with this item." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` #### Update a date field **Request:** ```curl curl -L \ -X PATCH \ https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items/ITEM_ID \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "fields": [ { "id": 789, "value": "2023-10-05" } ] }' ``` **Response schema:** ```json Status: 200 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", "description": "The API URL of the project that contains this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "content": { "type": [ "object", "null" ], "additionalProperties": true, "description": "The content of the item, which varies by content type." }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "item_url": { "type": [ "string", "null" ], "format": "uri", "description": "The API URL of this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "The fields and values associated with this item." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` #### Update a single select field **Request:** ```curl curl -L \ -X PATCH \ https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items/ITEM_ID \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "fields": [ { "id": 789, "value": "47fc9ee4" } ] }' ``` **Response schema:** ```json Status: 200 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", "description": "The API URL of the project that contains this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "content": { "type": [ "object", "null" ], "additionalProperties": true, "description": "The content of the item, which varies by content type." }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "item_url": { "type": [ "string", "null" ], "format": "uri", "description": "The API URL of this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "The fields and values associated with this item." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` #### Update an iteration field **Request:** ```curl curl -L \ -X PATCH \ https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items/ITEM_ID \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "fields": [ { "id": 1011, "value": "866ee5b8" } ] }' ``` **Response schema:** ```json Status: 200 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", "description": "The API URL of the project that contains this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "content": { "type": [ "object", "null" ], "additionalProperties": true, "description": "The content of the item, which varies by content type." }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "item_url": { "type": [ "string", "null" ], "format": "uri", "description": "The API URL of this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "The fields and values associated with this item." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` ## Delete project item for organization ``` DELETE /orgs/{org}/projectsV2/{project_number}/items/{item_id} ``` Delete a specific item from an organization-owned project. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`project_number`** (integer) (required) The project's number. * **`org`** (string) (required) The organization name. The name is not case sensitive. * **`item_id`** (integer) (required) The unique identifier of the project item. ### HTTP response status codes * **204** - No Content * **401** - Requires authentication * **403** - Forbidden ### Code examples #### Example **Request:** ```curl curl -L \ -X DELETE \ https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/items/ITEM_ID \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" ``` **Response schema:** ``` Status: 204 ``` ## List items for an organization project view ``` GET /orgs/{org}/projectsV2/{project_number}/views/{view_number}/items ``` List items in an organization project with the saved view's filter applied. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`project_number`** (integer) (required) The project's number. * **`org`** (string) (required) The organization name. The name is not case sensitive. * **`view_number`** (integer) (required) The number that identifies the project view. * **`fields`** (string) Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: fields\[]=123\&fields\[]=456\&fields\[]=789 or fields=123,456,789 * **`before`** (string) A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API." * **`after`** (string) A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API." * **`per_page`** (integer) The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30` ### HTTP response status codes * **200** - OK * **304** - Not modified * **401** - Requires authentication * **403** - Forbidden * **404** - Resource not found ### Code examples #### Example **Request:** ```curl curl -L \ -X GET \ https://api.github.com/orgs/ORG/projectsV2/PROJECT_NUMBER/views/VIEW_NUMBER/items \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" ``` **Response schema:** ```json Status: 200 { "type": "array", "items": { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", "description": "The API URL of the project that contains this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "content": { "type": [ "object", "null" ], "additionalProperties": true, "description": "The content of the item, which varies by content type." }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "item_url": { "type": [ "string", "null" ], "format": "uri", "description": "The API URL of this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "The fields and values associated with this item." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } } ``` ## List items for a user owned project ``` GET /users/{username}/projectsV2/{project_number}/items ``` List all items for a specific user-owned project accessible by the authenticated user. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`project_number`** (integer) (required) The project's number. * **`username`** (string) (required) The handle for the GitHub user account. * **`before`** (string) A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API." * **`after`** (string) A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API." * **`per_page`** (integer) The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30` * **`q`** (string) Search query to filter items, see Filtering projects for more information. * **`fields`** (string) Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: fields\[]=123\&fields\[]=456\&fields\[]=789 or fields=123,456,789 ### HTTP response status codes * **200** - OK * **304** - Not modified * **401** - Requires authentication * **403** - Forbidden ### Code examples #### Example **Request:** ```curl curl -L \ -X GET \ https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" ``` **Response schema:** ```json Status: 200 { "type": "array", "items": { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", "description": "The API URL of the project that contains this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "content": { "type": [ "object", "null" ], "additionalProperties": true, "description": "The content of the item, which varies by content type." }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "item_url": { "type": [ "string", "null" ], "format": "uri", "description": "The API URL of this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "The fields and values associated with this item." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } } ``` ## Add item to user owned project ``` POST /users/{username}/projectsV2/{project_number}/items ``` Add an issue or pull request item to the specified user owned project. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`username`** (string) (required) The handle for the GitHub user account. * **`project_number`** (integer) (required) The project's number. ### HTTP response status codes * **201** - Created * **304** - Not modified * **401** - Requires authentication * **403** - Forbidden ### Code examples #### Add an issue using its unique ID **Request:** ```curl curl -L \ -X POST \ https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "type": "Issue", "id": 3 }' ``` **Response schema:** ```json Status: 201 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "content": { "oneOf": [ { "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", "format": "int64" }, "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", "duplicate", 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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" }, "type": { "title": "Issue Type", "description": "The type of issue.", "type": [ "object", "null" ], "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue type." }, "node_id": { "type": "string", "description": "The node identifier of the issue type." }, "name": { "type": "string", "description": "The name of the issue type." }, "description": { "type": [ "string", "null" ], "description": "The description of the issue type." }, "color": { "type": [ "string", "null" ], "description": "The color of the issue type.", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, "created_at": { "type": "string", "description": "The time the issue type created.", "format": "date-time" }, "updated_at": { "type": "string", "description": "The time the issue type last updated.", "format": "date-time" }, "is_enabled": { "type": "boolean", "description": "The enabled state of the issue type." } }, "required": [ "id", "node_id", "name", "description" ] }, "repository": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "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", "null" ], "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==" ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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 on GitHub.", "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" ] } ] }, "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. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "type": "integer", "examples": [ 5 ] } }, "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" ] }, "sub_issues_summary": { "title": "Sub-issues Summary", "type": "object", "properties": { "total": { "type": "integer" }, "completed": { "type": "integer" }, "percent_completed": { "type": "integer" } }, "required": [ "total", "completed", "percent_completed" ] }, "parent_issue_url": { "description": "URL to get the parent issue of this issue, if it is a sub-issue", "type": [ "string", "null" ], "format": "uri" }, "issue_dependencies_summary": { "title": "Issue Dependencies Summary", "type": "object", "properties": { "blocked_by": { "type": "integer" }, "blocking": { "type": "integer" }, "total_blocked_by": { "type": "integer" }, "total_blocking": { "type": "integer" } }, "required": [ "blocked_by", "blocking", "total_blocked_by", "total_blocking" ] }, "issue_field_values": { "type": "array", "items": { "title": "Issue Field Value", "description": "A value assigned to an issue field", "type": "object", "properties": { "issue_field_id": { "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "IFT_GDKND" ] }, "data_type": { "description": "The data type of the issue field", "type": "string", "enum": [ "text", "single_select", "number", "date" ], "examples": [ "text" ] }, "value": { "description": "The value of the issue field", "anyOf": [ { "type": "string", "examples": [ "Sample text" ] }, { "type": "number", "examples": [ 42.5 ] }, { "type": "integer", "examples": [ 1 ] } ], "type": [ "null", "string", "number", "integer" ] }, "single_select_option": { "description": "Details about the selected option (only present for single_select fields)", "type": [ "object", "null" ], "properties": { "id": { "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "examples": [ 1 ] }, "name": { "description": "The name of the option", "type": "string", "examples": [ "High" ] }, "color": { "description": "The color of the option", "type": "string", "examples": [ "red" ] } }, "required": [ "id", "name", "color" ] } }, "required": [ "issue_field_id", "node_id", "data_type", "value" ] } } }, "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", "created_at", "updated_at" ] }, { "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", "format": "int64", "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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" }, "notification_setting": { "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" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [ 37 ] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ 42 ] }, "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" ] }, "notification_setting": { "description": "The notification setting the team has set", "type": "string", "examples": [ "notifications_enabled" ] }, "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" ] }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [ 37 ] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ 42 ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "type" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent", "type" ] } }, "head": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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 repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" ] }, { "title": "Draft Issue", "description": "A draft issue in a project", "type": "object", "properties": { "id": { "type": "number", "description": "The ID of the draft issue" }, "node_id": { "type": "string", "description": "The node ID of the draft issue" }, "title": { "type": "string", "description": "The title of the draft issue" }, "body": { "type": [ "string", "null" ], "description": "The body content of the draft issue" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time the draft issue was created" }, "updated_at": { "type": "string", "format": "date-time", "description": "The time the draft issue was last updated" } }, "required": [ "id", "node_id", "title", "user", "created_at", "updated_at" ] } ], "description": "The content represented by the item." }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "project_url": { "type": "string", "format": "uri", "description": "The URL of the project this item belongs to." }, "item_url": { "type": "string", "format": "uri", "description": "The URL of the item in the project." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` #### Add a pull request using its unique ID **Request:** ```curl curl -L \ -X POST \ https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "type": "PullRequest", "id": 3 }' ``` **Response schema:** ```json Status: 201 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "content": { "oneOf": [ { "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", "format": "int64" }, "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", "duplicate", 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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" }, "type": { "title": "Issue Type", "description": "The type of issue.", "type": [ "object", "null" ], "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue type." }, "node_id": { "type": "string", "description": "The node identifier of the issue type." }, "name": { "type": "string", "description": "The name of the issue type." }, "description": { "type": [ "string", "null" ], "description": "The description of the issue type." }, "color": { "type": [ "string", "null" ], "description": "The color of the issue type.", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, "created_at": { "type": "string", "description": "The time the issue type created.", "format": "date-time" }, "updated_at": { "type": "string", "description": "The time the issue type last updated.", "format": "date-time" }, "is_enabled": { "type": "boolean", "description": "The enabled state of the issue type." } }, "required": [ "id", "node_id", "name", "description" ] }, "repository": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "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", "null" ], "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==" ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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 on GitHub.", "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" ] } ] }, "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. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "type": "integer", "examples": [ 5 ] } }, "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" ] }, "sub_issues_summary": { "title": "Sub-issues Summary", "type": "object", "properties": { "total": { "type": "integer" }, "completed": { "type": "integer" }, "percent_completed": { "type": "integer" } }, "required": [ "total", "completed", "percent_completed" ] }, "parent_issue_url": { "description": "URL to get the parent issue of this issue, if it is a sub-issue", "type": [ "string", "null" ], "format": "uri" }, "issue_dependencies_summary": { "title": "Issue Dependencies Summary", "type": "object", "properties": { "blocked_by": { "type": "integer" }, "blocking": { "type": "integer" }, "total_blocked_by": { "type": "integer" }, "total_blocking": { "type": "integer" } }, "required": [ "blocked_by", "blocking", "total_blocked_by", "total_blocking" ] }, "issue_field_values": { "type": "array", "items": { "title": "Issue Field Value", "description": "A value assigned to an issue field", "type": "object", "properties": { "issue_field_id": { "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "IFT_GDKND" ] }, "data_type": { "description": "The data type of the issue field", "type": "string", "enum": [ "text", "single_select", "number", "date" ], "examples": [ "text" ] }, "value": { "description": "The value of the issue field", "anyOf": [ { "type": "string", "examples": [ "Sample text" ] }, { "type": "number", "examples": [ 42.5 ] }, { "type": "integer", "examples": [ 1 ] } ], "type": [ "null", "string", "number", "integer" ] }, "single_select_option": { "description": "Details about the selected option (only present for single_select fields)", "type": [ "object", "null" ], "properties": { "id": { "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "examples": [ 1 ] }, "name": { "description": "The name of the option", "type": "string", "examples": [ "High" ] }, "color": { "description": "The color of the option", "type": "string", "examples": [ "red" ] } }, "required": [ "id", "name", "color" ] } }, "required": [ "issue_field_id", "node_id", "data_type", "value" ] } } }, "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", "created_at", "updated_at" ] }, { "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", "format": "int64", "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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" }, "notification_setting": { "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" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [ 37 ] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ 42 ] }, "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" ] }, "notification_setting": { "description": "The notification setting the team has set", "type": "string", "examples": [ "notifications_enabled" ] }, "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" ] }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [ 37 ] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ 42 ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "type" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent", "type" ] } }, "head": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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 repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" ] }, { "title": "Draft Issue", "description": "A draft issue in a project", "type": "object", "properties": { "id": { "type": "number", "description": "The ID of the draft issue" }, "node_id": { "type": "string", "description": "The node ID of the draft issue" }, "title": { "type": "string", "description": "The title of the draft issue" }, "body": { "type": [ "string", "null" ], "description": "The body content of the draft issue" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time the draft issue was created" }, "updated_at": { "type": "string", "format": "date-time", "description": "The time the draft issue was last updated" } }, "required": [ "id", "node_id", "title", "user", "created_at", "updated_at" ] } ], "description": "The content represented by the item." }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "project_url": { "type": "string", "format": "uri", "description": "The URL of the project this item belongs to." }, "item_url": { "type": "string", "format": "uri", "description": "The URL of the item in the project." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` #### Add an issue using repository owner, name, and issue number **Request:** ```curl curl -L \ -X POST \ https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "type": "Issue", "owner": "octocat", "repo": "hello-world", "number": 42 }' ``` **Response schema:** ```json Status: 201 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "content": { "oneOf": [ { "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", "format": "int64" }, "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", "duplicate", 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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" }, "type": { "title": "Issue Type", "description": "The type of issue.", "type": [ "object", "null" ], "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue type." }, "node_id": { "type": "string", "description": "The node identifier of the issue type." }, "name": { "type": "string", "description": "The name of the issue type." }, "description": { "type": [ "string", "null" ], "description": "The description of the issue type." }, "color": { "type": [ "string", "null" ], "description": "The color of the issue type.", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, "created_at": { "type": "string", "description": "The time the issue type created.", "format": "date-time" }, "updated_at": { "type": "string", "description": "The time the issue type last updated.", "format": "date-time" }, "is_enabled": { "type": "boolean", "description": "The enabled state of the issue type." } }, "required": [ "id", "node_id", "name", "description" ] }, "repository": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "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", "null" ], "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==" ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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 on GitHub.", "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" ] } ] }, "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. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "type": "integer", "examples": [ 5 ] } }, "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" ] }, "sub_issues_summary": { "title": "Sub-issues Summary", "type": "object", "properties": { "total": { "type": "integer" }, "completed": { "type": "integer" }, "percent_completed": { "type": "integer" } }, "required": [ "total", "completed", "percent_completed" ] }, "parent_issue_url": { "description": "URL to get the parent issue of this issue, if it is a sub-issue", "type": [ "string", "null" ], "format": "uri" }, "issue_dependencies_summary": { "title": "Issue Dependencies Summary", "type": "object", "properties": { "blocked_by": { "type": "integer" }, "blocking": { "type": "integer" }, "total_blocked_by": { "type": "integer" }, "total_blocking": { "type": "integer" } }, "required": [ "blocked_by", "blocking", "total_blocked_by", "total_blocking" ] }, "issue_field_values": { "type": "array", "items": { "title": "Issue Field Value", "description": "A value assigned to an issue field", "type": "object", "properties": { "issue_field_id": { "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "IFT_GDKND" ] }, "data_type": { "description": "The data type of the issue field", "type": "string", "enum": [ "text", "single_select", "number", "date" ], "examples": [ "text" ] }, "value": { "description": "The value of the issue field", "anyOf": [ { "type": "string", "examples": [ "Sample text" ] }, { "type": "number", "examples": [ 42.5 ] }, { "type": "integer", "examples": [ 1 ] } ], "type": [ "null", "string", "number", "integer" ] }, "single_select_option": { "description": "Details about the selected option (only present for single_select fields)", "type": [ "object", "null" ], "properties": { "id": { "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "examples": [ 1 ] }, "name": { "description": "The name of the option", "type": "string", "examples": [ "High" ] }, "color": { "description": "The color of the option", "type": "string", "examples": [ "red" ] } }, "required": [ "id", "name", "color" ] } }, "required": [ "issue_field_id", "node_id", "data_type", "value" ] } } }, "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", "created_at", "updated_at" ] }, { "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", "format": "int64", "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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" }, "notification_setting": { "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" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [ 37 ] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ 42 ] }, "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" ] }, "notification_setting": { "description": "The notification setting the team has set", "type": "string", "examples": [ "notifications_enabled" ] }, "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" ] }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [ 37 ] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ 42 ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "type" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent", "type" ] } }, "head": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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 repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" ] }, { "title": "Draft Issue", "description": "A draft issue in a project", "type": "object", "properties": { "id": { "type": "number", "description": "The ID of the draft issue" }, "node_id": { "type": "string", "description": "The node ID of the draft issue" }, "title": { "type": "string", "description": "The title of the draft issue" }, "body": { "type": [ "string", "null" ], "description": "The body content of the draft issue" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time the draft issue was created" }, "updated_at": { "type": "string", "format": "date-time", "description": "The time the draft issue was last updated" } }, "required": [ "id", "node_id", "title", "user", "created_at", "updated_at" ] } ], "description": "The content represented by the item." }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "project_url": { "type": "string", "format": "uri", "description": "The URL of the project this item belongs to." }, "item_url": { "type": "string", "format": "uri", "description": "The URL of the item in the project." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` #### Add a pull request using repository owner, name, and PR number **Request:** ```curl curl -L \ -X POST \ https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "type": "PullRequest", "owner": "octocat", "repo": "hello-world", "number": 123 }' ``` **Response schema:** ```json Status: 201 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "content": { "oneOf": [ { "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", "format": "int64" }, "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", "duplicate", 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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" }, "type": { "title": "Issue Type", "description": "The type of issue.", "type": [ "object", "null" ], "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue type." }, "node_id": { "type": "string", "description": "The node identifier of the issue type." }, "name": { "type": "string", "description": "The name of the issue type." }, "description": { "type": [ "string", "null" ], "description": "The description of the issue type." }, "color": { "type": [ "string", "null" ], "description": "The color of the issue type.", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, "created_at": { "type": "string", "description": "The time the issue type created.", "format": "date-time" }, "updated_at": { "type": "string", "description": "The time the issue type last updated.", "format": "date-time" }, "is_enabled": { "type": "boolean", "description": "The enabled state of the issue type." } }, "required": [ "id", "node_id", "name", "description" ] }, "repository": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "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", "null" ], "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==" ] }, "client_id": { "type": "string", "examples": [ "\"Iv1.25b5d1e65ffc4022\"" ] }, "owner": { "oneOf": [ { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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 on GitHub.", "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" ] } ] }, "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. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "type": "array", "items": { "type": "string" }, "examples": [ "label", "deployment" ] }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "type": "integer", "examples": [ 5 ] } }, "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" ] }, "sub_issues_summary": { "title": "Sub-issues Summary", "type": "object", "properties": { "total": { "type": "integer" }, "completed": { "type": "integer" }, "percent_completed": { "type": "integer" } }, "required": [ "total", "completed", "percent_completed" ] }, "parent_issue_url": { "description": "URL to get the parent issue of this issue, if it is a sub-issue", "type": [ "string", "null" ], "format": "uri" }, "issue_dependencies_summary": { "title": "Issue Dependencies Summary", "type": "object", "properties": { "blocked_by": { "type": "integer" }, "blocking": { "type": "integer" }, "total_blocked_by": { "type": "integer" }, "total_blocking": { "type": "integer" } }, "required": [ "blocked_by", "blocking", "total_blocked_by", "total_blocking" ] }, "issue_field_values": { "type": "array", "items": { "title": "Issue Field Value", "description": "A value assigned to an issue field", "type": "object", "properties": { "issue_field_id": { "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "IFT_GDKND" ] }, "data_type": { "description": "The data type of the issue field", "type": "string", "enum": [ "text", "single_select", "number", "date" ], "examples": [ "text" ] }, "value": { "description": "The value of the issue field", "anyOf": [ { "type": "string", "examples": [ "Sample text" ] }, { "type": "number", "examples": [ 42.5 ] }, { "type": "integer", "examples": [ 1 ] } ], "type": [ "null", "string", "number", "integer" ] }, "single_select_option": { "description": "Details about the selected option (only present for single_select fields)", "type": [ "object", "null" ], "properties": { "id": { "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "examples": [ 1 ] }, "name": { "description": "The name of the option", "type": "string", "examples": [ "High" ] }, "color": { "description": "The color of the option", "type": "string", "examples": [ "red" ] } }, "required": [ "id", "name", "color" ] } }, "required": [ "issue_field_id", "node_id", "data_type", "value" ] } } }, "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", "created_at", "updated_at" ] }, { "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", "format": "int64", "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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" }, "notification_setting": { "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" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [ 37 ] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ 42 ] }, "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" ] }, "notification_setting": { "description": "The notification setting the team has set", "type": "string", "examples": [ "notifications_enabled" ] }, "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" ] }, "type": { "description": "The ownership type of the team", "type": "string", "enum": [ "enterprise", "organization" ] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [ 37 ] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [ 42 ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "type" ] } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent", "type" ] } }, "head": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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 repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "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" ] }, "owner": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": { "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", "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", "deprecated": true, "examples": [ true ] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "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 ] }, "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 is closing down. 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" }, "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" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "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" ] }, "sha": { "type": "string" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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" ] }, { "title": "Draft Issue", "description": "A draft issue in a project", "type": "object", "properties": { "id": { "type": "number", "description": "The ID of the draft issue" }, "node_id": { "type": "string", "description": "The node ID of the draft issue" }, "title": { "type": "string", "description": "The title of the draft issue" }, "body": { "type": [ "string", "null" ], "description": "The body content of the draft issue" }, "user": { "anyOf": [ { "type": "null" }, { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time the draft issue was created" }, "updated_at": { "type": "string", "format": "date-time", "description": "The time the draft issue was last updated" } }, "required": [ "id", "node_id", "title", "user", "created_at", "updated_at" ] } ], "description": "The content represented by the item." }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "project_url": { "type": "string", "format": "uri", "description": "The URL of the project this item belongs to." }, "item_url": { "type": "string", "format": "uri", "description": "The URL of the item in the project." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` ## Get an item for a user owned project ``` GET /users/{username}/projectsV2/{project_number}/items/{item_id} ``` Get a specific item from a user-owned project. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`project_number`** (integer) (required) The project's number. * **`username`** (string) (required) The handle for the GitHub user account. * **`item_id`** (integer) (required) The unique identifier of the project item. * **`fields`** (string) Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: fields\[]=123\&fields\[]=456\&fields\[]=789 or fields=123,456,789 ### HTTP response status codes * **200** - OK * **304** - Not modified * **401** - Requires authentication * **403** - Forbidden ### Code examples #### Example **Request:** ```curl curl -L \ -X GET \ https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items/ITEM_ID \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" ``` **Response schema:** ```json Status: 200 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", "description": "The API URL of the project that contains this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "content": { "type": [ "object", "null" ], "additionalProperties": true, "description": "The content of the item, which varies by content type." }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "item_url": { "type": [ "string", "null" ], "format": "uri", "description": "The API URL of this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "The fields and values associated with this item." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` ## Update project item for user ``` PATCH /users/{username}/projectsV2/{project_number}/items/{item_id} ``` Update a specific item in a user-owned project. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`project_number`** (integer) (required) The project's number. * **`username`** (string) (required) The handle for the GitHub user account. * **`item_id`** (integer) (required) The unique identifier of the project item. #### Body parameters * **`fields`** (array of objects) (required) A list of field updates to apply. * **`id`** (integer) (required) The ID of the project field to update. * **`value`** (null or string or number) (required) The new value for the field: For text, number, and date fields, provide the new value directly. For single select and iteration fields, provide the ID of the option or iteration. To clear the field, set this to null. ### HTTP response status codes * **200** - OK * **401** - Requires authentication * **403** - Forbidden * **404** - Resource not found * **422** - Validation failed, or the endpoint has been spammed. ### Code examples #### Update a text field **Request:** ```curl curl -L \ -X PATCH \ https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items/ITEM_ID \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "fields": [ { "id": 123, "value": "Updated text value" } ] }' ``` **Response schema:** ```json Status: 200 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", "description": "The API URL of the project that contains this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "content": { "type": [ "object", "null" ], "additionalProperties": true, "description": "The content of the item, which varies by content type." }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "item_url": { "type": [ "string", "null" ], "format": "uri", "description": "The API URL of this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "The fields and values associated with this item." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` #### Update a number field **Request:** ```curl curl -L \ -X PATCH \ https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items/ITEM_ID \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "fields": [ { "id": 456, "value": 42.5 } ] }' ``` **Response schema:** ```json Status: 200 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", "description": "The API URL of the project that contains this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "content": { "type": [ "object", "null" ], "additionalProperties": true, "description": "The content of the item, which varies by content type." }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "item_url": { "type": [ "string", "null" ], "format": "uri", "description": "The API URL of this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "The fields and values associated with this item." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` #### Update a date field **Request:** ```curl curl -L \ -X PATCH \ https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items/ITEM_ID \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "fields": [ { "id": 789, "value": "2023-10-05" } ] }' ``` **Response schema:** ```json Status: 200 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", "description": "The API URL of the project that contains this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "content": { "type": [ "object", "null" ], "additionalProperties": true, "description": "The content of the item, which varies by content type." }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "item_url": { "type": [ "string", "null" ], "format": "uri", "description": "The API URL of this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "The fields and values associated with this item." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` #### Update a single select field **Request:** ```curl curl -L \ -X PATCH \ https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items/ITEM_ID \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "fields": [ { "id": 789, "value": "47fc9ee4" } ] }' ``` **Response schema:** ```json Status: 200 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", "description": "The API URL of the project that contains this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "content": { "type": [ "object", "null" ], "additionalProperties": true, "description": "The content of the item, which varies by content type." }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "item_url": { "type": [ "string", "null" ], "format": "uri", "description": "The API URL of this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "The fields and values associated with this item." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` #### Update an iteration field **Request:** ```curl curl -L \ -X PATCH \ https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items/ITEM_ID \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" \ -d '{ "fields": [ { "id": 1011, "value": "866ee5b8" } ] }' ``` **Response schema:** ```json Status: 200 { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", "description": "The API URL of the project that contains this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "content": { "type": [ "object", "null" ], "additionalProperties": true, "description": "The content of the item, which varies by content type." }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "item_url": { "type": [ "string", "null" ], "format": "uri", "description": "The API URL of this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "The fields and values associated with this item." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } ``` ## Delete project item for user ``` DELETE /users/{username}/projectsV2/{project_number}/items/{item_id} ``` Delete a specific item from a user-owned project. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`project_number`** (integer) (required) The project's number. * **`username`** (string) (required) The handle for the GitHub user account. * **`item_id`** (integer) (required) The unique identifier of the project item. ### HTTP response status codes * **204** - No Content * **401** - Requires authentication * **403** - Forbidden ### Code examples #### Example **Request:** ```curl curl -L \ -X DELETE \ https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/items/ITEM_ID \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" ``` **Response schema:** ``` Status: 204 ``` ## List items for a user project view ``` GET /users/{username}/projectsV2/{project_number}/views/{view_number}/items ``` List items in a user project with the saved view's filter applied. ### Parameters #### Headers * **`accept`** (string) Setting to `application/vnd.github+json` is recommended. #### Path and query parameters * **`project_number`** (integer) (required) The project's number. * **`username`** (string) (required) The handle for the GitHub user account. * **`view_number`** (integer) (required) The number that identifies the project view. * **`fields`** (string) Limit results to specific fields, by their IDs. If not specified, the title field will be returned. Example: fields\[]=123\&fields\[]=456\&fields\[]=789 or fields=123,456,789 * **`before`** (string) A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API." * **`after`** (string) A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API." * **`per_page`** (integer) The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: `30` ### HTTP response status codes * **200** - OK * **304** - Not modified * **401** - Requires authentication * **403** - Forbidden * **404** - Resource not found ### Code examples #### Example **Request:** ```curl curl -L \ -X GET \ https://api.github.com/users/USERNAME/projectsV2/PROJECT_NUMBER/views/VIEW_NUMBER/items \ -H "Accept: application/vnd.github.v3+json" \ -H "Authorization: Bearer " \ -H "X-GitHub-Api-Version: 2022-11-28" ``` **Response schema:** ```json Status: 200 { "type": "array", "items": { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "project_url": { "type": "string", "format": "uri", "description": "The API URL of the project that contains this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/3" ] }, "content_type": { "title": "Projects v2 Item Content Type", "description": "The type of content tracked in a project item", "type": "string", "enum": [ "Issue", "PullRequest", "DraftIssue" ] }, "content": { "type": [ "object", "null" ], "additionalProperties": true, "description": "The content of the item, which varies by content type." }, "creator": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "login": { "type": "string", "examples": [ "octocat" ] }, "id": { "type": "integer", "format": "int64", "examples": [ 1 ] }, "node_id": { "type": "string", "examples": [ "MDQ6VXNlcjE=" ] }, "avatar_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/images/error/octocat_happy.gif" ] }, "gravatar_id": { "type": [ "string", "null" ], "examples": [ "41d064eb2195891e12d0413f63227ea7" ] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat" ] }, "followers_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/followers" ] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/gists{/gist_id}" ] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/subscriptions" ] }, "organizations_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/orgs" ] }, "repos_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/repos" ] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/users/octocat/received_events" ] }, "type": { "type": "string", "examples": [ "User" ] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": [ "\"2020-07-09T00:17:55Z\"" ] }, "user_view_type": { "type": "string", "examples": [ "public" ] } }, "required": [ "avatar_url", "events_url", "followers_url", "following_url", "gists_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", "description": "The time when the item was created.", "examples": [ "2022-04-28T12:00:00Z" ] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": [ "2022-04-28T12:00:00Z" ] }, "archived_at": { "type": [ "string", "null" ], "format": "date-time", "description": "The time when the item was archived.", "examples": [ "2022-04-28T12:00:00Z" ] }, "item_url": { "type": [ "string", "null" ], "format": "uri", "description": "The API URL of this item.", "examples": [ "https://api.github.com/users/monalisa/2/projectsV2/items/3" ] }, "fields": { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "The fields and values associated with this item." } }, "required": [ "id", "content_type", "created_at", "updated_at", "archived_at" ] } } ```