Skip to content

Commit 0733eaa

Browse files
bearcherianbearcherian
authored
Merge pull request #1644 from github/openapi-update-6558e1a138ef6f53a63b0fc593963031b1b140157227a9fced9ef0a7b75b7847
Update OpenAPI 3.0 Descriptions
2 parents eb6ba5e + d48090d commit 0733eaa

8 files changed

Lines changed: 496 additions & 24 deletions

File tree

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

Lines changed: 55 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30809,10 +30809,36 @@
3080930809
"$ref": "#/components/parameters/direction"
3081030810
},
3081130811
{
30812-
"$ref": "#/components/parameters/page"
30812+
"name": "page",
30813+
"description": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.",
30814+
"deprecated": true,
30815+
"in": "query",
30816+
"schema": {
30817+
"type": "integer",
30818+
"default": 1
30819+
}
3081330820
},
3081430821
{
30815-
"$ref": "#/components/parameters/per-page"
30822+
"name": "per_page",
30823+
"description": "**Deprecated**. The number of results per page (max 100). Use cursor-based pagination with `first` or `last` instead.",
30824+
"deprecated": true,
30825+
"in": "query",
30826+
"schema": {
30827+
"type": "integer",
30828+
"default": 30
30829+
}
30830+
},
30831+
{
30832+
"$ref": "#/components/parameters/pagination-before"
30833+
},
30834+
{
30835+
"$ref": "#/components/parameters/pagination-after"
30836+
},
30837+
{
30838+
"$ref": "#/components/parameters/pagination-first"
30839+
},
30840+
{
30841+
"$ref": "#/components/parameters/pagination-last"
3081630842
}
3081730843
],
3081830844
"responses": {
@@ -30837,6 +30863,9 @@
3083730863
"304": {
3083830864
"$ref": "#/components/responses/not_modified"
3083930865
},
30866+
"400": {
30867+
"$ref": "#/components/responses/bad_request"
30868+
},
3084030869
"403": {
3084130870
"$ref": "#/components/responses/forbidden"
3084230871
},
@@ -110572,7 +110601,7 @@
110572110601
"dependabot-alert-comma-separated-ecosystems": {
110573110602
"name": "ecosystem",
110574110603
"in": "query",
110575-
"description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `rubygems`, `rust`",
110604+
"description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`",
110576110605
"schema": {
110577110606
"type": "string"
110578110607
}
@@ -110618,6 +110647,29 @@
110618110647
"default": "created"
110619110648
}
110620110649
},
110650+
"pagination-first": {
110651+
"name": "first",
110652+
"description": "The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.",
110653+
"in": "query",
110654+
"required": false,
110655+
"schema": {
110656+
"type": "integer",
110657+
"minimum": 1,
110658+
"maximum": 100,
110659+
"default": 30
110660+
}
110661+
},
110662+
"pagination-last": {
110663+
"name": "last",
110664+
"description": "The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.",
110665+
"in": "query",
110666+
"required": false,
110667+
"schema": {
110668+
"type": "integer",
110669+
"minimum": 1,
110670+
"maximum": 100
110671+
}
110672+
},
110621110673
"dependabot-alert-number": {
110622110674
"name": "alert_number",
110623110675
"in": "path",

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

Lines changed: 46 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22411,8 +22411,26 @@ paths:
2241122411
- "$ref": "#/components/parameters/dependabot-alert-scope"
2241222412
- "$ref": "#/components/parameters/dependabot-alert-sort"
2241322413
- "$ref": "#/components/parameters/direction"
22414-
- "$ref": "#/components/parameters/page"
22415-
- "$ref": "#/components/parameters/per-page"
22414+
- name: page
22415+
description: "**Deprecated**. Page number of the results to fetch. Use cursor-based
22416+
pagination with `before` or `after` instead."
22417+
deprecated: true
22418+
in: query
22419+
schema:
22420+
type: integer
22421+
default: 1
22422+
- name: per_page
22423+
description: "**Deprecated**. The number of results per page (max 100). Use
22424+
cursor-based pagination with `first` or `last` instead."
22425+
deprecated: true
22426+
in: query
22427+
schema:
22428+
type: integer
22429+
default: 30
22430+
- "$ref": "#/components/parameters/pagination-before"
22431+
- "$ref": "#/components/parameters/pagination-after"
22432+
- "$ref": "#/components/parameters/pagination-first"
22433+
- "$ref": "#/components/parameters/pagination-last"
2241622434
responses:
2241722435
'200':
2241822436
description: Response
@@ -22427,6 +22445,8 @@ paths:
2242722445
"$ref": "#/components/examples/dependabot-alerts"
2242822446
'304':
2242922447
"$ref": "#/components/responses/not_modified"
22448+
'400':
22449+
"$ref": "#/components/responses/bad_request"
2243022450
'403':
2243122451
"$ref": "#/components/responses/forbidden"
2243222452
'404':
@@ -85319,7 +85339,7 @@ components:
8531985339
description: |-
8532085340
A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.
8532185341

85322-
Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `rubygems`, `rust`
85342+
Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`
8532385343
schema:
8532485344
type: string
8532585345
dependabot-alert-comma-separated-packages:
@@ -85359,6 +85379,29 @@ components:
8535985379
- created
8536085380
- updated
8536185381
default: created
85382+
pagination-first:
85383+
name: first
85384+
description: |-
85385+
The number of results per page (max 100), starting from the first matching result.
85386+
This parameter must not be used in combination with `last`.
85387+
in: query
85388+
required: false
85389+
schema:
85390+
type: integer
85391+
minimum: 1
85392+
maximum: 100
85393+
default: 30
85394+
pagination-last:
85395+
name: last
85396+
description: |-
85397+
The number of results per page (max 100), starting from the last matching result.
85398+
This parameter must not be used in combination with `first`.
85399+
in: query
85400+
required: false
85401+
schema:
85402+
type: integer
85403+
minimum: 1
85404+
maximum: 100
8536285405
dependabot-alert-number:
8536385406
name: alert_number
8536485407
in: path

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

Lines changed: 106 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -207480,7 +207480,7 @@
207480207480
{
207481207481
"name": "ecosystem",
207482207482
"in": "query",
207483-
"description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `rubygems`, `rust`",
207483+
"description": "A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.\n\nCan be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`",
207484207484
"schema": {
207485207485
"type": "string"
207486207486
}
@@ -207542,7 +207542,8 @@
207542207542
},
207543207543
{
207544207544
"name": "page",
207545-
"description": "Page number of the results to fetch.",
207545+
"description": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.",
207546+
"deprecated": true,
207546207547
"in": "query",
207547207548
"schema": {
207548207549
"type": "integer",
@@ -207551,12 +207552,54 @@
207551207552
},
207552207553
{
207553207554
"name": "per_page",
207554-
"description": "The number of results per page (max 100).",
207555+
"description": "**Deprecated**. The number of results per page (max 100). Use cursor-based pagination with `first` or `last` instead.",
207556+
"deprecated": true,
207557+
"in": "query",
207558+
"schema": {
207559+
"type": "integer",
207560+
"default": 30
207561+
}
207562+
},
207563+
{
207564+
"name": "before",
207565+
"description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results before this cursor.",
207566+
"in": "query",
207567+
"required": false,
207568+
"schema": {
207569+
"type": "string"
207570+
}
207571+
},
207572+
{
207573+
"name": "after",
207574+
"description": "A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results after this cursor.",
207575+
"in": "query",
207576+
"required": false,
207577+
"schema": {
207578+
"type": "string"
207579+
}
207580+
},
207581+
{
207582+
"name": "first",
207583+
"description": "The number of results per page (max 100), starting from the first matching result.\nThis parameter must not be used in combination with `last`.",
207555207584
"in": "query",
207585+
"required": false,
207556207586
"schema": {
207557207587
"type": "integer",
207588+
"minimum": 1,
207589+
"maximum": 100,
207558207590
"default": 30
207559207591
}
207592+
},
207593+
{
207594+
"name": "last",
207595+
"description": "The number of results per page (max 100), starting from the last matching result.\nThis parameter must not be used in combination with `first`.",
207596+
"in": "query",
207597+
"required": false,
207598+
"schema": {
207599+
"type": "integer",
207600+
"minimum": 1,
207601+
"maximum": 100
207602+
}
207560207603
}
207561207604
],
207562207605
"responses": {
@@ -208390,6 +208433,66 @@
208390208433
"304": {
208391208434
"description": "Not modified"
208392208435
},
208436+
"400": {
208437+
"description": "Bad Request",
208438+
"content": {
208439+
"application/json": {
208440+
"schema": {
208441+
"title": "Basic Error",
208442+
"description": "Basic Error",
208443+
"type": "object",
208444+
"properties": {
208445+
"message": {
208446+
"type": "string"
208447+
},
208448+
"documentation_url": {
208449+
"type": "string"
208450+
},
208451+
"url": {
208452+
"type": "string"
208453+
},
208454+
"status": {
208455+
"type": "string"
208456+
}
208457+
}
208458+
}
208459+
},
208460+
"application/scim+json": {
208461+
"schema": {
208462+
"title": "Scim Error",
208463+
"description": "Scim Error",
208464+
"type": "object",
208465+
"properties": {
208466+
"message": {
208467+
"type": "string",
208468+
"nullable": true
208469+
},
208470+
"documentation_url": {
208471+
"type": "string",
208472+
"nullable": true
208473+
},
208474+
"detail": {
208475+
"type": "string",
208476+
"nullable": true
208477+
},
208478+
"status": {
208479+
"type": "integer"
208480+
},
208481+
"scimType": {
208482+
"type": "string",
208483+
"nullable": true
208484+
},
208485+
"schemas": {
208486+
"type": "array",
208487+
"items": {
208488+
"type": "string"
208489+
}
208490+
}
208491+
}
208492+
}
208493+
}
208494+
}
208495+
},
208393208496
"403": {
208394208497
"description": "Forbidden",
208395208498
"content": {

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

Lines changed: 41 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47619,7 +47619,7 @@ paths:
4761947619
description: |-
4762047620
A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.
4762147621

47622-
Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `rubygems`, `rust`
47622+
Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`
4762347623
schema:
4762447624
type: string
4762547625
- name: package
@@ -47656,8 +47656,45 @@ paths:
4765647656
- updated
4765747657
default: created
4765847658
- *55
47659-
- *32
47660-
- *12
47659+
- name: page
47660+
description: "**Deprecated**. Page number of the results to fetch. Use cursor-based
47661+
pagination with `before` or `after` instead."
47662+
deprecated: true
47663+
in: query
47664+
schema:
47665+
type: integer
47666+
default: 1
47667+
- name: per_page
47668+
description: "**Deprecated**. The number of results per page (max 100). Use
47669+
cursor-based pagination with `first` or `last` instead."
47670+
deprecated: true
47671+
in: query
47672+
schema:
47673+
type: integer
47674+
default: 30
47675+
- *56
47676+
- *57
47677+
- name: first
47678+
description: |-
47679+
The number of results per page (max 100), starting from the first matching result.
47680+
This parameter must not be used in combination with `last`.
47681+
in: query
47682+
required: false
47683+
schema:
47684+
type: integer
47685+
minimum: 1
47686+
maximum: 100
47687+
default: 30
47688+
- name: last
47689+
description: |-
47690+
The number of results per page (max 100), starting from the last matching result.
47691+
This parameter must not be used in combination with `first`.
47692+
in: query
47693+
required: false
47694+
schema:
47695+
type: integer
47696+
minimum: 1
47697+
maximum: 100
4766147698
responses:
4766247699
'200':
4766347700
description: Response
@@ -48133,6 +48170,7 @@ paths:
4813348170
dismissed_comment:
4813448171
fixed_at:
4813548172
'304': *27
48173+
'400': *9
4813648174
'403': *24
4813748175
'404': *16
4813848176
'422': *51

0 commit comments

Comments
 (0)