-
Notifications
You must be signed in to change notification settings - Fork 250
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #370 from github/openapi-update-6818ba6ee2d899c921…
…0a331a41d561dd6900f3efb597fb024237882390cd5653 Update OpenAPI Descriptions
- Loading branch information
Showing
36 changed files
with
257,108 additions
and
275,839 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
670 changes: 335 additions & 335 deletions
670
descriptions/api.github.com/dereferenced/api.github.com.deref.json
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2203,7 +2203,7 @@ paths: | |
| examples: | ||
| default: | ||
| value: | ||
| token: v1.1f699f1069f60xxx | ||
| token: ghs_16C7e42F292c6912E7710c838347Ae178B4a | ||
| expires_at: '2016-07-11T22:14:10Z' | ||
| permissions: | ||
| issues: write | ||
|
|
@@ -2946,8 +2946,8 @@ paths: | |
| scopes: | ||
| - public_repo | ||
| - user | ||
| token: abcdefgh12345678 | ||
| token_last_eight: '12345678' | ||
| token: ghu_16C7e42F292c6912E7710c838347Ae178B4a | ||
| token_last_eight: Ae178B4a | ||
| hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 | ||
| app: | ||
| url: http://my-github-app.com | ||
|
|
@@ -3176,8 +3176,8 @@ paths: | |
| id: 1 | ||
| url: https://api.github.com/authorizations/1 | ||
| scopes: [] | ||
| token: abcdefgh12345678 | ||
| token_last_eight: '12345678' | ||
| token: ghu_16C7e42F292c6912E7710c838347Ae178B4a | ||
| token_last_eight: Ae178B4a | ||
| hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 | ||
| app: | ||
| url: http://my-github-app.com | ||
|
|
@@ -3491,8 +3491,8 @@ paths: | |
| url: https://api.github.com/authorizations/1 | ||
| scopes: | ||
| - public_repo | ||
| token: '' | ||
| token_last_eight: '12345678' | ||
| token: ghu_16C7e42F292c6912E7710c838347Ae178B4a | ||
| token_last_eight: Ae178B4a | ||
| hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 | ||
| app: | ||
| url: http://my-github-app.com | ||
|
|
@@ -3603,8 +3603,8 @@ paths: | |
| url: https://api.github.com/authorizations/1 | ||
| scopes: | ||
| - public_repo | ||
| token: abcdefgh12345678 | ||
| token_last_eight: '12345678' | ||
| token: ghu_16C7e42F292c6912E7710c838347Ae178B4a | ||
| token_last_eight: Ae178B4a | ||
| hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 | ||
| app: | ||
| url: http://my-github-app.com | ||
|
|
@@ -3726,8 +3726,8 @@ paths: | |
| url: https://api.github.com/authorizations/1 | ||
| scopes: | ||
| - public_repo | ||
| token: '' | ||
| token_last_eight: '12345678' | ||
| token: ghu_16C7e42F292c6912E7710c838347Ae178B4a | ||
| token_last_eight: Ae178B4a | ||
| hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 | ||
| app: | ||
| url: http://my-github-app.com | ||
|
|
@@ -3865,8 +3865,8 @@ paths: | |
| url: https://api.github.com/authorizations/1 | ||
| scopes: | ||
| - public_repo | ||
| token: '' | ||
| token_last_eight: '12345678' | ||
| token: ghu_16C7e42F292c6912E7710c838347Ae178B4a | ||
| token_last_eight: Ae178B4a | ||
| hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 | ||
| app: | ||
| url: http://my-github-app.com | ||
|
|
@@ -3900,8 +3900,8 @@ paths: | |
| url: https://api.github.com/authorizations/1 | ||
| scopes: | ||
| - public_repo | ||
| token: abcdefgh12345678 | ||
| token_last_eight: '12345678' | ||
| token: ghu_16C7e42F292c6912E7710c838347Ae178B4a | ||
| token_last_eight: Ae178B4a | ||
| hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 | ||
| app: | ||
| url: http://my-github-app.com | ||
|
|
@@ -3971,8 +3971,8 @@ paths: | |
| url: https://api.github.com/authorizations/1 | ||
| scopes: | ||
| - public_repo | ||
| token: '' | ||
| token_last_eight: '12345678' | ||
| token: ghu_16C7e42F292c6912E7710c838347Ae178B4a | ||
| token_last_eight: Ae178B4a | ||
| hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8 | ||
| app: | ||
| url: http://my-github-app.com | ||
|
|
@@ -14932,7 +14932,7 @@ paths: | |
| - login: hubot | ||
| credential_id: 161196 | ||
| credential_type: personal access token | ||
| token_last_eight: '12345678' | ||
| token_last_eight: Ae178B4a | ||
| credential_authorized_at: '2019-03-29T19:06:43Z' | ||
| scopes: | ||
| - repo | ||
|
|
@@ -43092,6 +43092,138 @@ paths: | |
| previews: [] | ||
| category: repos | ||
| subcategory: commits | ||
| "/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments": | ||
| post: | ||
| summary: Create a content attachment | ||
| description: |- | ||
| Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment. | ||
|
|
||
| The app must create a content attachment within six hours of the content reference URL being posted. See "[Using content attachments](https://docs.github.com/apps/using-content-attachments/)" for details about content attachments. | ||
|
|
||
| You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. | ||
| tags: | ||
| - apps | ||
| operationId: apps/create-content-attachment | ||
| externalDocs: | ||
| description: API method documentation | ||
| url: https://docs.github.com/rest/reference/apps#create-a-content-attachment | ||
| parameters: | ||
| - name: owner | ||
| description: The owner of the repository. Determined from the `repository` | ||
| `full_name` of the `content_reference` event. | ||
| in: path | ||
| required: true | ||
| schema: | ||
| type: string | ||
| - name: repo | ||
| description: The name of the repository. Determined from the `repository` | ||
| `full_name` of the `content_reference` event. | ||
| in: path | ||
| required: true | ||
| schema: | ||
| type: string | ||
| - name: content_reference_id | ||
| description: The `id` of the `content_reference` event. | ||
| in: path | ||
| required: true | ||
| schema: | ||
| type: integer | ||
| requestBody: | ||
| content: | ||
| application/json: | ||
| schema: | ||
| properties: | ||
| title: | ||
| description: The title of the attachment | ||
| example: Title of the attachment | ||
| type: string | ||
| maxLength: 1024 | ||
| body: | ||
| description: The body of the attachment | ||
| example: Body of the attachment | ||
| type: string | ||
| maxLength: 262144 | ||
| required: | ||
| - title | ||
| - body | ||
| type: object | ||
| responses: | ||
| '200': | ||
| description: Response | ||
| content: | ||
| application/json: | ||
| schema: | ||
| title: ContentReferenceAttachment | ||
| description: Content Reference attachments allow you to provide context | ||
| around URLs posted in comments | ||
| type: object | ||
| properties: | ||
| id: | ||
| description: The ID of the attachment | ||
| example: 21 | ||
| type: integer | ||
| title: | ||
| description: The title of the attachment | ||
| example: Title of the attachment | ||
| type: string | ||
| maxLength: 1024 | ||
| body: | ||
| description: The body of the attachment | ||
| example: Body of the attachment | ||
| type: string | ||
| maxLength: 262144 | ||
| node_id: | ||
| description: The node_id of the content attachment | ||
| example: MDE3OkNvbnRlbnRBdHRhY2htZW50MjE= | ||
| type: string | ||
| required: | ||
| - id | ||
| - title | ||
| - body | ||
| examples: | ||
| default: | ||
| value: | ||
| id: 101 | ||
| title: "[A-1234] Error found in core/models.py file'" | ||
| body: |- | ||
| You have used an email that already exists for the user_email_uniq field. | ||
| ## DETAILS: | ||
|
|
||
| The (email)=([email protected]) already exists. | ||
|
|
||
| The error was found in core/models.py in get_or_create_user at line 62. | ||
|
|
||
| self.save() | ||
| '422': | ||
| description: Validation failed | ||
| content: *22 | ||
| '404': | ||
| description: Resource not found | ||
| content: *10 | ||
| '410': | ||
| description: Gone | ||
| content: *163 | ||
| '415': | ||
| description: Preview header missing | ||
| content: *13 | ||
| '304': | ||
| description: Not modified | ||
| '403': | ||
| description: Forbidden | ||
| content: *17 | ||
| x-github: | ||
| githubCloudOnly: false | ||
| enabledForGitHubApps: true | ||
| previews: | ||
| - required: true | ||
| name: corsair | ||
| note: |- | ||
| To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header: | ||
| ```shell | ||
| application/vnd.github.corsair-preview+json | ||
| ``` | ||
| category: apps | ||
| subcategory: installations | ||
| "/repos/{owner}/{repo}/contents/{path}": | ||
| get: | ||
| summary: Get repository content | ||
|
|
@@ -79224,135 +79356,3 @@ paths: | |
| enabledForGitHubApps: true | ||
| previews: [] | ||
| category: meta | ||
| "/{owner}/{repo}/content_references/{content_reference_id}/attachments": | ||
| post: | ||
| summary: Create a content attachment | ||
| description: |- | ||
| Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` and `repository` `full_name` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment. | ||
|
|
||
| The app must create a content attachment within six hours of the content reference URL being posted. See "[Using content attachments](https://docs.github.com/apps/using-content-attachments/)" for details about content attachments. | ||
|
|
||
| You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. | ||
| tags: | ||
| - apps | ||
| operationId: apps/create-content-attachment | ||
| externalDocs: | ||
| description: API method documentation | ||
| url: https://docs.github.com/rest/reference/apps#create-a-content-attachment | ||
| parameters: | ||
| - name: owner | ||
| description: The owner of the repository. Determined from the `repository` | ||
| `full_name` of the `content_reference` event. | ||
| in: path | ||
| required: true | ||
| schema: | ||
| type: string | ||
| - name: repo | ||
| description: The name of the repository. Determined from the `repository` | ||
| `full_name` of the `content_reference` event. | ||
| in: path | ||
| required: true | ||
| schema: | ||
| type: string | ||
| - name: content_reference_id | ||
| description: The `id` of the `content_reference` event. | ||
| in: path | ||
| required: true | ||
| schema: | ||
| type: integer | ||
| requestBody: | ||
| content: | ||
| application/json: | ||
| schema: | ||
| properties: | ||
| title: | ||
| description: The title of the attachment | ||
| example: Title of the attachment | ||
| type: string | ||
| maxLength: 1024 | ||
| body: | ||
| description: The body of the attachment | ||
| example: Body of the attachment | ||
| type: string | ||
| maxLength: 262144 | ||
| required: | ||
| - title | ||
| - body | ||
| type: object | ||
| responses: | ||
| '200': | ||
| description: Response | ||
| content: | ||
| application/json: | ||
| schema: | ||
| title: ContentReferenceAttachment | ||
| description: Content Reference attachments allow you to provide context | ||
| around URLs posted in comments | ||
| type: object | ||
| properties: | ||
| id: | ||
| description: The ID of the attachment | ||
| example: 21 | ||
| type: integer | ||
| title: | ||
| description: The title of the attachment | ||
| example: Title of the attachment | ||
| type: string | ||
| maxLength: 1024 | ||
| body: | ||
| description: The body of the attachment | ||
| example: Body of the attachment | ||
| type: string | ||
| maxLength: 262144 | ||
| node_id: | ||
| description: The node_id of the content attachment | ||
| example: MDE3OkNvbnRlbnRBdHRhY2htZW50MjE= | ||
| type: string | ||
| required: | ||
| - id | ||
| - title | ||
| - body | ||
| examples: | ||
| default: | ||
| value: | ||
| id: 101 | ||
| title: "[A-1234] Error found in core/models.py file'" | ||
| body: |- | ||
| You have used an email that already exists for the user_email_uniq field. | ||
| ## DETAILS: | ||
|
|
||
| The (email)=([email protected]) already exists. | ||
|
|
||
| The error was found in core/models.py in get_or_create_user at line 62. | ||
|
|
||
| self.save() | ||
| '422': | ||
| description: Validation failed | ||
| content: *22 | ||
| '404': | ||
| description: Resource not found | ||
| content: *10 | ||
| '410': | ||
| description: Gone | ||
| content: *163 | ||
| '415': | ||
| description: Preview header missing | ||
| content: *13 | ||
| '304': | ||
| description: Not modified | ||
| '403': | ||
| description: Forbidden | ||
| content: *17 | ||
| x-github: | ||
| githubCloudOnly: false | ||
| enabledForGitHubApps: true | ||
| previews: | ||
| - required: true | ||
| name: corsair | ||
| note: |- | ||
| To access the Content Attachments API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header: | ||
| ```shell | ||
| application/vnd.github.corsair-preview+json | ||
| ``` | ||
| category: apps | ||
| subcategory: installations | ||
Oops, something went wrong.