Skip to content

Commit 61fa18d

Browse files
ahoglundahoglund
authored
Merge pull request #339 from github/openapi-update-1f60c6fd87784130e20ff80d49c0d1e1509141f30c0161d5866c815578de9526
Update OpenAPI Descriptions
2 parents a4797d3 + 194addb commit 61fa18d

36 files changed

Lines changed: 5040 additions & 972 deletions

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

Lines changed: 121 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -38974,6 +38974,113 @@
3897438974
}
3897538975
}
3897638976
},
38977+
"/repos/{owner}/{repo}/releases/{release_id}/reactions": {
38978+
"post": {
38979+
"summary": "Create reaction for a release",
38980+
"description": "Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases). A response with a `Status: 200 OK` means that you already added the reaction type to this release.",
38981+
"tags": [
38982+
"reactions"
38983+
],
38984+
"operationId": "reactions/create-for-release",
38985+
"externalDocs": {
38986+
"description": "API method documentation",
38987+
"url": "https://docs.github.com/rest/reference/reactions/#create-reaction-for-a-release"
38988+
},
38989+
"parameters": [
38990+
{
38991+
"$ref": "#/components/parameters/owner"
38992+
},
38993+
{
38994+
"$ref": "#/components/parameters/repo"
38995+
},
38996+
{
38997+
"$ref": "#/components/parameters/release_id"
38998+
}
38999+
],
39000+
"requestBody": {
39001+
"content": {
39002+
"application/json": {
39003+
"schema": {
39004+
"type": "object",
39005+
"properties": {
39006+
"content": {
39007+
"type": "string",
39008+
"description": "The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types) to add to the release.",
39009+
"enum": [
39010+
"+1",
39011+
"laugh",
39012+
"heart",
39013+
"hooray",
39014+
"rocket",
39015+
"eyes"
39016+
]
39017+
}
39018+
},
39019+
"required": [
39020+
"content"
39021+
]
39022+
},
39023+
"example": {
39024+
"content": "heart"
39025+
}
39026+
}
39027+
}
39028+
},
39029+
"responses": {
39030+
"200": {
39031+
"description": "Reaction exists",
39032+
"content": {
39033+
"application/json": {
39034+
"schema": {
39035+
"$ref": "#/components/schemas/reaction"
39036+
},
39037+
"examples": {
39038+
"default": {
39039+
"$ref": "#/components/examples/reaction"
39040+
}
39041+
}
39042+
}
39043+
}
39044+
},
39045+
"201": {
39046+
"description": "Reaction created",
39047+
"content": {
39048+
"application/json": {
39049+
"schema": {
39050+
"$ref": "#/components/schemas/reaction"
39051+
},
39052+
"examples": {
39053+
"default": {
39054+
"$ref": "#/components/examples/reaction"
39055+
}
39056+
}
39057+
}
39058+
}
39059+
},
39060+
"415": {
39061+
"$ref": "#/components/responses/preview_header_missing"
39062+
},
39063+
"422": {
39064+
"$ref": "#/components/responses/validation_failed"
39065+
}
39066+
},
39067+
"x-github": {
39068+
"githubCloudOnly": false,
39069+
"enabledForGitHubApps": true,
39070+
"previews": [
39071+
{
39072+
"required": true,
39073+
"name": "squirrel-girl",
39074+
"note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions."
39075+
}
39076+
],
39077+
"category": "reactions",
39078+
"subcategory": null
39079+
}
39080+
}
39081+
},
39082+
"/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": {
39083+
},
3897739084
"/repos/{owner}/{repo}/secret-scanning/alerts": {
3897839085
"get": {
3897939086
"summary": "List secret scanning alerts for a repository",
@@ -62354,19 +62461,11 @@
6235462461
"type": "string",
6235562462
"description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.",
6235662463
"nullable": true,
62357-
"oneOf": [
62358-
{
62359-
"enum": [
62360-
"false positive",
62361-
"won't fix",
62362-
"used in tests"
62363-
]
62364-
},
62365-
{
62366-
"enum": [
62367-
null
62368-
]
62369-
}
62464+
"enum": [
62465+
null,
62466+
"false positive",
62467+
"won't fix",
62468+
"used in tests"
6237062469
]
6237162470
},
6237262471
"code-scanning-alert-rule-summary": {
@@ -68891,6 +68990,9 @@
6889168990
"description": "The URL of the release discussion.",
6889268991
"type": "string",
6889368992
"format": "uri"
68993+
},
68994+
"reactions": {
68995+
"$ref": "#/components/schemas/reaction-rollup"
6889468996
}
6889568997
},
6889668998
"required": [
@@ -68925,20 +69027,12 @@
6892569027
"type": "string",
6892669028
"description": "**Required when the `state` is `resolved`.** The reason for resolving the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`.",
6892769029
"nullable": true,
68928-
"oneOf": [
68929-
{
68930-
"enum": [
68931-
"false_positive",
68932-
"wont_fix",
68933-
"revoked",
68934-
"used_in_tests"
68935-
]
68936-
},
68937-
{
68938-
"enum": [
68939-
null
68940-
]
68941-
}
69030+
"enum": [
69031+
null,
69032+
"false_positive",
69033+
"wont_fix",
69034+
"revoked",
69035+
"used_in_tests"
6894269036
]
6894369037
},
6894469038
"secret-scanning-alert": {

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

Lines changed: 90 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -27973,6 +27973,83 @@ paths:
2797327973
previews: []
2797427974
category: repos
2797527975
subcategory: releases
27976+
"/repos/{owner}/{repo}/releases/{release_id}/reactions":
27977+
post:
27978+
summary: Create reaction for a release
27979+
description: 'Create a reaction to a [release](https://docs.github.com/rest/reference/repos#releases).
27980+
A response with a `Status: 200 OK` means that you already added the reaction
27981+
type to this release.'
27982+
tags:
27983+
- reactions
27984+
operationId: reactions/create-for-release
27985+
externalDocs:
27986+
description: API method documentation
27987+
url: https://docs.github.com/rest/reference/reactions/#create-reaction-for-a-release
27988+
parameters:
27989+
- "$ref": "#/components/parameters/owner"
27990+
- "$ref": "#/components/parameters/repo"
27991+
- "$ref": "#/components/parameters/release_id"
27992+
requestBody:
27993+
content:
27994+
application/json:
27995+
schema:
27996+
type: object
27997+
properties:
27998+
content:
27999+
type: string
28000+
description: The [reaction type](https://docs.github.com/rest/reference/reactions#reaction-types)
28001+
to add to the release.
28002+
enum:
28003+
- "+1"
28004+
- laugh
28005+
- heart
28006+
- hooray
28007+
- rocket
28008+
- eyes
28009+
required:
28010+
- content
28011+
example:
28012+
content: heart
28013+
responses:
28014+
'200':
28015+
description: Reaction exists
28016+
content:
28017+
application/json:
28018+
schema:
28019+
"$ref": "#/components/schemas/reaction"
28020+
examples:
28021+
default:
28022+
"$ref": "#/components/examples/reaction"
28023+
'201':
28024+
description: Reaction created
28025+
content:
28026+
application/json:
28027+
schema:
28028+
"$ref": "#/components/schemas/reaction"
28029+
examples:
28030+
default:
28031+
"$ref": "#/components/examples/reaction"
28032+
'415':
28033+
"$ref": "#/components/responses/preview_header_missing"
28034+
'422':
28035+
"$ref": "#/components/responses/validation_failed"
28036+
x-github:
28037+
githubCloudOnly: false
28038+
enabledForGitHubApps: true
28039+
previews:
28040+
- required: true
28041+
name: squirrel-girl
28042+
note: |-
28043+
An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.
28044+
28045+
To access the API you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:
28046+
```shell
28047+
application/vnd.github.squirrel-girl-preview
28048+
```
28049+
The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/rest/reference/reactions) reactions.
28050+
category: reactions
28051+
subcategory:
28052+
"/repos/{owner}/{repo}/releases/{release_id}/reactions/{reaction_id}": {}
2797628053
"/repos/{owner}/{repo}/secret-scanning/alerts":
2797728054
get:
2797828055
summary: List secret scanning alerts for a repository
@@ -45244,13 +45321,11 @@ components:
4524445321
or closing the alert. Can be one of: `false positive`, `won't fix`, and `used
4524545322
in tests`."
4524645323
nullable: true
45247-
oneOf:
45248-
- enum:
45249-
- false positive
45250-
- won't fix
45251-
- used in tests
45252-
- enum:
45253-
-
45324+
enum:
45325+
-
45326+
- false positive
45327+
- won't fix
45328+
- used in tests
4525445329
code-scanning-alert-rule-summary:
4525545330
type: object
4525645331
properties:
@@ -50149,6 +50224,8 @@ components:
5014950224
description: The URL of the release discussion.
5015050225
type: string
5015150226
format: uri
50227+
reactions:
50228+
"$ref": "#/components/schemas/reaction-rollup"
5015250229
required:
5015350230
- assets_url
5015450231
- upload_url
@@ -50179,14 +50256,12 @@ components:
5017950256
description: "**Required when the `state` is `resolved`.** The reason for resolving
5018050257
the alert. Can be one of `false_positive`, `wont_fix`, `revoked`, or `used_in_tests`."
5018150258
nullable: true
50182-
oneOf:
50183-
- enum:
50184-
- false_positive
50185-
- wont_fix
50186-
- revoked
50187-
- used_in_tests
50188-
- enum:
50189-
-
50259+
enum:
50260+
-
50261+
- false_positive
50262+
- wont_fix
50263+
- revoked
50264+
- used_in_tests
5019050265
secret-scanning-alert:
5019150266
type: object
5019250267
properties:

0 commit comments

Comments
 (0)