openapi: 3.0.0
info:
version: 2015-07-09
x-release: v4
title: APIs.io Engineering Platform Amazon API Gateway 2014 11 13 Issues API
description:
Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: apigateway x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/apigateway-2015-07-09.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: https://apigateway.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon API Gateway multi-region endpoint - url: http://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) - url: https://apigateway.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon API Gateway endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: Issues description: Interact with GitHub Issues. paths: /issues: get: summary: APIs.io Engineering Platform List issues assigned to the authenticated user description: 'List issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not necessarily assigned to you. **Note**: GitHub''s REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.' tags: - Issues operationId: issues/list externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/issues#list-issues-assigned-to-the-authenticated-user parameters: - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. in: query required: false schema: type: string enum: - assigned - created - mentioned - subscribed - repos - all default: assigned - name: state description: Indicates the state of the issues to return. in: query required: false schema: type: string enum: - open - closed - all default: open - $ref: '#/components/parameters/labels' - name: sort description: What to sort results by. in: query required: false schema: type: string enum: - created - updated - comments default: created - $ref: '#/components/parameters/direction' - $ref: '#/components/parameters/since' - name: collab in: query required: false schema: type: boolean - name: orgs in: query required: false schema: type: boolean - name: owned in: query required: false schema: type: boolean - name: pulls in: query required: false schema: type: boolean - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/issue' examples: default: $ref: '#/components/examples/issue-with-repo-items' headers: Link: $ref: '#/components/headers/link' '422': $ref: '#/components/responses/validation_failed' '304': $ref: '#/components/responses/not_modified' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: issues subcategory: issues /orgs/{org}/issues: get: summary: APIs.io Engineering Platform List organization issues assigned to the authenticated user description: 'List issues in an organization assigned to the authenticated user. **Note**: GitHub''s REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.' tags: - Issues operationId: issues/list-for-org externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - $ref: '#/components/parameters/org' - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. in: query required: false schema: type: string enum: - assigned - created - mentioned - subscribed - repos - all default: assigned - name: state description: Indicates the state of the issues to return. in: query required: false schema: type: string enum: - open - closed - all default: open - $ref: '#/components/parameters/labels' - name: sort description: What to sort results by. in: query required: false schema: type: string enum: - created - updated - comments default: created - $ref: '#/components/parameters/direction' - $ref: '#/components/parameters/since' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/issue' examples: default: $ref: '#/components/examples/issue-with-repo-items' headers: Link: $ref: '#/components/headers/link' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: issues subcategory: issues /repos/{owner}/{repo}/assignees: get: summary: APIs.io Engineering Platform List assignees description: Lists the [available assignees](https://docs.github.com/enterprise-server@3.9/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository. tags: - Issues operationId: issues/list-assignees externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/assignees#list-assignees parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/simple-user' examples: default: $ref: '#/components/examples/simple-user-items' headers: Link: $ref: '#/components/headers/link' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: assignees /repos/{owner}/{repo}/assignees/{assignee}: get: summary: APIs.io Engineering Platform Check if a user can be assigned description: 'Checks if a user has permission to be assigned to an issue in this repository. If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. Otherwise a `404` status code is returned.' tags: - Issues operationId: issues/check-user-can-be-assigned externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - name: assignee in: path required: true schema: type: string responses: '204': description: If the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned. '404': description: Otherwise a `404` status code is returned. content: application/json: schema: $ref: '#/components/schemas/basic-error' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: assignees /repos/{owner}/{repo}/issues: get: summary: APIs.io Engineering Platform List repository issues description: 'List issues in a repository. Only open issues will be listed. **Note**: GitHub''s REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.' tags: - Issues operationId: issues/list-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/issues#list-repository-issues parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - name: milestone description: If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned. in: query required: false schema: type: string - name: state description: Indicates the state of the issues to return. in: query required: false schema: type: string enum: - open - closed - all default: open - name: assignee description: Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user. in: query required: false schema: type: string - name: creator description: The user that created the issue. in: query required: false schema: type: string - name: mentioned description: A user that's mentioned in the issue. in: query required: false schema: type: string - $ref: '#/components/parameters/labels' - name: sort description: What to sort results by. in: query required: false schema: type: string enum: - created - updated - comments default: created - $ref: '#/components/parameters/direction' - $ref: '#/components/parameters/since' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/issue' examples: default: $ref: '#/components/examples/issue-items' headers: Link: $ref: '#/components/headers/link' '301': $ref: '#/components/responses/moved_permanently' '422': $ref: '#/components/responses/validation_failed' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: issues post: summary: APIs.io Engineering Platform Create an issue description: 'Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://docs.github.com/enterprise-server@3.9/articles/disabling-issues/), the API returns a `410 Gone` status. This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.' tags: - Issues operationId: issues/create externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/issues#create-an-issue parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' requestBody: required: true content: application/json: schema: type: object properties: title: oneOf: - type: string - type: integer description: The title of the issue. body: type: string description: The contents of the issue. assignee: type: string description: 'Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_' nullable: true milestone: oneOf: - type: string - type: integer description: 'The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._' nullable: true labels: type: array description: 'Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._' items: oneOf: - type: string - type: object properties: id: type: integer name: type: string description: type: string nullable: true color: type: string nullable: true assignees: type: array description: 'Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._' items: type: string required: - title examples: default: value: title: Found a bug body: I'm having a problem with this. assignees: - octocat milestone: 1 labels: - bug responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/issue' examples: default: $ref: '#/components/examples/issue' headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1347 schema: type: string '400': $ref: '#/components/responses/bad_request' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/validation_failed' '503': $ref: '#/components/responses/service_unavailable' '404': $ref: '#/components/responses/not_found' '410': $ref: '#/components/responses/gone' x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: issues /repos/{owner}/{repo}/issues/comments: get: summary: APIs.io Engineering Platform List issue comments for a repository description: 'You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. By default, issue comments are ordered by ascending ID. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.' tags: - Issues operationId: issues/list-comments-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/comments#list-issue-comments-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/sort' - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query required: false schema: type: string enum: - asc - desc - $ref: '#/components/parameters/since' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/issue-comment' examples: default: $ref: '#/components/examples/issue-comment-items' headers: Link: $ref: '#/components/headers/link' '422': $ref: '#/components/responses/validation_failed' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: comments /repos/{owner}/{repo}/issues/comments/{comment_id}: get: summary: APIs.io Engineering Platform Get an issue comment description: 'You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.' tags: - Issues operationId: issues/get-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/comment-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/issue-comment' examples: default: $ref: '#/components/examples/issue-comment' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: comments patch: summary: APIs.io Engineering Platform Update an issue comment description: 'You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.' tags: - Issues operationId: issues/update-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/comments#update-an-issue-comment parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/comment-id' requestBody: required: true content: application/json: schema: type: object properties: body: type: string description: The contents of the comment. required: - body examples: default: value: body: Me too responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/issue-comment' examples: default: $ref: '#/components/examples/issue-comment' '422': $ref: '#/components/responses/validation_failed' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: comments delete: summary: APIs.io Engineering Platform Delete an issue comment description: You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. tags: - Issues operationId: issues/delete-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/comments#delete-an-issue-comment parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/comment-id' responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: comments /repos/{owner}/{repo}/issues/events: get: summary: APIs.io Engineering Platform List issue events for a repository description: Lists events for a repository. tags: - Issues operationId: issues/list-events-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/events#list-issue-events-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/issue-event' examples: default: $ref: '#/components/examples/issue-event-items' headers: Link: $ref: '#/components/headers/link' '422': $ref: '#/components/responses/validation_failed' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: events /repos/{owner}/{repo}/issues/events/{event_id}: get: summary: APIs.io Engineering Platform Get an issue event description: Gets a single event by the event id. tags: - Issues operationId: issues/get-event externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/events#get-an-issue-event parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - name: event_id in: path required: true schema: type: integer responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/issue-event' examples: default: $ref: '#/components/examples/issue-event' '404': $ref: '#/components/responses/not_found' '410': $ref: '#/components/responses/gone' '403': $ref: '#/components/responses/forbidden' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: events /repos/{owner}/{repo}/issues/{issue_number}: get: summary: APIs.io Engineering Platform Get an issue description: 'The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was [transferred](https://docs.github.com/enterprise-server@3.9/articles/transferring-an-issue-to-another-repository/) to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe to the [`issues`](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#issues) webhook. **Note**: GitHub''s REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.' tags: - Issues operationId: issues/get externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/issue-number' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/issue' examples: default: $ref: '#/components/examples/issue' '301': $ref: '#/components/responses/moved_permanently' '404': $ref: '#/components/responses/not_found' '410': $ref: '#/components/responses/gone' '304': $ref: '#/components/responses/not_modified' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: issues patch: summary: APIs.io Engineering Platform Update an issue description: 'Issue owners and users with push access can edit an issue. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.' tags: - Issues operationId: issues/update externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/issues#update-an-issue parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/issue-number' requestBody: required: false content: application/json: schema: type: object properties: title: oneOf: - type: string - type: integer description: The title of the issue. nullable: true body: type: string description: The contents of the issue. nullable: true assignee: type: string nullable: true description: Username to assign to this issue. **This field is deprecated.** state: type: string description: The open or closed state of the issue. enum: - open - closed state_reason: type: string enum: - completed - not_planned - reopened nullable: true description: The reason for the state change. Ignored unless `state` is changed. example: not_planned milestone: oneOf: - type: string - type: integer description: The `number` of the milestone to associate this issue with or use `null` to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped. nullable: true labels: type: array description: Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped. items: oneOf: - type: string - type: object properties: id: type: integer name: type: string description: type: string nullable: true color: type: string nullable: true assignees: type: array description: Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped. items: type: string examples: default: value: title: Found a bug body: I'm having a problem with this. assignees: - octocat milestone: 1 state: open labels: - bug responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/issue' examples: default: $ref: '#/components/examples/issue' '422': $ref: '#/components/responses/validation_failed' '503': $ref: '#/components/responses/service_unavailable' '403': $ref: '#/components/responses/forbidden' '301': $ref: '#/components/responses/moved_permanently' '404': $ref: '#/components/responses/not_found' '410': $ref: '#/components/responses/gone' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: issues /repos/{owner}/{repo}/issues/{issue_number}/assignees: post: summary: APIs.io Engineering Platform Add assignees to an issue description: Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced. tags: - Issues operationId: issues/add-assignees externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/assignees#add-assignees-to-an-issue parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/issue-number' requestBody: required: false content: application/json: schema: type: object properties: assignees: type: array description: 'Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._' items: type: string examples: default: value: assignees: - hubot - other_user responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/issue' examples: default: $ref: '#/components/examples/issue' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: assignees delete: summary: APIs.io Engineering Platform Remove assignees from an issue description: Removes one or more assignees from an issue. tags: - Issues operationId: issues/remove-assignees externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/assignees#remove-assignees-from-an-issue parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/issue-number' requestBody: content: application/json: schema: type: object properties: assignees: type: array description: 'Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._' items: type: string examples: default: value: assignees: - hubot - other_user responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/issue' examples: default: $ref: '#/components/examples/issue' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: assignees /repos/{owner}/{repo}/issues/{issue_number}/assignees/{assignee}: get: summary: APIs.io Engineering Platform Check if a user can be assigned to a issue description: 'Checks if a user has permission to be assigned to a specific issue. If the `assignee` can be assigned to this issue, a `204` status code with no content is returned. Otherwise a `404` status code is returned.' tags: - Issues operationId: issues/check-user-can-be-assigned-to-issue externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/assignees#check-if-a-user-can-be-assigned-to-a-issue parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/issue-number' - name: assignee in: path required: true schema: type: string responses: '204': description: Response if `assignee` can be assigned to `issue_number` '404': description: Response if `assignee` can not be assigned to `issue_number` content: application/json: schema: $ref: '#/components/schemas/basic-error' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: assignees /repos/{owner}/{repo}/issues/{issue_number}/comments: get: summary: APIs.io Engineering Platform List issue comments description: 'You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. Issue comments are ordered by ascending ID. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.' tags: - Issues operationId: issues/list-comments externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/comments#list-issue-comments parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/issue-number' - $ref: '#/components/parameters/since' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/issue-comment' examples: default: $ref: '#/components/examples/issue-comment-items' headers: Link: $ref: '#/components/headers/link' '404': $ref: '#/components/responses/not_found' '410': $ref: '#/components/responses/gone' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: comments post: summary: APIs.io Engineering Platform Create an issue comment description: 'You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. This endpoint triggers [notifications](https://docs.github.com/enterprise-server@3.9/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.' tags: - Issues operationId: issues/create-comment externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/comments#create-an-issue-comment parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/issue-number' requestBody: required: true content: application/json: schema: type: object properties: body: type: string description: The contents of the comment. required: - body examples: default: value: body: Me too responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/issue-comment' examples: default: $ref: '#/components/examples/issue-comment' headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': $ref: '#/components/responses/forbidden' '410': $ref: '#/components/responses/gone' '422': $ref: '#/components/responses/validation_failed' '404': $ref: '#/components/responses/not_found' x-github: triggersNotification: true githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: comments /repos/{owner}/{repo}/issues/{issue_number}/events: get: summary: APIs.io Engineering Platform List issue events description: Lists all events for an issue. tags: - Issues operationId: issues/list-events externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/events#list-issue-events parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/issue-number' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/issue-event-for-issue' examples: default: $ref: '#/components/examples/issue-event-for-issue-items' headers: Link: $ref: '#/components/headers/link' '410': $ref: '#/components/responses/gone' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: events /repos/{owner}/{repo}/issues/{issue_number}/labels: get: summary: APIs.io Engineering Platform List labels for an issue description: Lists all labels for an issue. tags: - Issues operationId: issues/list-labels-on-issue externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/labels#list-labels-for-an-issue parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/issue-number' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/label' examples: default: $ref: '#/components/examples/label-items' headers: Link: $ref: '#/components/headers/link' '301': $ref: '#/components/responses/moved_permanently' '404': $ref: '#/components/responses/not_found' '410': $ref: '#/components/responses/gone' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels post: summary: APIs.io Engineering Platform Add labels to an issue description: 'Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue. ' tags: - Issues operationId: issues/add-labels externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/labels#add-labels-to-an-issue parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/issue-number' requestBody: required: false content: application/json: schema: oneOf: - type: object properties: labels: type: array minItems: 1 description: The names of the labels to add to the issue's existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also replace all of the labels for an issue. For more information, see "[Set labels for an issue](https://docs.github.com/enterprise-server@3.9/rest/issues/labels#set-labels-for-an-issue)." items: type: string - type: array minItems: 1 items: type: string - type: object properties: labels: type: array minItems: 1 items: type: object properties: name: type: string required: - name - type: array minItems: 1 items: type: object properties: name: type: string required: - name - type: string examples: default: value: labels: - bug - enhancement responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/label' examples: default: $ref: '#/components/examples/label-items' '301': $ref: '#/components/responses/moved_permanently' '404': $ref: '#/components/responses/not_found' '410': $ref: '#/components/responses/gone' '422': $ref: '#/components/responses/validation_failed' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels put: summary: APIs.io Engineering Platform Set labels for an issue description: Removes any previous labels and sets the new labels for an issue. tags: - Issues operationId: issues/set-labels externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/labels#set-labels-for-an-issue parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/issue-number' requestBody: required: false content: application/json: schema: oneOf: - type: object properties: labels: type: array minItems: 1 description: The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. You can also add labels to the existing labels for an issue. For more information, see "[Add labels to an issue](https://docs.github.com/enterprise-server@3.9/rest/issues/labels#add-labels-to-an-issue)." items: type: string - type: array minItems: 1 items: type: string - type: object properties: labels: type: array minItems: 1 items: type: object properties: name: type: string required: - name - type: array minItems: 1 items: type: object properties: name: type: string required: - name - type: string examples: default: value: labels: - bug - enhancement responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/label' examples: default: $ref: '#/components/examples/label-items' '301': $ref: '#/components/responses/moved_permanently' '404': $ref: '#/components/responses/not_found' '410': $ref: '#/components/responses/gone' '422': $ref: '#/components/responses/validation_failed' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels delete: summary: APIs.io Engineering Platform Remove all labels from an issue description: Removes all labels from an issue. tags: - Issues operationId: issues/remove-all-labels externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/labels#remove-all-labels-from-an-issue parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/issue-number' responses: '204': description: Response '301': $ref: '#/components/responses/moved_permanently' '404': $ref: '#/components/responses/not_found' '410': $ref: '#/components/responses/gone' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}: delete: summary: APIs.io Engineering Platform Remove a label from an issue description: Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. tags: - Issues operationId: issues/remove-label externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/labels#remove-a-label-from-an-issue parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/issue-number' - name: name in: path required: true schema: type: string responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/label' examples: default: $ref: '#/components/examples/label-items-2' '301': $ref: '#/components/responses/moved_permanently' '404': $ref: '#/components/responses/not_found' '410': $ref: '#/components/responses/gone' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels /repos/{owner}/{repo}/issues/{issue_number}/lock: put: summary: APIs.io Engineering Platform Lock an issue description: 'Users with push access can lock an issue or pull request''s conversation. Note that, if you choose not to pass any parameters, you''ll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)."' tags: - Issues operationId: issues/lock externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/issues#lock-an-issue parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/issue-number' requestBody: required: false content: application/json: schema: type: object nullable: true properties: lock_reason: type: string description: "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n * `off-topic` \n * `too heated` \n * `resolved` \n * `spam`" enum: - off-topic - too heated - resolved - spam examples: default: summary: Example of locking an issue as off-topic value: lock_reason: off-topic responses: '204': description: Response '403': $ref: '#/components/responses/forbidden' '410': $ref: '#/components/responses/gone' '404': $ref: '#/components/responses/not_found' '422': $ref: '#/components/responses/validation_failed' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: issues delete: summary: APIs.io Engineering Platform Unlock an issue description: Users with push access can unlock an issue's conversation. tags: - Issues operationId: issues/unlock externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/issues#unlock-an-issue parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/issue-number' responses: '204': description: Response '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: issues /repos/{owner}/{repo}/issues/{issue_number}/timeline: get: summary: APIs.io Engineering Platform List timeline events for an issue description: List all timeline events for an issue. tags: - Issues operationId: issues/list-events-for-timeline externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/issue-number' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/timeline-issue-events' examples: default: $ref: '#/components/examples/timeline-issue-events' headers: Link: $ref: '#/components/headers/link' '404': $ref: '#/components/responses/not_found' '410': $ref: '#/components/responses/gone' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: timeline /repos/{owner}/{repo}/labels: get: summary: APIs.io Engineering Platform List labels for a repository description: Lists all labels for a repository. tags: - Issues operationId: issues/list-labels-for-repo externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/labels#list-labels-for-a-repository parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/label' examples: default: $ref: '#/components/examples/label-items' headers: Link: $ref: '#/components/headers/link' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels post: summary: APIs.io Engineering Platform Create a label description: Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid [hexadecimal color code](http://www.color-hex.com/). tags: - Issues operationId: issues/create-label externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/labels#create-a-label parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji . For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." color: type: string description: The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. description: type: string description: A short description of the label. Must be 100 characters or fewer. required: - name examples: default: value: name: bug description: Something isn't working color: f29513 responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/label' examples: default: $ref: '#/components/examples/label' headers: Location: example: https://api.github.com/repos/octocat/Hello-World/labels/bug schema: type: string '422': $ref: '#/components/responses/validation_failed' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels /repos/{owner}/{repo}/labels/{name}: get: summary: APIs.io Engineering Platform Get a label description: Gets a label using the given name. tags: - Issues operationId: issues/get-label externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/labels#get-a-label parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - name: name in: path required: true schema: type: string responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/label' examples: default: $ref: '#/components/examples/label' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels patch: summary: APIs.io Engineering Platform Update a label description: Updates a label using the given label name. tags: - Issues operationId: issues/update-label externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/labels#update-a-label parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - name: name in: path required: true schema: type: string requestBody: required: false content: application/json: schema: type: object properties: new_name: type: string description: The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji . For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)." color: type: string description: The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. description: type: string description: A short description of the label. Must be 100 characters or fewer. examples: default: value: new_name: 'bug :bug:' description: Small bug fix required color: b01f26 responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/label' examples: default: $ref: '#/components/examples/label-2' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels delete: summary: APIs.io Engineering Platform Delete a label description: Deletes a label using the given label name. tags: - Issues operationId: issues/delete-label externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/labels#delete-a-label parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - name: name in: path required: true schema: type: string responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels /repos/{owner}/{repo}/milestones: get: summary: APIs.io Engineering Platform List milestones description: Lists milestones for a repository. tags: - Issues operationId: issues/list-milestones externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/milestones#list-milestones parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query required: false schema: type: string enum: - open - closed - all default: open - name: sort description: What to sort results by. Either `due_on` or `completeness`. in: query required: false schema: type: string enum: - due_on - completeness default: due_on - name: direction description: The direction of the sort. Either `asc` or `desc`. in: query required: false schema: type: string enum: - asc - desc default: asc - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/milestone' examples: default: $ref: '#/components/examples/milestone-items' headers: Link: $ref: '#/components/headers/link' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: milestones post: summary: APIs.io Engineering Platform Create a milestone description: Creates a milestone. tags: - Issues operationId: issues/create-milestone externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/milestones#create-a-milestone parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' requestBody: required: true content: application/json: schema: type: object properties: title: type: string description: The title of the milestone. state: type: string description: The state of the milestone. Either `open` or `closed`. enum: - open - closed default: open description: type: string description: A description of the milestone. due_on: type: string format: date-time description: 'The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' required: - title examples: default: value: title: v1.0 state: open description: Tracking milestone for version 1.0 due_on: '2012-10-09T23:39:01Z' responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/milestone' examples: default: $ref: '#/components/examples/milestone' headers: Location: example: https://api.github.com/repos/octocat/Hello-World/milestones/1 schema: type: string '404': $ref: '#/components/responses/not_found' '422': $ref: '#/components/responses/validation_failed' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: milestones /repos/{owner}/{repo}/milestones/{milestone_number}: get: summary: APIs.io Engineering Platform Get a milestone description: Gets a milestone using the given milestone number. tags: - Issues operationId: issues/get-milestone externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/milestones#get-a-milestone parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/milestone-number' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/milestone' examples: default: $ref: '#/components/examples/milestone' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: milestones patch: summary: APIs.io Engineering Platform Update a milestone description: '' tags: - Issues operationId: issues/update-milestone externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/milestones#update-a-milestone parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/milestone-number' requestBody: required: false content: application/json: schema: type: object properties: title: type: string description: The title of the milestone. state: type: string description: The state of the milestone. Either `open` or `closed`. enum: - open - closed default: open description: type: string description: A description of the milestone. due_on: type: string format: date-time description: 'The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' examples: default: value: title: v1.0 state: open description: Tracking milestone for version 1.0 due_on: '2012-10-09T23:39:01Z' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/milestone' examples: default: $ref: '#/components/examples/milestone' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: milestones delete: summary: APIs.io Engineering Platform Delete a milestone description: Deletes a milestone using the given milestone number. tags: - Issues operationId: issues/delete-milestone externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/milestones#delete-a-milestone parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/milestone-number' responses: '204': description: Response '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: milestones /repos/{owner}/{repo}/milestones/{milestone_number}/labels: get: summary: APIs.io Engineering Platform List labels for issues in a milestone description: Lists labels for issues in a milestone. tags: - Issues operationId: issues/list-labels-for-milestone externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/milestone-number' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/label' examples: default: $ref: '#/components/examples/label-items' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: issues subcategory: labels /user/issues: get: summary: APIs.io Engineering Platform List user account issues assigned to the authenticated user description: 'List issues across owned and member repositories assigned to the authenticated user. **Note**: GitHub''s REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." - **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type. - **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. - **`application/vnd.github.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`. - **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.' tags: - Issues operationId: issues/list-for-authenticated-user externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user parameters: - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. in: query required: false schema: type: string enum: - assigned - created - mentioned - subscribed - repos - all default: assigned - name: state description: Indicates the state of the issues to return. in: query required: false schema: type: string enum: - open - closed - all default: open - $ref: '#/components/parameters/labels' - name: sort description: What to sort results by. in: query required: false schema: type: string enum: - created - updated - comments default: created - $ref: '#/components/parameters/direction' - $ref: '#/components/parameters/since' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/issue' examples: default: $ref: '#/components/examples/issue-with-repo-items' headers: Link: $ref: '#/components/headers/link' '404': $ref: '#/components/responses/not_found' '304': $ref: '#/components/responses/not_modified' x-github: githubCloudOnly: false enabledForGitHubApps: false category: issues subcategory: issues components: schemas: nullable-simple-user: title: Simple User description: A GitHub user. type: object properties: name: nullable: true type: string email: nullable: true type: string login: type: string example: octocat id: type: integer format: int64 example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 nullable: true url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean starred_at: type: string example: '"2020-07-09T00:17:55Z"' required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url nullable: true integration: 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 nullable: true properties: id: description: Unique identifier of the GitHub app example: 37 type: integer slug: description: The slug name of the GitHub app example: probot-owners type: string node_id: type: string example: MDExOkludGVncmF0aW9uMQ== owner: $ref: '#/components/schemas/nullable-simple-user' name: description: The name of the GitHub app example: Probot Owners type: string description: type: string example: The description of the app. nullable: true external_url: type: string format: uri example: https://example.com html_url: type: string format: uri example: https://github.com/apps/super-ci created_at: type: string format: date-time example: '2017-07-08T16:18:44-04:00' updated_at: type: string format: date-time example: '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 example: - label - deployment type: array items: type: string installations_count: description: The number of installations associated with the GitHub app example: 5 type: integer client_id: type: string example: '"Iv1.25b5d1e65ffc4022"' client_secret: type: string example: '"1d4b2097ac622ba702d19de498f005747a8b21d3"' webhook_secret: type: string example: '"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"' nullable: true pem: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at - permissions - events repository: title: Repository description: A repository on GitHub. type: object properties: id: description: Unique identifier of the repository example: 42 type: integer format: int64 node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: description: The name of the repository. type: string example: Team Environment full_name: type: string example: octocat/Hello-World license: $ref: '#/components/schemas/nullable-license-simple' 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: $ref: '#/components/schemas/simple-user' private: description: Whether the repository is private or public. default: false type: boolean html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: type: string example: This your first repo! nullable: true fork: type: boolean url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World archive_url: type: string example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: type: string example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: type: string example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: type: string example: http://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: type: string example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: type: string example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/contributors deployments_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/deployments downloads_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/downloads events_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/events forks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/forks git_commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: type: string example: git:github.com/octocat/Hello-World.git issue_comment_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: type: string example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: type: string example: http://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/languages merges_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/merges milestones_url: type: string example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: type: string example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: type: string example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: type: string example: http://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: type: string example: git@github.com:octocat/Hello-World.git stargazers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: type: string example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscription tags_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/tags teams_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/teams trees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} clone_url: type: string example: https://github.com/octocat/Hello-World.git mirror_url: type: string format: uri example: git:git.example.com/octocat/Hello-World nullable: true hooks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/hooks svn_url: type: string format: uri example: https://svn.github.com/octocat/Hello-World homepage: type: string format: uri example: https://github.com nullable: true language: type: string nullable: true forks_count: type: integer example: 9 stargazers_count: type: integer example: 80 watchers_count: type: integer example: 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 example: 108 default_branch: description: The default branch of the repository. type: string example: master open_issues_count: type: integer example: 0 is_template: description: Whether this repository acts as a template that can be used to generate new repositories. default: false type: boolean example: true topics: type: array items: type: string has_issues: description: Whether issues are enabled. default: true type: boolean example: true has_projects: description: Whether projects are enabled. default: true type: boolean example: true has_wiki: description: Whether the wiki is enabled. default: true type: boolean example: true has_pages: type: boolean has_downloads: description: Whether downloads are enabled. default: true type: boolean example: true deprecated: true has_discussions: description: Whether discussions are enabled. default: false type: boolean example: 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 format: date-time example: '2011-01-26T19:06:43Z' nullable: true created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' nullable: true updated_at: type: string format: date-time example: '2011-01-26T19:14:43Z' nullable: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. default: true type: boolean example: true temp_clone_token: type: string allow_squash_merge: description: Whether to allow squash merges for pull requests. default: true type: boolean example: true allow_auto_merge: description: Whether to allow Auto-merge to be used on pull requests. default: false type: boolean example: false delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged default: false type: boolean example: 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 example: false use_squash_pr_title_as_default: type: boolean description: Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. default: false deprecated: true squash_merge_commit_title: type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE description: 'The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request''s title. - `COMMIT_OR_PR_TITLE` - default to the commit''s title (if only one commit) or the pull request''s title (when more than one commit).' squash_merge_commit_message: type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK description: 'The default value for a squash merge commit message: - `PR_BODY` - default to the pull request''s body. - `COMMIT_MESSAGES` - default to the branch''s commit messages. - `BLANK` - default to a blank commit message.' merge_commit_title: type: string enum: - PR_TITLE - MERGE_MESSAGE description: 'The default value for a merge commit title. - `PR_TITLE` - default to the pull request''s title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).' merge_commit_message: type: string enum: - PR_BODY - PR_TITLE - BLANK description: 'The default value for a merge commit message. - `PR_TITLE` - default to the pull request''s title. - `PR_BODY` - default to the pull request''s body. - `BLANK` - default to a blank commit message.' allow_merge_commit: description: Whether to allow merge commits for pull requests. default: true type: boolean example: 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 example: '"2020-07-09T00:17:42Z"' anonymous_access_enabled: type: boolean description: Whether anonymous git access is enabled for this repository required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url - clone_url - default_branch - forks - forks_count - git_url - has_downloads - has_issues - has_projects - has_wiki - has_pages - homepage - language - archived - disabled - mirror_url - open_issues - open_issues_count - license - pushed_at - size - ssh_url - stargazers_count - svn_url - watchers - watchers_count - created_at - updated_at nullable-milestone: title: Milestone description: A collection of related issues and pull requests. type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: type: string format: uri example: https://github.com/octocat/Hello-World/milestones/v1.0 labels_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels id: type: integer example: 1002604 node_id: type: string example: MDk6TWlsZXN0b25lMTAwMjYwNA== number: description: The number of the milestone. type: integer example: 42 state: description: The state of the milestone. example: open type: string enum: - open - closed default: open title: description: The title of the milestone. example: v1.0 type: string description: type: string example: Tracking milestone for version 1.0 nullable: true creator: $ref: '#/components/schemas/nullable-simple-user' open_issues: type: integer example: 4 closed_issues: type: integer example: 8 created_at: type: string format: date-time example: '2011-04-10T20:09:31Z' updated_at: type: string format: date-time example: '2014-03-03T18:58:10Z' closed_at: type: string format: date-time example: '2013-02-12T13:22:01Z' nullable: true due_on: type: string format: date-time example: '2012-10-09T23:39:01Z' nullable: true 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 nullable: true reaction-rollup: 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 milestone: title: Milestone description: A collection of related issues and pull requests. type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: type: string format: uri example: https://github.com/octocat/Hello-World/milestones/v1.0 labels_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels id: type: integer example: 1002604 node_id: type: string example: MDk6TWlsZXN0b25lMTAwMjYwNA== number: description: The number of the milestone. type: integer example: 42 state: description: The state of the milestone. example: open type: string enum: - open - closed default: open title: description: The title of the milestone. example: v1.0 type: string description: type: string example: Tracking milestone for version 1.0 nullable: true creator: $ref: '#/components/schemas/nullable-simple-user' open_issues: type: integer example: 4 closed_issues: type: integer example: 8 created_at: type: string format: date-time example: '2011-04-10T20:09:31Z' updated_at: type: string format: date-time example: '2014-03-03T18:58:10Z' closed_at: type: string format: date-time example: '2013-02-12T13:22:01Z' nullable: true due_on: type: string format: date-time example: '2012-10-09T23:39:01Z' nullable: true 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 team: title: Team description: Groups of organization members that gives permissions on specified repositories. type: object properties: id: type: integer node_id: type: string name: type: string slug: type: string description: type: string nullable: true privacy: type: string permission: type: string permissions: type: object properties: pull: type: boolean triage: type: boolean push: type: boolean maintain: type: boolean admin: type: boolean required: - pull - triage - push - maintain - admin url: type: string format: uri html_url: type: string format: uri example: https://github.com/orgs/rails/teams/core members_url: type: string repositories_url: type: string format: uri parent: $ref: '#/components/schemas/nullable-team-simple' required: - id - node_id - url - members_url - name - description - permission - html_url - repositories_url - slug - parent unlabeled-issue-event: title: Unlabeled Issue Event description: Unlabeled Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' label: type: object properties: name: type: string color: type: string required: - name - color required: - label - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app timeline-cross-referenced-event: title: Timeline Cross Referenced Event description: Timeline Cross Referenced Event type: object properties: event: type: string actor: $ref: '#/components/schemas/simple-user' created_at: type: string format: date-time updated_at: type: string format: date-time source: type: object properties: type: type: string issue: $ref: '#/components/schemas/issue' required: - event - created_at - updated_at - source added-to-project-issue-event: title: Added to Project Issue Event description: Added to Project Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' project_card: type: object properties: id: type: integer url: type: string format: uri project_id: type: integer project_url: type: string format: uri column_name: type: string previous_column_name: type: string required: - id - url - project_id - project_url - column_name required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app issue-event-label: title: Issue Event Label description: Issue Event Label type: object properties: name: type: string nullable: true color: type: string nullable: true required: - name - color converted-note-to-issue-issue-event: title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/integration' project_card: type: object properties: id: type: integer url: type: string format: uri project_id: type: integer project_url: type: string format: uri column_name: type: string previous_column_name: type: string required: - id - url - project_id - project_url - column_name required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app label: title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). type: object properties: id: type: integer format: int64 example: 208045946 node_id: type: string example: MDU6TGFiZWwyMDgwNDU5NDY= url: description: URL for the label example: https://api.github.com/repositories/42/labels/bug type: string format: uri name: description: The name of the label. example: bug type: string description: type: string example: Something isn't working nullable: true color: description: '6-character hex code, without the leading #, identifying the color' example: FFFFFF type: string default: type: boolean example: true required: - id - node_id - url - name - description - color - default issue-comment: title: Issue Comment description: Comments provide a way for people to collaborate on an issue. type: object properties: id: description: Unique identifier of the issue comment example: 42 type: integer format: int64 node_id: type: string url: description: URL for the issue comment example: https://api.github.com/repositories/42/issues/comments/1 type: string format: uri body: description: Contents of the issue comment example: What version of Safari were you using when you observed this bug? type: string body_text: type: string body_html: type: string html_url: type: string format: uri user: $ref: '#/components/schemas/nullable-simple-user' created_at: type: string format: date-time example: '2011-04-14T16:00:49Z' updated_at: type: string format: date-time example: '2011-04-14T16:00:49Z' issue_url: type: string format: uri author_association: $ref: '#/components/schemas/author-association' performed_via_github_app: $ref: '#/components/schemas/nullable-integration' reactions: $ref: '#/components/schemas/reaction-rollup' required: - id - node_id - html_url - issue_url - author_association - user - url - created_at - updated_at basic-error: title: Basic Error description: Basic Error type: object properties: message: type: string documentation_url: type: string url: type: string status: type: string labeled-issue-event: title: Labeled Issue Event description: Labeled Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' label: type: object properties: name: type: string color: type: string required: - name - color required: - label - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app timeline-comment-event: title: Timeline Comment Event description: Timeline Comment Event type: object properties: event: type: string actor: $ref: '#/components/schemas/simple-user' id: description: Unique identifier of the issue comment example: 42 type: integer node_id: type: string url: description: URL for the issue comment example: https://api.github.com/repositories/42/issues/comments/1 type: string format: uri body: description: Contents of the issue comment example: What version of Safari were you using when you observed this bug? type: string body_text: type: string body_html: type: string html_url: type: string format: uri user: $ref: '#/components/schemas/simple-user' created_at: type: string format: date-time example: '2011-04-14T16:00:49Z' updated_at: type: string format: date-time example: '2011-04-14T16:00:49Z' issue_url: type: string format: uri author_association: $ref: '#/components/schemas/author-association' performed_via_github_app: $ref: '#/components/schemas/nullable-integration' reactions: $ref: '#/components/schemas/reaction-rollup' required: - event - actor - id - node_id - html_url - issue_url - author_association - user - url - created_at - updated_at moved-column-in-project-issue-event: title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' project_card: type: object properties: id: type: integer url: type: string format: uri project_id: type: integer project_url: type: string format: uri column_name: type: string previous_column_name: type: string required: - id - url - project_id - project_url - column_name required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app review-request-removed-issue-event: title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' review_requester: $ref: '#/components/schemas/simple-user' requested_team: $ref: '#/components/schemas/team' requested_reviewer: $ref: '#/components/schemas/simple-user' required: - review_requester - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app issue-event: title: Issue Event description: Issue Event type: object properties: id: type: integer format: int64 example: 1 node_id: type: string example: MDEwOklzc3VlRXZlbnQx url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/issues/events/1 actor: $ref: '#/components/schemas/nullable-simple-user' event: type: string example: closed commit_id: type: string example: 6dcb09b5b57875f334f61aebed695e2e4193db5e nullable: true commit_url: type: string example: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e nullable: true created_at: type: string format: date-time example: '2011-04-14T16:00:49Z' issue: $ref: '#/components/schemas/nullable-issue' label: $ref: '#/components/schemas/issue-event-label' assignee: $ref: '#/components/schemas/nullable-simple-user' assigner: $ref: '#/components/schemas/nullable-simple-user' review_requester: $ref: '#/components/schemas/nullable-simple-user' requested_reviewer: $ref: '#/components/schemas/nullable-simple-user' requested_team: $ref: '#/components/schemas/team' dismissed_review: $ref: '#/components/schemas/issue-event-dismissed-review' milestone: $ref: '#/components/schemas/issue-event-milestone' project_card: $ref: '#/components/schemas/issue-event-project-card' rename: $ref: '#/components/schemas/issue-event-rename' author_association: $ref: '#/components/schemas/author-association' lock_reason: type: string nullable: true performed_via_github_app: $ref: '#/components/schemas/nullable-integration' required: - id - node_id - url - actor - event - commit_id - commit_url - created_at scim-error: title: Scim Error description: Scim Error type: object properties: message: type: string nullable: true documentation_url: type: string nullable: true detail: type: string nullable: true status: type: integer scimType: type: string nullable: true schemas: type: array items: type: string issue: title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object properties: id: type: integer format: int64 node_id: type: string url: description: URL for the issue example: https://api.github.com/repositories/42/issues/1 type: string format: uri repository_url: type: string format: uri labels_url: type: string comments_url: type: string format: uri events_url: type: string format: uri html_url: type: string format: uri number: description: Number uniquely identifying the issue within its repository example: 42 type: integer state: description: State of the issue; either 'open' or 'closed' example: open type: string state_reason: description: The reason for the current state example: not_planned type: string nullable: true enum: - completed - reopened - not_planned title: description: Title of the issue example: Widget creation fails in Safari on OS X 10.8 type: string body: description: Contents of the issue example: 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? type: string nullable: true user: $ref: '#/components/schemas/nullable-simple-user' 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 example: - bug - registration 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 nullable: true color: type: string nullable: true default: type: boolean assignee: $ref: '#/components/schemas/nullable-simple-user' assignees: type: array items: $ref: '#/components/schemas/simple-user' nullable: true milestone: $ref: '#/components/schemas/nullable-milestone' locked: type: boolean active_lock_reason: type: string nullable: true comments: type: integer pull_request: type: object properties: merged_at: type: string format: date-time nullable: true diff_url: type: string format: uri nullable: true html_url: type: string format: uri nullable: true patch_url: type: string format: uri nullable: true url: type: string format: uri nullable: true required: - diff_url - html_url - patch_url - url closed_at: type: string format: date-time nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time draft: type: boolean closed_by: $ref: '#/components/schemas/nullable-simple-user' body_html: type: string body_text: type: string timeline_url: type: string format: uri repository: $ref: '#/components/schemas/repository' performed_via_github_app: $ref: '#/components/schemas/nullable-integration' author_association: $ref: '#/components/schemas/author-association' reactions: $ref: '#/components/schemas/reaction-rollup' required: - assignee - closed_at - comments - comments_url - events_url - html_url - id - node_id - labels - labels_url - milestone - number - repository_url - state - locked - title - url - user - author_association - created_at - updated_at nullable-issue: title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object properties: id: type: integer format: int64 node_id: type: string url: description: URL for the issue example: https://api.github.com/repositories/42/issues/1 type: string format: uri repository_url: type: string format: uri labels_url: type: string comments_url: type: string format: uri events_url: type: string format: uri html_url: type: string format: uri number: description: Number uniquely identifying the issue within its repository example: 42 type: integer state: description: State of the issue; either 'open' or 'closed' example: open type: string state_reason: description: The reason for the current state example: not_planned type: string nullable: true enum: - completed - reopened - not_planned title: description: Title of the issue example: Widget creation fails in Safari on OS X 10.8 type: string body: description: Contents of the issue example: 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? type: string nullable: true user: $ref: '#/components/schemas/nullable-simple-user' 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 example: - bug - registration 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 nullable: true color: type: string nullable: true default: type: boolean assignee: $ref: '#/components/schemas/nullable-simple-user' assignees: type: array items: $ref: '#/components/schemas/simple-user' nullable: true milestone: $ref: '#/components/schemas/nullable-milestone' locked: type: boolean active_lock_reason: type: string nullable: true comments: type: integer pull_request: type: object properties: merged_at: type: string format: date-time nullable: true diff_url: type: string format: uri nullable: true html_url: type: string format: uri nullable: true patch_url: type: string format: uri nullable: true url: type: string format: uri nullable: true required: - diff_url - html_url - patch_url - url closed_at: type: string format: date-time nullable: true created_at: type: string format: date-time updated_at: type: string format: date-time draft: type: boolean closed_by: $ref: '#/components/schemas/nullable-simple-user' body_html: type: string body_text: type: string timeline_url: type: string format: uri repository: $ref: '#/components/schemas/repository' performed_via_github_app: $ref: '#/components/schemas/nullable-integration' author_association: $ref: '#/components/schemas/author-association' reactions: $ref: '#/components/schemas/reaction-rollup' required: - assignee - closed_at - comments - comments_url - events_url - html_url - id - node_id - labels - labels_url - milestone - number - repository_url - state - locked - title - url - user - author_association - created_at - updated_at nullable: true timeline-unassigned-issue-event: title: Timeline Unassigned Issue Event description: Timeline Unassigned Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' assignee: $ref: '#/components/schemas/simple-user' required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app - assignee locked-issue-event: title: Locked Issue Event description: Locked Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' lock_reason: type: string example: '"off-topic"' nullable: true required: - lock_reason - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app issue-event-milestone: title: Issue Event Milestone description: Issue Event Milestone type: object properties: title: type: string required: - title issue-event-project-card: title: Issue Event Project Card description: Issue Event Project Card type: object properties: url: type: string format: uri id: type: integer project_url: type: string format: uri project_id: type: integer column_name: type: string previous_column_name: type: string required: - url - id - project_url - project_id - column_name timeline-commit-commented-event: title: Timeline Commit Commented Event description: Timeline Commit Commented Event type: object properties: event: type: string node_id: type: string commit_id: type: string comments: type: array items: $ref: '#/components/schemas/commit-comment' commit-comment: title: Commit Comment description: Commit Comment type: object properties: html_url: type: string format: uri url: type: string format: uri id: type: integer node_id: type: string body: type: string path: type: string nullable: true position: type: integer nullable: true line: type: integer nullable: true commit_id: type: string user: $ref: '#/components/schemas/nullable-simple-user' created_at: type: string format: date-time updated_at: type: string format: date-time author_association: $ref: '#/components/schemas/author-association' reactions: $ref: '#/components/schemas/reaction-rollup' required: - url - html_url - id - node_id - user - position - line - path - commit_id - body - author_association - created_at - updated_at assigned-issue-event: title: Assigned Issue Event description: Assigned Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/integration' assignee: $ref: '#/components/schemas/simple-user' assigner: $ref: '#/components/schemas/simple-user' required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app - assignee - assigner review-dismissed-issue-event: title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' dismissed_review: type: object properties: state: type: string review_id: type: integer dismissal_message: nullable: true type: string dismissal_commit_id: type: string required: - state - review_id - dismissal_message required: - dismissed_review - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app removed-from-project-issue-event: title: Removed from Project Issue Event description: Removed from Project Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' project_card: type: object properties: id: type: integer url: type: string format: uri project_id: type: integer project_url: type: string format: uri column_name: type: string previous_column_name: type: string required: - id - url - project_id - project_url - column_name required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app review-requested-issue-event: title: Review Requested Issue Event description: Review Requested Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' review_requester: $ref: '#/components/schemas/simple-user' requested_team: $ref: '#/components/schemas/team' requested_reviewer: $ref: '#/components/schemas/simple-user' required: - review_requester - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app state-change-issue-event: title: State Change Issue Event description: State Change Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' state_reason: type: string nullable: true required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app validation-error: title: Validation Error description: Validation Error type: object required: - message - documentation_url properties: message: type: string documentation_url: type: string errors: type: array items: type: object required: - code properties: resource: type: string field: type: string message: type: string code: type: string index: type: integer value: oneOf: - type: string nullable: true - type: integer nullable: true - type: array nullable: true items: type: string timeline-committed-event: title: Timeline Committed Event description: Timeline Committed Event type: object properties: event: type: string sha: description: SHA for the commit example: 7638417db6d59f3c431d3e1f261cc637155684cd type: string node_id: type: string url: type: string format: uri author: description: Identifying information for the git-user type: object properties: date: description: Timestamp of the commit example: '2014-08-09T08:02:04+12:00' format: date-time type: string email: type: string description: Git email address of the user example: monalisa.octocat@example.com name: description: Name of the git user example: Monalisa Octocat type: string required: - email - name - date committer: description: Identifying information for the git-user type: object properties: date: description: Timestamp of the commit example: '2014-08-09T08:02:04+12:00' format: date-time type: string email: type: string description: Git email address of the user example: monalisa.octocat@example.com name: description: Name of the git user example: Monalisa Octocat type: string required: - email - name - date message: description: Message describing the purpose of the commit example: 'Fix #42' type: string tree: type: object properties: sha: description: SHA for the commit example: 7638417db6d59f3c431d3e1f261cc637155684cd type: string url: type: string format: uri required: - sha - url parents: type: array items: type: object properties: sha: description: SHA for the commit example: 7638417db6d59f3c431d3e1f261cc637155684cd type: string url: type: string format: uri html_url: type: string format: uri required: - sha - url - html_url verification: type: object properties: verified: type: boolean reason: type: string signature: type: string nullable: true payload: type: string nullable: true required: - verified - reason - signature - payload html_url: type: string format: uri required: - sha - node_id - url - html_url - author - committer - tree - message - parents - verification pull-request-review-comment: title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. type: object properties: url: description: URL for the pull request review comment example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 type: string pull_request_review_id: description: The ID of the pull request review to which the comment belongs. type: integer format: int64 example: 42 nullable: true id: description: The ID of the pull request review comment. type: integer format: int64 example: 1 node_id: description: The node ID of the pull request review comment. type: string example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw diff_hunk: description: The diff of the line that the comment refers to. type: string example: '@@ -16,33 +16,40 @@ public class Connection : IConnection...' path: description: The relative path of the file to which the comment applies. example: config/database.yaml type: string position: description: The line index in the diff to which the comment applies. This field is deprecated; use `line` instead. example: 1 type: integer original_position: description: The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead. example: 4 type: integer commit_id: description: The SHA of the commit to which the comment applies. example: 6dcb09b5b57875f334f61aebed695e2e4193db5e type: string original_commit_id: description: The SHA of the original commit to which the comment applies. example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840 type: string in_reply_to_id: description: The comment ID to reply to. example: 8 type: integer user: $ref: '#/components/schemas/simple-user' body: description: The text of the comment. example: We should probably include a check for null values here. type: string created_at: type: string format: date-time example: '2011-04-14T16:00:49Z' updated_at: type: string format: date-time example: '2011-04-14T16:00:49Z' html_url: description: HTML URL for the pull request review comment. type: string format: uri example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 pull_request_url: description: URL for the pull request that the review comment belongs to. type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 author_association: $ref: '#/components/schemas/author-association' _links: type: object properties: self: type: object properties: href: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 required: - href html: type: object properties: href: type: string format: uri example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1 required: - href pull_request: type: object properties: href: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 required: - href required: - self - html - pull_request start_line: type: integer description: The first line of the range for a multi-line comment. example: 2 nullable: true original_start_line: type: integer description: The first line of the range for a multi-line comment. example: 2 nullable: true start_side: type: string description: The side of the first line of the range for a multi-line comment. enum: - LEFT - RIGHT default: RIGHT nullable: true line: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment example: 2 type: integer original_line: description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment example: 2 type: integer side: description: The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment enum: - LEFT - RIGHT default: RIGHT type: string subject_type: description: The level at which the comment is targeted, can be a diff line or a file. type: string enum: - line - file reactions: $ref: '#/components/schemas/reaction-rollup' body_html: type: string example: '"comment body
"' body_text: type: string example: '"comment body"' required: - url - id - node_id - pull_request_review_id - diff_hunk - path - commit_id - original_commit_id - user - body - created_at - updated_at - html_url - pull_request_url - author_association - _links renamed-issue-event: title: Renamed Issue Event description: Renamed Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' rename: type: object properties: from: type: string to: type: string required: - from - to required: - rename - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app issue-event-for-issue: title: Issue Event for Issue description: Issue Event for Issue anyOf: - $ref: '#/components/schemas/labeled-issue-event' - $ref: '#/components/schemas/unlabeled-issue-event' - $ref: '#/components/schemas/assigned-issue-event' - $ref: '#/components/schemas/unassigned-issue-event' - $ref: '#/components/schemas/milestoned-issue-event' - $ref: '#/components/schemas/demilestoned-issue-event' - $ref: '#/components/schemas/renamed-issue-event' - $ref: '#/components/schemas/review-requested-issue-event' - $ref: '#/components/schemas/review-request-removed-issue-event' - $ref: '#/components/schemas/review-dismissed-issue-event' - $ref: '#/components/schemas/locked-issue-event' - $ref: '#/components/schemas/added-to-project-issue-event' - $ref: '#/components/schemas/moved-column-in-project-issue-event' - $ref: '#/components/schemas/removed-from-project-issue-event' - $ref: '#/components/schemas/converted-note-to-issue-issue-event' issue-event-dismissed-review: title: Issue Event Dismissed Review type: object properties: state: type: string review_id: type: integer dismissal_message: type: string nullable: true dismissal_commit_id: type: string nullable: true required: - state - review_id - dismissal_message timeline-assigned-issue-event: title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' assignee: $ref: '#/components/schemas/simple-user' required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app - assignee unassigned-issue-event: title: Unassigned Issue Event description: Unassigned Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' assignee: $ref: '#/components/schemas/simple-user' assigner: $ref: '#/components/schemas/simple-user' required: - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app - assignee - assigner nullable-integration: 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 nullable: true properties: id: description: Unique identifier of the GitHub app example: 37 type: integer slug: description: The slug name of the GitHub app example: probot-owners type: string node_id: type: string example: MDExOkludGVncmF0aW9uMQ== owner: $ref: '#/components/schemas/nullable-simple-user' name: description: The name of the GitHub app example: Probot Owners type: string description: type: string example: The description of the app. nullable: true external_url: type: string format: uri example: https://example.com html_url: type: string format: uri example: https://github.com/apps/super-ci created_at: type: string format: date-time example: '2017-07-08T16:18:44-04:00' updated_at: type: string format: date-time example: '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 example: - label - deployment type: array items: type: string installations_count: description: The number of installations associated with the GitHub app example: 5 type: integer client_id: type: string example: '"Iv1.25b5d1e65ffc4022"' client_secret: type: string example: '"1d4b2097ac622ba702d19de498f005747a8b21d3"' webhook_secret: type: string example: '"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"' nullable: true pem: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at - permissions - events issue-event-rename: title: Issue Event Rename description: Issue Event Rename type: object properties: from: type: string to: type: string required: - from - to demilestoned-issue-event: title: Demilestoned Issue Event description: Demilestoned Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' milestone: type: object properties: title: type: string required: - title required: - milestone - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app timeline-issue-events: title: Timeline Event description: Timeline Event type: object anyOf: - $ref: '#/components/schemas/labeled-issue-event' - $ref: '#/components/schemas/unlabeled-issue-event' - $ref: '#/components/schemas/milestoned-issue-event' - $ref: '#/components/schemas/demilestoned-issue-event' - $ref: '#/components/schemas/renamed-issue-event' - $ref: '#/components/schemas/review-requested-issue-event' - $ref: '#/components/schemas/review-request-removed-issue-event' - $ref: '#/components/schemas/review-dismissed-issue-event' - $ref: '#/components/schemas/locked-issue-event' - $ref: '#/components/schemas/added-to-project-issue-event' - $ref: '#/components/schemas/moved-column-in-project-issue-event' - $ref: '#/components/schemas/removed-from-project-issue-event' - $ref: '#/components/schemas/converted-note-to-issue-issue-event' - $ref: '#/components/schemas/timeline-comment-event' - $ref: '#/components/schemas/timeline-cross-referenced-event' - $ref: '#/components/schemas/timeline-committed-event' - $ref: '#/components/schemas/timeline-reviewed-event' - $ref: '#/components/schemas/timeline-line-commented-event' - $ref: '#/components/schemas/timeline-commit-commented-event' - $ref: '#/components/schemas/timeline-assigned-issue-event' - $ref: '#/components/schemas/timeline-unassigned-issue-event' - $ref: '#/components/schemas/state-change-issue-event' timeline-reviewed-event: title: Timeline Reviewed Event description: Timeline Reviewed Event type: object properties: event: type: string id: description: Unique identifier of the review example: 42 type: integer node_id: type: string example: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= user: $ref: '#/components/schemas/simple-user' body: nullable: true description: The text of the review. example: This looks great. type: string state: type: string example: CHANGES_REQUESTED html_url: type: string format: uri example: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80 pull_request_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/12 _links: type: object properties: html: type: object properties: href: type: string required: - href pull_request: type: object properties: href: type: string required: - href required: - html - pull_request submitted_at: type: string format: date-time commit_id: description: A commit SHA for the review. example: 54bb654c9e6025347f57900a4a5c2313a96b8035 type: string body_html: type: string body_text: type: string author_association: $ref: '#/components/schemas/author-association' required: - event - id - node_id - user - body - state - commit_id - html_url - pull_request_url - _links - author_association simple-user: title: Simple User description: A GitHub user. type: object properties: name: nullable: true type: string email: nullable: true type: string login: type: string example: octocat id: type: integer format: int64 example: 1 node_id: type: string example: MDQ6VXNlcjE= avatar_url: type: string format: uri example: https://github.com/images/error/octocat_happy.gif gravatar_id: type: string example: 41d064eb2195891e12d0413f63227ea7 nullable: true url: type: string format: uri example: https://api.github.com/users/octocat html_url: type: string format: uri example: https://github.com/octocat followers_url: type: string format: uri example: https://api.github.com/users/octocat/followers following_url: type: string example: https://api.github.com/users/octocat/following{/other_user} gists_url: type: string example: https://api.github.com/users/octocat/gists{/gist_id} starred_url: type: string example: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: type: string format: uri example: https://api.github.com/users/octocat/subscriptions organizations_url: type: string format: uri example: https://api.github.com/users/octocat/orgs repos_url: type: string format: uri example: https://api.github.com/users/octocat/repos events_url: type: string example: https://api.github.com/users/octocat/events{/privacy} received_events_url: type: string format: uri example: https://api.github.com/users/octocat/received_events type: type: string example: User site_admin: type: boolean starred_at: type: string example: '"2020-07-09T00:17:55Z"' required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url nullable-team-simple: 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 example: 1 node_id: type: string example: MDQ6VGVhbTE= url: description: URL for the team type: string format: uri example: https://api.github.com/organizations/1/team/1 members_url: type: string example: https://api.github.com/organizations/1/team/1/members{/member} name: description: Name of the team type: string example: Justice League description: description: Description of the team type: string nullable: true example: A great team. permission: description: Permission that the team will have for its repositories type: string example: admin privacy: description: The level of privacy this team should have type: string example: closed html_url: type: string format: uri example: https://github.com/orgs/rails/teams/core repositories_url: type: string format: uri example: https://api.github.com/organizations/1/team/1/repos slug: type: string example: justice-league ldap_dn: description: Distinguished Name (DN) that team maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string required: - id - node_id - url - members_url - name - description - permission - html_url - repositories_url - slug nullable: true milestoned-issue-event: title: Milestoned Issue Event description: Milestoned Issue Event type: object properties: id: type: integer node_id: type: string url: type: string actor: $ref: '#/components/schemas/simple-user' event: type: string commit_id: type: string nullable: true commit_url: type: string nullable: true created_at: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' milestone: type: object properties: title: type: string required: - title required: - milestone - id - node_id - url - actor - event - commit_id - commit_url - created_at - performed_via_github_app nullable-license-simple: title: License Simple description: License Simple type: object properties: key: type: string example: mit name: type: string example: MIT License url: type: string nullable: true format: uri example: https://api.github.com/licenses/mit spdx_id: type: string nullable: true example: MIT node_id: type: string example: MDc6TGljZW5zZW1pdA== html_url: type: string format: uri required: - key - name - url - spdx_id - node_id nullable: true author-association: title: author_association type: string example: OWNER description: How the author is associated with the repository. enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER timeline-line-commented-event: title: Timeline Line Commented Event description: Timeline Line Commented Event type: object properties: event: type: string node_id: type: string comments: type: array items: $ref: '#/components/schemas/pull-request-review-comment' responses: forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/basic-error' service_unavailable: description: Service unavailable content: application/json: schema: type: object properties: code: type: string message: type: string documentation_url: type: string bad_request: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/basic-error' application/scim+json: schema: $ref: '#/components/schemas/scim-error' gone: description: Gone content: application/json: schema: $ref: '#/components/schemas/basic-error' moved_permanently: description: Moved permanently content: application/json: schema: $ref: '#/components/schemas/basic-error' not_found: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/basic-error' not_modified: description: Not modified validation_failed: description: Validation failed, or the endpoint has been spammed. content: application/json: schema: $ref: '#/components/schemas/validation-error' examples: issue-event: value: id: 1 node_id: MDEwOklzc3VlRXZlbnQx url: https://api.github.com/repos/octocat/Hello-World/issues/events/1 actor: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false event: closed commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e commit_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e created_at: '2011-04-14T16:00:49Z' issue: id: 1 node_id: MDU6SXNzdWUx url: https://api.github.com/repos/octocat/Hello-World/issues/1347 repository_url: https://api.github.com/repos/octocat/Hello-World labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events html_url: https://github.com/octocat/Hello-World/issues/1347 number: 1347 state: open title: Found a bug body: I'm having a problem with this. user: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false labels: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= url: https://api.github.com/repos/octocat/Hello-World/labels/bug name: bug description: Something isn't working color: f29513 default: true assignee: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false assignees: - login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false milestone: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels id: 1002604 node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== number: 1 state: open title: v1.0 description: Tracking milestone for version 1.0 creator: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false open_issues: 4 closed_issues: 8 created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' locked: true performed_via_github_app: id: 1 slug: octoapp node_id: MDExOkludGVncmF0aW9uMQ== owner: login: github id: 1 node_id: MDEyOk9yZ2FuaXphdGlvbjE= url: https://api.github.com/orgs/github repos_url: https://api.github.com/orgs/github/repos events_url: https://api.github.com/orgs/github/events avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true name: Octocat App description: '' external_url: https://example.com html_url: https://github.com/apps/octoapp created_at: '2017-07-08T16:18:44-04:00' updated_at: '2017-07-08T16:18:44-04:00' permissions: metadata: read contents: read issues: write single_file: write events: - push - pull_request comments: 0 pull_request: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 html_url: https://github.com/octocat/Hello-World/pull/1347 diff_url: https://github.com/octocat/Hello-World/pull/1347.diff patch_url: https://github.com/octocat/Hello-World/pull/1347.patch closed_at: null created_at: '2011-04-22T13:33:48Z' updated_at: '2011-04-22T13:33:48Z' author_association: COLLABORATOR state_reason: completed issue-comment-items: value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 body: Me too user: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false created_at: '2011-04-14T16:00:49Z' updated_at: '2011-04-14T16:00:49Z' issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR issue-comment: value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1 body: Me too user: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false created_at: '2011-04-14T16:00:49Z' updated_at: '2011-04-14T16:00:49Z' issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR issue-event-items: value: - id: 1 node_id: MDEwOklzc3VlRXZlbnQx url: https://api.github.com/repos/octocat/Hello-World/issues/events/1 actor: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false event: closed commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e commit_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e created_at: '2011-04-14T16:00:49Z' issue: id: 1 node_id: MDU6SXNzdWUx url: https://api.github.com/repos/octocat/Hello-World/issues/1347 repository_url: https://api.github.com/repos/octocat/Hello-World labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events html_url: https://github.com/octocat/Hello-World/issues/1347 number: 1347 state: open title: Found a bug body: I'm having a problem with this. user: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false labels: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= url: https://api.github.com/repos/octocat/Hello-World/labels/bug name: bug description: Something isn't working color: f29513 default: true assignee: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false assignees: - login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false milestone: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels id: 1002604 node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== number: 1 state: open title: v1.0 description: Tracking milestone for version 1.0 creator: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false open_issues: 4 closed_issues: 8 created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' locked: true active_lock_reason: too heated comments: 0 pull_request: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 html_url: https://github.com/octocat/Hello-World/pull/1347 diff_url: https://github.com/octocat/Hello-World/pull/1347.diff patch_url: https://github.com/octocat/Hello-World/pull/1347.patch closed_at: null created_at: '2011-04-22T13:33:48Z' updated_at: '2011-04-22T13:33:48Z' author_association: COLLABORATOR state_reason: completed label-items: value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= url: https://api.github.com/repos/octocat/Hello-World/labels/bug name: bug description: Something isn't working color: f29513 default: true - id: 208045947 node_id: MDU6TGFiZWwyMDgwNDU5NDc= url: https://api.github.com/repos/octocat/Hello-World/labels/enhancement name: enhancement description: New feature or request color: a2eeef default: false label-2: value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= url: 'https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:' name: 'bug :bug:' description: Small bug fix required color: b01f26 default: true label-items-2: value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= url: https://api.github.com/repos/octocat/Hello-World/labels/bug name: bug description: Something isn't working color: f29513 default: true simple-user-items: value: - login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false issue-with-repo-items: value: - id: 1 node_id: MDU6SXNzdWUx url: https://api.github.com/repos/octocat/Hello-World/issues/1347 repository_url: https://api.github.com/repos/octocat/Hello-World labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events html_url: https://github.com/octocat/Hello-World/issues/1347 number: 1347 state: open title: Found a bug body: I'm having a problem with this. user: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false labels: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= url: https://api.github.com/repos/octocat/Hello-World/labels/bug name: bug description: Something isn't working color: f29513 default: true assignee: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false assignees: - login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false milestone: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels id: 1002604 node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== number: 1 state: open title: v1.0 description: Tracking milestone for version 1.0 creator: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false open_issues: 4 closed_issues: 8 created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' locked: true active_lock_reason: too heated comments: 0 pull_request: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 html_url: https://github.com/octocat/Hello-World/pull/1347 diff_url: https://github.com/octocat/Hello-World/pull/1347.diff patch_url: https://github.com/octocat/Hello-World/pull/1347.patch closed_at: null created_at: '2011-04-22T13:33:48Z' updated_at: '2011-04-22T13:33:48Z' repository: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: Hello-World full_name: octocat/Hello-World owner: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false private: false html_url: https://github.com/octocat/Hello-World description: This your first repo! fork: false url: https://api.github.com/repos/octocat/Hello-World archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads events_url: https://api.github.com/repos/octocat/Hello-World/events forks_url: https://api.github.com/repos/octocat/Hello-World/forks git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: git:github.com/octocat/Hello-World.git issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: https://api.github.com/repos/octocat/Hello-World/languages merges_url: https://api.github.com/repos/octocat/Hello-World/merges milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: git@github.com:octocat/Hello-World.git stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription tags_url: https://api.github.com/repos/octocat/Hello-World/tags teams_url: https://api.github.com/repos/octocat/Hello-World/teams trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} clone_url: https://github.com/octocat/Hello-World.git mirror_url: git:git.example.com/octocat/Hello-World hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks svn_url: https://svn.github.com/octocat/Hello-World homepage: https://github.com language: null forks_count: 9 stargazers_count: 80 watchers_count: 80 size: 108 default_branch: master open_issues_count: 0 is_template: true topics: - octocat - atom - electron - api has_issues: true has_projects: true has_wiki: true has_pages: false has_downloads: true archived: false disabled: false visibility: public pushed_at: '2011-01-26T19:06:43Z' created_at: '2011-01-26T19:01:12Z' updated_at: '2011-01-26T19:14:43Z' permissions: admin: false push: false pull: true allow_rebase_merge: true template_repository: null temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O allow_squash_merge: true allow_auto_merge: false delete_branch_on_merge: true allow_merge_commit: true subscribers_count: 42 network_count: 0 license: key: mit name: MIT License url: https://api.github.com/licenses/mit spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://github.com/licenses/mit forks: 1 open_issues: 1 watchers: 1 author_association: COLLABORATOR milestone: value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels id: 1002604 node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== number: 1 state: open title: v1.0 description: Tracking milestone for version 1.0 creator: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false open_issues: 4 closed_issues: 8 created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' timeline-issue-events: value: - id: 6430295168 node_id: LOE_lADODwFebM5HwC0kzwAAAAF_RoSA url: https://api.github.com/repos/github/roadmap/issues/events/6430295168 actor: login: github id: 9919 node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 gravatar_id: '' url: https://api.github.com/users/github html_url: https://github.com/github followers_url: https://api.github.com/users/github/followers following_url: https://api.github.com/users/github/following{/other_user} gists_url: https://api.github.com/users/github/gists{/gist_id} starred_url: https://api.github.com/users/github/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/github/subscriptions organizations_url: https://api.github.com/users/github/orgs repos_url: https://api.github.com/users/github/repos events_url: https://api.github.com/users/github/events{/privacy} received_events_url: https://api.github.com/users/github/received_events type: Organization site_admin: false event: locked commit_id: null commit_url: null created_at: '2022-04-13T20:49:13Z' lock_reason: null performed_via_github_app: null - id: 6430296748 node_id: LE_lADODwFebM5HwC0kzwAAAAF_Roqs url: https://api.github.com/repos/github/roadmap/issues/events/6430296748 actor: login: github-product-roadmap id: 67656570 node_id: MDQ6VXNlcjY3NjU2NTcw avatar_url: https://avatars.githubusercontent.com/u/67656570?v=4 gravatar_id: '' url: https://api.github.com/users/github-product-roadmap html_url: https://github.com/github-product-roadmap followers_url: https://api.github.com/users/github-product-roadmap/followers following_url: https://api.github.com/users/github-product-roadmap/following{/other_user} gists_url: https://api.github.com/users/github-product-roadmap/gists{/gist_id} starred_url: https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/github-product-roadmap/subscriptions organizations_url: https://api.github.com/users/github-product-roadmap/orgs repos_url: https://api.github.com/users/github-product-roadmap/repos events_url: https://api.github.com/users/github-product-roadmap/events{/privacy} received_events_url: https://api.github.com/users/github-product-roadmap/received_events type: User site_admin: false event: labeled commit_id: null commit_url: null created_at: '2022-04-13T20:49:34Z' label: name: beta color: 99dd88 performed_via_github_app: null - id: 6635165802 node_id: RTE_lADODwFebM5HwC0kzwAAAAGLfJhq url: https://api.github.com/repos/github/roadmap/issues/events/6635165802 actor: login: github-product-roadmap id: 67656570 node_id: MDQ6VXNlcjY3NjU2NTcw avatar_url: https://avatars.githubusercontent.com/u/67656570?v=4 gravatar_id: '' url: https://api.github.com/users/github-product-roadmap html_url: https://github.com/github-product-roadmap followers_url: https://api.github.com/users/github-product-roadmap/followers following_url: https://api.github.com/users/github-product-roadmap/following{/other_user} gists_url: https://api.github.com/users/github-product-roadmap/gists{/gist_id} starred_url: https://api.github.com/users/github-product-roadmap/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/github-product-roadmap/subscriptions organizations_url: https://api.github.com/users/github-product-roadmap/orgs repos_url: https://api.github.com/users/github-product-roadmap/repos events_url: https://api.github.com/users/github-product-roadmap/events{/privacy} received_events_url: https://api.github.com/users/github-product-roadmap/received_events type: User site_admin: false event: renamed commit_id: null commit_url: null created_at: '2022-05-18T19:29:01Z' rename: from: 'Secret scanning: dry-runs for enterprise-level custom patterns (cloud)' to: 'Secret scanning: dry-runs for enterprise-level custom patterns' performed_via_github_app: null - url: https://api.github.com/repos/github/roadmap/issues/comments/1130876857 html_url: https://github.com/github/roadmap/issues/493#issuecomment-1130876857 issue_url: https://api.github.com/repos/github/roadmap/issues/493 id: 1130876857 node_id: IC_kwDODwFebM5DZ8-5 user: login: octocat id: 94867353 node_id: U_kgDOBaePmQ avatar_url: https://avatars.githubusercontent.com/u/94867353?v=4 gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true created_at: '2022-05-19T00:52:15Z' updated_at: '2022-05-19T00:52:15Z' author_association: COLLABORATOR body: '🚢 Shipped to the cloud: https://github.blog/changelog/2022-05-12-secret-scanning-dry-runs-for-enterprise-level-custom-patterns/' reactions: url: https://api.github.com/repos/github/roadmap/issues/comments/1130876857/reactions total_count: 0 '+1': 0 '-1': 0 laugh: 0 hooray: 0 confused: 0 heart: 0 rocket: 0 eyes: 0 performed_via_github_app: null event: commented actor: login: octocat id: 94867353 node_id: U_kgDOBaePmQ avatar_url: https://avatars.githubusercontent.com/u/94867353?v=4 gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true issue-event-for-issue-items: value: - id: 1 node_id: MDEwOklzc3VlRXZlbnQx url: https://api.github.com/repos/octocat/Hello-World/issues/events/1 actor: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false event: closed commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e commit_url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e created_at: '2011-04-14T16:00:49Z' performed_via_github_app: null label: name: label color: red issue: value: id: 1 node_id: MDU6SXNzdWUx url: https://api.github.com/repos/octocat/Hello-World/issues/1347 repository_url: https://api.github.com/repos/octocat/Hello-World labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events html_url: https://github.com/octocat/Hello-World/issues/1347 number: 1347 state: open title: Found a bug body: I'm having a problem with this. user: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false labels: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= url: https://api.github.com/repos/octocat/Hello-World/labels/bug name: bug description: Something isn't working color: f29513 default: true assignee: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false assignees: - login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false milestone: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels id: 1002604 node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== number: 1 state: open title: v1.0 description: Tracking milestone for version 1.0 creator: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false open_issues: 4 closed_issues: 8 created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' locked: true active_lock_reason: too heated comments: 0 pull_request: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 html_url: https://github.com/octocat/Hello-World/pull/1347 diff_url: https://github.com/octocat/Hello-World/pull/1347.diff patch_url: https://github.com/octocat/Hello-World/pull/1347.patch closed_at: null created_at: '2011-04-22T13:33:48Z' updated_at: '2011-04-22T13:33:48Z' closed_by: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false author_association: COLLABORATOR state_reason: completed label: value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= url: https://api.github.com/repos/octocat/Hello-World/labels/bug name: bug description: Something isn't working color: f29513 default: true issue-items: value: - id: 1 node_id: MDU6SXNzdWUx url: https://api.github.com/repos/octocat/Hello-World/issues/1347 repository_url: https://api.github.com/repos/octocat/Hello-World labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name} comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events html_url: https://github.com/octocat/Hello-World/issues/1347 number: 1347 state: open title: Found a bug body: I'm having a problem with this. user: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false labels: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= url: https://api.github.com/repos/octocat/Hello-World/labels/bug name: bug description: Something isn't working color: f29513 default: true assignee: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false assignees: - login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false milestone: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels id: 1002604 node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== number: 1 state: open title: v1.0 description: Tracking milestone for version 1.0 creator: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false open_issues: 4 closed_issues: 8 created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' locked: true active_lock_reason: too heated comments: 0 pull_request: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 html_url: https://github.com/octocat/Hello-World/pull/1347 diff_url: https://github.com/octocat/Hello-World/pull/1347.diff patch_url: https://github.com/octocat/Hello-World/pull/1347.patch closed_at: null created_at: '2011-04-22T13:33:48Z' updated_at: '2011-04-22T13:33:48Z' closed_by: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false author_association: COLLABORATOR state_reason: completed milestone-items: value: - url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels id: 1002604 node_id: MDk6TWlsZXN0b25lMTAwMjYwNA== number: 1 state: open title: v1.0 description: Tracking milestone for version 1.0 creator: login: octocat id: 1 node_id: MDQ6VXNlcjE= avatar_url: https://github.com/images/error/octocat_happy.gif gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/octocat followers_url: https://api.github.com/users/octocat/followers following_url: https://api.github.com/users/octocat/following{/other_user} gists_url: https://api.github.com/users/octocat/gists{/gist_id} starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octocat/subscriptions organizations_url: https://api.github.com/users/octocat/orgs repos_url: https://api.github.com/users/octocat/repos events_url: https://api.github.com/users/octocat/events{/privacy} received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: false open_issues: 4 closed_issues: 8 created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' parameters: sort: name: sort description: The property to sort the results by. in: query required: false schema: type: string enum: - created - updated default: created repo: name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. in: path required: true schema: type: string per-page: name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 30 issue-number: name: issue_number description: The number that identifies the issue. in: path required: true schema: type: integer org: name: org description: The organization name. The name is not case sensitive. in: path required: true schema: type: string milestone-number: name: milestone_number description: The number that identifies the milestone. in: path required: true schema: type: integer owner: name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string comment-id: name: comment_id description: The unique identifier of the comment. in: path required: true schema: type: integer direction: name: direction description: The direction to sort the results by. in: query required: false schema: type: string enum: - asc - desc default: desc since: name: since description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false schema: type: string format: date-time page: name: page description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 1 labels: name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false schema: type: string headers: link: example: