Skip to content

Commit ee975e6

Browse files
author
Marc-Andre Giroux
authored
Merge pull request #370 from github/openapi-update-6818ba6ee2d899c9210a331a41d561dd6900f3efb597fb024237882390cd5653
Update OpenAPI Descriptions
2 parents 767d136 + 322ee28 commit ee975e6

36 files changed

+257108
-275839
lines changed

descriptions/api.github.com/api.github.com.json

Lines changed: 179 additions & 179 deletions
Large diffs are not rendered by default.

descriptions/api.github.com/api.github.com.yaml

Lines changed: 151 additions & 151 deletions
Large diffs are not rendered by default.

descriptions/api.github.com/dereferenced/api.github.com.deref.json

Lines changed: 335 additions & 335 deletions
Large diffs are not rendered by default.

descriptions/api.github.com/dereferenced/api.github.com.deref.yaml

Lines changed: 150 additions & 150 deletions
Original file line numberDiff line numberDiff line change
@@ -2203,7 +2203,7 @@ paths:
22032203
examples:
22042204
default:
22052205
value:
2206-
token: v1.1f699f1069f60xxx
2206+
token: ghs_16C7e42F292c6912E7710c838347Ae178B4a
22072207
expires_at: '2016-07-11T22:14:10Z'
22082208
permissions:
22092209
issues: write
@@ -2946,8 +2946,8 @@ paths:
29462946
scopes:
29472947
- public_repo
29482948
- user
2949-
token: abcdefgh12345678
2950-
token_last_eight: '12345678'
2949+
token: ghu_16C7e42F292c6912E7710c838347Ae178B4a
2950+
token_last_eight: Ae178B4a
29512951
hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8
29522952
app:
29532953
url: http://my-github-app.com
@@ -3176,8 +3176,8 @@ paths:
31763176
id: 1
31773177
url: https://api.github.com/authorizations/1
31783178
scopes: []
3179-
token: abcdefgh12345678
3180-
token_last_eight: '12345678'
3179+
token: ghu_16C7e42F292c6912E7710c838347Ae178B4a
3180+
token_last_eight: Ae178B4a
31813181
hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8
31823182
app:
31833183
url: http://my-github-app.com
@@ -3491,8 +3491,8 @@ paths:
34913491
url: https://api.github.com/authorizations/1
34923492
scopes:
34933493
- public_repo
3494-
token: ''
3495-
token_last_eight: '12345678'
3494+
token: ghu_16C7e42F292c6912E7710c838347Ae178B4a
3495+
token_last_eight: Ae178B4a
34963496
hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8
34973497
app:
34983498
url: http://my-github-app.com
@@ -3603,8 +3603,8 @@ paths:
36033603
url: https://api.github.com/authorizations/1
36043604
scopes:
36053605
- public_repo
3606-
token: abcdefgh12345678
3607-
token_last_eight: '12345678'
3606+
token: ghu_16C7e42F292c6912E7710c838347Ae178B4a
3607+
token_last_eight: Ae178B4a
36083608
hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8
36093609
app:
36103610
url: http://my-github-app.com
@@ -3726,8 +3726,8 @@ paths:
37263726
url: https://api.github.com/authorizations/1
37273727
scopes:
37283728
- public_repo
3729-
token: ''
3730-
token_last_eight: '12345678'
3729+
token: ghu_16C7e42F292c6912E7710c838347Ae178B4a
3730+
token_last_eight: Ae178B4a
37313731
hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8
37323732
app:
37333733
url: http://my-github-app.com
@@ -3865,8 +3865,8 @@ paths:
38653865
url: https://api.github.com/authorizations/1
38663866
scopes:
38673867
- public_repo
3868-
token: ''
3869-
token_last_eight: '12345678'
3868+
token: ghu_16C7e42F292c6912E7710c838347Ae178B4a
3869+
token_last_eight: Ae178B4a
38703870
hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8
38713871
app:
38723872
url: http://my-github-app.com
@@ -3900,8 +3900,8 @@ paths:
39003900
url: https://api.github.com/authorizations/1
39013901
scopes:
39023902
- public_repo
3903-
token: abcdefgh12345678
3904-
token_last_eight: '12345678'
3903+
token: ghu_16C7e42F292c6912E7710c838347Ae178B4a
3904+
token_last_eight: Ae178B4a
39053905
hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8
39063906
app:
39073907
url: http://my-github-app.com
@@ -3971,8 +3971,8 @@ paths:
39713971
url: https://api.github.com/authorizations/1
39723972
scopes:
39733973
- public_repo
3974-
token: ''
3975-
token_last_eight: '12345678'
3974+
token: ghu_16C7e42F292c6912E7710c838347Ae178B4a
3975+
token_last_eight: Ae178B4a
39763976
hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8
39773977
app:
39783978
url: http://my-github-app.com
@@ -14932,7 +14932,7 @@ paths:
1493214932
- login: hubot
1493314933
credential_id: 161196
1493414934
credential_type: personal access token
14935-
token_last_eight: '12345678'
14935+
token_last_eight: Ae178B4a
1493614936
credential_authorized_at: '2019-03-29T19:06:43Z'
1493714937
scopes:
1493814938
- repo
@@ -43092,6 +43092,138 @@ paths:
4309243092
previews: []
4309343093
category: repos
4309443094
subcategory: commits
43095+
"/repos/{owner}/{repo}/content_references/{content_reference_id}/attachments":
43096+
post:
43097+
summary: Create a content attachment
43098+
description: |-
43099+
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.
43100+
43101+
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.
43102+
43103+
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.
43104+
tags:
43105+
- apps
43106+
operationId: apps/create-content-attachment
43107+
externalDocs:
43108+
description: API method documentation
43109+
url: https://docs.github.com/rest/reference/apps#create-a-content-attachment
43110+
parameters:
43111+
- name: owner
43112+
description: The owner of the repository. Determined from the `repository`
43113+
`full_name` of the `content_reference` event.
43114+
in: path
43115+
required: true
43116+
schema:
43117+
type: string
43118+
- name: repo
43119+
description: The name of the repository. Determined from the `repository`
43120+
`full_name` of the `content_reference` event.
43121+
in: path
43122+
required: true
43123+
schema:
43124+
type: string
43125+
- name: content_reference_id
43126+
description: The `id` of the `content_reference` event.
43127+
in: path
43128+
required: true
43129+
schema:
43130+
type: integer
43131+
requestBody:
43132+
content:
43133+
application/json:
43134+
schema:
43135+
properties:
43136+
title:
43137+
description: The title of the attachment
43138+
example: Title of the attachment
43139+
type: string
43140+
maxLength: 1024
43141+
body:
43142+
description: The body of the attachment
43143+
example: Body of the attachment
43144+
type: string
43145+
maxLength: 262144
43146+
required:
43147+
- title
43148+
- body
43149+
type: object
43150+
responses:
43151+
'200':
43152+
description: Response
43153+
content:
43154+
application/json:
43155+
schema:
43156+
title: ContentReferenceAttachment
43157+
description: Content Reference attachments allow you to provide context
43158+
around URLs posted in comments
43159+
type: object
43160+
properties:
43161+
id:
43162+
description: The ID of the attachment
43163+
example: 21
43164+
type: integer
43165+
title:
43166+
description: The title of the attachment
43167+
example: Title of the attachment
43168+
type: string
43169+
maxLength: 1024
43170+
body:
43171+
description: The body of the attachment
43172+
example: Body of the attachment
43173+
type: string
43174+
maxLength: 262144
43175+
node_id:
43176+
description: The node_id of the content attachment
43177+
example: MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=
43178+
type: string
43179+
required:
43180+
- id
43181+
- title
43182+
- body
43183+
examples:
43184+
default:
43185+
value:
43186+
id: 101
43187+
title: "[A-1234] Error found in core/models.py file'"
43188+
body: |-
43189+
You have used an email that already exists for the user_email_uniq field.
43190+
## DETAILS:
43191+
43192+
The (email)=([email protected]) already exists.
43193+
43194+
The error was found in core/models.py in get_or_create_user at line 62.
43195+
43196+
self.save()
43197+
'422':
43198+
description: Validation failed
43199+
content: *22
43200+
'404':
43201+
description: Resource not found
43202+
content: *10
43203+
'410':
43204+
description: Gone
43205+
content: *163
43206+
'415':
43207+
description: Preview header missing
43208+
content: *13
43209+
'304':
43210+
description: Not modified
43211+
'403':
43212+
description: Forbidden
43213+
content: *17
43214+
x-github:
43215+
githubCloudOnly: false
43216+
enabledForGitHubApps: true
43217+
previews:
43218+
- required: true
43219+
name: corsair
43220+
note: |-
43221+
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:
43222+
```shell
43223+
application/vnd.github.corsair-preview+json
43224+
```
43225+
category: apps
43226+
subcategory: installations
4309543227
"/repos/{owner}/{repo}/contents/{path}":
4309643228
get:
4309743229
summary: Get repository content
@@ -79224,135 +79356,3 @@ paths:
7922479356
enabledForGitHubApps: true
7922579357
previews: []
7922679358
category: meta
79227-
"/{owner}/{repo}/content_references/{content_reference_id}/attachments":
79228-
post:
79229-
summary: Create a content attachment
79230-
description: |-
79231-
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.
79232-
79233-
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.
79234-
79235-
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.
79236-
tags:
79237-
- apps
79238-
operationId: apps/create-content-attachment
79239-
externalDocs:
79240-
description: API method documentation
79241-
url: https://docs.github.com/rest/reference/apps#create-a-content-attachment
79242-
parameters:
79243-
- name: owner
79244-
description: The owner of the repository. Determined from the `repository`
79245-
`full_name` of the `content_reference` event.
79246-
in: path
79247-
required: true
79248-
schema:
79249-
type: string
79250-
- name: repo
79251-
description: The name of the repository. Determined from the `repository`
79252-
`full_name` of the `content_reference` event.
79253-
in: path
79254-
required: true
79255-
schema:
79256-
type: string
79257-
- name: content_reference_id
79258-
description: The `id` of the `content_reference` event.
79259-
in: path
79260-
required: true
79261-
schema:
79262-
type: integer
79263-
requestBody:
79264-
content:
79265-
application/json:
79266-
schema:
79267-
properties:
79268-
title:
79269-
description: The title of the attachment
79270-
example: Title of the attachment
79271-
type: string
79272-
maxLength: 1024
79273-
body:
79274-
description: The body of the attachment
79275-
example: Body of the attachment
79276-
type: string
79277-
maxLength: 262144
79278-
required:
79279-
- title
79280-
- body
79281-
type: object
79282-
responses:
79283-
'200':
79284-
description: Response
79285-
content:
79286-
application/json:
79287-
schema:
79288-
title: ContentReferenceAttachment
79289-
description: Content Reference attachments allow you to provide context
79290-
around URLs posted in comments
79291-
type: object
79292-
properties:
79293-
id:
79294-
description: The ID of the attachment
79295-
example: 21
79296-
type: integer
79297-
title:
79298-
description: The title of the attachment
79299-
example: Title of the attachment
79300-
type: string
79301-
maxLength: 1024
79302-
body:
79303-
description: The body of the attachment
79304-
example: Body of the attachment
79305-
type: string
79306-
maxLength: 262144
79307-
node_id:
79308-
description: The node_id of the content attachment
79309-
example: MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=
79310-
type: string
79311-
required:
79312-
- id
79313-
- title
79314-
- body
79315-
examples:
79316-
default:
79317-
value:
79318-
id: 101
79319-
title: "[A-1234] Error found in core/models.py file'"
79320-
body: |-
79321-
You have used an email that already exists for the user_email_uniq field.
79322-
## DETAILS:
79323-
79324-
The (email)=([email protected]) already exists.
79325-
79326-
The error was found in core/models.py in get_or_create_user at line 62.
79327-
79328-
self.save()
79329-
'422':
79330-
description: Validation failed
79331-
content: *22
79332-
'404':
79333-
description: Resource not found
79334-
content: *10
79335-
'410':
79336-
description: Gone
79337-
content: *163
79338-
'415':
79339-
description: Preview header missing
79340-
content: *13
79341-
'304':
79342-
description: Not modified
79343-
'403':
79344-
description: Forbidden
79345-
content: *17
79346-
x-github:
79347-
githubCloudOnly: false
79348-
enabledForGitHubApps: true
79349-
previews:
79350-
- required: true
79351-
name: corsair
79352-
note: |-
79353-
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:
79354-
```shell
79355-
application/vnd.github.corsair-preview+json
79356-
```
79357-
category: apps
79358-
subcategory: installations

0 commit comments

Comments
 (0)