Skip to content

Commit 631cabe

Browse files
ahoglundahoglund
authored
Merge pull request #346 from github/openapi-update-be45da1cf2a799ecec7bf4df0736fa81a46332ebe865a2d6150d94a530ae328b
Update OpenAPI Descriptions
2 parents 61fa18d + d373c8e commit 631cabe

36 files changed

+12512
-14090
lines changed

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

Lines changed: 161 additions & 142 deletions
Original file line numberDiff line numberDiff line change
@@ -2450,105 +2450,6 @@
24502450
}
24512451
}
24522452
},
2453-
"/content_references/{content_reference_id}/attachments": {
2454-
"post": {
2455-
"summary": "Create a content attachment",
2456-
"description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://docs.github.com/webhooks/event-payloads/#content_reference) to create an attachment.\n\nThe 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.\n\nYou 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.",
2457-
"tags": [
2458-
"apps"
2459-
],
2460-
"operationId": "apps/create-content-attachment",
2461-
"externalDocs": {
2462-
"description": "API method documentation",
2463-
"url": "https://docs.github.com/rest/reference/apps#create-a-content-attachment"
2464-
},
2465-
"parameters": [
2466-
{
2467-
"name": "content_reference_id",
2468-
"in": "path",
2469-
"required": true,
2470-
"schema": {
2471-
"type": "integer"
2472-
}
2473-
}
2474-
],
2475-
"requestBody": {
2476-
"content": {
2477-
"application/json": {
2478-
"schema": {
2479-
"properties": {
2480-
"title": {
2481-
"description": "The title of the attachment",
2482-
"example": "Title of the attachment",
2483-
"type": "string",
2484-
"maxLength": 1024
2485-
},
2486-
"body": {
2487-
"description": "The body of the attachment",
2488-
"example": "Body of the attachment",
2489-
"type": "string",
2490-
"maxLength": 262144
2491-
}
2492-
},
2493-
"required": [
2494-
"title",
2495-
"body"
2496-
],
2497-
"type": "object"
2498-
}
2499-
}
2500-
}
2501-
},
2502-
"responses": {
2503-
"200": {
2504-
"description": "Response",
2505-
"content": {
2506-
"application/json": {
2507-
"schema": {
2508-
"$ref": "#/components/schemas/content-reference-attachment"
2509-
},
2510-
"examples": {
2511-
"default": {
2512-
"$ref": "#/components/examples/content-reference-attachment"
2513-
}
2514-
}
2515-
}
2516-
}
2517-
},
2518-
"422": {
2519-
"$ref": "#/components/responses/validation_failed"
2520-
},
2521-
"404": {
2522-
"$ref": "#/components/responses/not_found"
2523-
},
2524-
"410": {
2525-
"$ref": "#/components/responses/gone"
2526-
},
2527-
"415": {
2528-
"$ref": "#/components/responses/preview_header_missing"
2529-
},
2530-
"304": {
2531-
"$ref": "#/components/responses/not_modified"
2532-
},
2533-
"403": {
2534-
"$ref": "#/components/responses/forbidden"
2535-
}
2536-
},
2537-
"x-github": {
2538-
"githubCloudOnly": false,
2539-
"enabledForGitHubApps": true,
2540-
"previews": [
2541-
{
2542-
"required": true,
2543-
"name": "corsair",
2544-
"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:\n```shell\napplication/vnd.github.corsair-preview+json\n```"
2545-
}
2546-
],
2547-
"category": "apps",
2548-
"subcategory": "installations"
2549-
}
2550-
}
2551-
},
25522453
"/emojis": {
25532454
"get": {
25542455
"summary": "Get emojis",
@@ -7457,7 +7358,7 @@
74577358
"get": {
74587359
"summary": "Get GitHub Actions permissions for an organization",
74597360
"description": "Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.",
7460-
"operationId": "actions/actions-policies/get-github-actions-permissions-organization",
7361+
"operationId": "actions/get-github-actions-permissions-organization",
74617362
"tags": [
74627363
"actions"
74637364
],
@@ -40883,7 +40784,7 @@
4088340784
"/repositories": {
4088440785
"get": {
4088540786
"summary": "List public repositories",
40886-
"description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
40787+
"description": "Lists all public repositories in the order that they were created.\n\nNote:\n- For GitHub Enterprise Server, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.",
4088740788
"tags": [
4088840789
"repos"
4088940790
],
@@ -51777,6 +51678,124 @@
5177751678
"category": "meta"
5177851679
}
5177951680
}
51681+
},
51682+
"/{owner}/{repo}/content_references/{content_reference_id}/attachments": {
51683+
"post": {
51684+
"summary": "Create a content attachment",
51685+
"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.\n\nThe 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.\n\nYou 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.",
51686+
"tags": [
51687+
"apps"
51688+
],
51689+
"operationId": "apps/create-content-attachment",
51690+
"externalDocs": {
51691+
"description": "API method documentation",
51692+
"url": "https://docs.github.com/rest/reference/apps#create-a-content-attachment"
51693+
},
51694+
"parameters": [
51695+
{
51696+
"name": "owner",
51697+
"description": "The owner of the repository. Determined from the `repository` `full_name` of the `content_reference` event.",
51698+
"in": "path",
51699+
"required": true,
51700+
"schema": {
51701+
"type": "string"
51702+
}
51703+
},
51704+
{
51705+
"name": "repo",
51706+
"description": "The name of the repository. Determined from the `repository` `full_name` of the `content_reference` event.",
51707+
"in": "path",
51708+
"required": true,
51709+
"schema": {
51710+
"type": "string"
51711+
}
51712+
},
51713+
{
51714+
"name": "content_reference_id",
51715+
"description": "The `id` of the `content_reference` event.",
51716+
"in": "path",
51717+
"required": true,
51718+
"schema": {
51719+
"type": "integer"
51720+
}
51721+
}
51722+
],
51723+
"requestBody": {
51724+
"content": {
51725+
"application/json": {
51726+
"schema": {
51727+
"properties": {
51728+
"title": {
51729+
"description": "The title of the attachment",
51730+
"example": "Title of the attachment",
51731+
"type": "string",
51732+
"maxLength": 1024
51733+
},
51734+
"body": {
51735+
"description": "The body of the attachment",
51736+
"example": "Body of the attachment",
51737+
"type": "string",
51738+
"maxLength": 262144
51739+
}
51740+
},
51741+
"required": [
51742+
"title",
51743+
"body"
51744+
],
51745+
"type": "object"
51746+
}
51747+
}
51748+
}
51749+
},
51750+
"responses": {
51751+
"200": {
51752+
"description": "Response",
51753+
"content": {
51754+
"application/json": {
51755+
"schema": {
51756+
"$ref": "#/components/schemas/content-reference-attachment"
51757+
},
51758+
"examples": {
51759+
"default": {
51760+
"$ref": "#/components/examples/content-reference-attachment"
51761+
}
51762+
}
51763+
}
51764+
}
51765+
},
51766+
"422": {
51767+
"$ref": "#/components/responses/validation_failed"
51768+
},
51769+
"404": {
51770+
"$ref": "#/components/responses/not_found"
51771+
},
51772+
"410": {
51773+
"$ref": "#/components/responses/gone"
51774+
},
51775+
"415": {
51776+
"$ref": "#/components/responses/preview_header_missing"
51777+
},
51778+
"304": {
51779+
"$ref": "#/components/responses/not_modified"
51780+
},
51781+
"403": {
51782+
"$ref": "#/components/responses/forbidden"
51783+
}
51784+
},
51785+
"x-github": {
51786+
"githubCloudOnly": false,
51787+
"enabledForGitHubApps": true,
51788+
"previews": [
51789+
{
51790+
"required": true,
51791+
"name": "corsair",
51792+
"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:\n```shell\napplication/vnd.github.corsair-preview+json\n```"
51793+
}
51794+
],
51795+
"category": "apps",
51796+
"subcategory": "installations"
51797+
}
51798+
}
5178051799
}
5178151800
},
5178251801
"components": {
@@ -53857,40 +53876,6 @@
5385753876
"name"
5385853877
]
5385953878
},
53860-
"content-reference-attachment": {
53861-
"title": "ContentReferenceAttachment",
53862-
"description": "Content Reference attachments allow you to provide context around URLs posted in comments",
53863-
"type": "object",
53864-
"properties": {
53865-
"id": {
53866-
"description": "The ID of the attachment",
53867-
"example": 21,
53868-
"type": "integer"
53869-
},
53870-
"title": {
53871-
"description": "The title of the attachment",
53872-
"example": "Title of the attachment",
53873-
"type": "string",
53874-
"maxLength": 1024
53875-
},
53876-
"body": {
53877-
"description": "The body of the attachment",
53878-
"example": "Body of the attachment",
53879-
"type": "string",
53880-
"maxLength": 262144
53881-
},
53882-
"node_id": {
53883-
"description": "The node_id of the content attachment",
53884-
"example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=",
53885-
"type": "string"
53886-
}
53887-
},
53888-
"required": [
53889-
"id",
53890-
"title",
53891-
"body"
53892-
]
53893-
},
5389453879
"enabled-organizations": {
5389553880
"type": "string",
5389653881
"description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.",
@@ -72137,6 +72122,40 @@
7213772122
"key",
7213872123
"id"
7213972124
]
72125+
},
72126+
"content-reference-attachment": {
72127+
"title": "ContentReferenceAttachment",
72128+
"description": "Content Reference attachments allow you to provide context around URLs posted in comments",
72129+
"type": "object",
72130+
"properties": {
72131+
"id": {
72132+
"description": "The ID of the attachment",
72133+
"example": 21,
72134+
"type": "integer"
72135+
},
72136+
"title": {
72137+
"description": "The title of the attachment",
72138+
"example": "Title of the attachment",
72139+
"type": "string",
72140+
"maxLength": 1024
72141+
},
72142+
"body": {
72143+
"description": "The body of the attachment",
72144+
"example": "Body of the attachment",
72145+
"type": "string",
72146+
"maxLength": 262144
72147+
},
72148+
"node_id": {
72149+
"description": "The node_id of the content attachment",
72150+
"example": "MDE3OkNvbnRlbnRBdHRhY2htZW50MjE=",
72151+
"type": "string"
72152+
}
72153+
},
72154+
"required": [
72155+
"id",
72156+
"title",
72157+
"body"
72158+
]
7214072159
}
7214172160
},
7214272161
"examples": {
@@ -72791,13 +72810,6 @@
7279172810
"html_url": "http://contributor-covenant.org/version/1/4/"
7279272811
}
7279372812
},
72794-
"content-reference-attachment": {
72795-
"value": {
72796-
"id": 101,
72797-
"title": "[A-1234] Error found in core/models.py file'",
72798-
"body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=([email protected]) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()"
72799-
}
72800-
},
7280172813
"actions-enterprise-permissions": {
7280272814
"value": {
7280372815
"enabled_organizations": "all",
@@ -91539,6 +91551,13 @@
9153991551
"updated_at": "2014-03-03T18:58:10Z"
9154091552
}
9154191553
]
91554+
},
91555+
"content-reference-attachment": {
91556+
"value": {
91557+
"id": 101,
91558+
"title": "[A-1234] Error found in core/models.py file'",
91559+
"body": "You have used an email that already exists for the user_email_uniq field.\n ## DETAILS:\n\nThe (email)=([email protected]) already exists.\n\n The error was found in core/models.py in get_or_create_user at line 62.\n\n self.save()"
91560+
}
9154291561
}
9154391562
},
9154491563
"responses": {

0 commit comments

Comments
 (0)