Skip to content

Commit b0b3903

Browse files
bearcherianbearcherian
authored
Merge pull request #1645 from github/openapi-update-c5e7db12676eb9118762668505fdf711ecd1bb3f5d086847413dae264601e5ef
Update OpenAPI 3.1 Descriptions
2 parents 0733eaa + 60cb257 commit b0b3903

8 files changed

Lines changed: 512 additions & 24 deletions

File tree

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

Lines changed: 55 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30961,10 +30961,36 @@
3096130961
"$ref": "#/components/parameters/direction"
3096230962
},
3096330963
{
30964-
"$ref": "#/components/parameters/page"
30964+
"name": "page",
30965+
"description": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.",
30966+
"deprecated": true,
30967+
"in": "query",
30968+
"schema": {
30969+
"type": "integer",
30970+
"default": 1
30971+
}
3096530972
},
3096630973
{
30967-
"$ref": "#/components/parameters/per-page"
30974+
"name": "per_page",
30975+
"description": "**Deprecated**. The number of results per page (max 100). Use cursor-based pagination with `first` or `last` instead.",
30976+
"deprecated": true,
30977+
"in": "query",
30978+
"schema": {
30979+
"type": "integer",
30980+
"default": 30
30981+
}
30982+
},
30983+
{
30984+
"$ref": "#/components/parameters/pagination-before"
30985+
},
30986+
{
30987+
"$ref": "#/components/parameters/pagination-after"
30988+
},
30989+
{
30990+
"$ref": "#/components/parameters/pagination-first"
30991+
},
30992+
{
30993+
"$ref": "#/components/parameters/pagination-last"
3096830994
}
3096930995
],
3097030996
"responses": {
@@ -30989,6 +31015,9 @@
3098931015
"304": {
3099031016
"$ref": "#/components/responses/not_modified"
3099131017
},
31018+
"400": {
31019+
"$ref": "#/components/responses/bad_request"
31020+
},
3099231021
"403": {
3099331022
"$ref": "#/components/responses/forbidden"
3099431023
},
@@ -113353,7 +113382,7 @@
113353113382
"dependabot-alert-comma-separated-ecosystems": {
113354113383
"name": "ecosystem",
113355113384
"in": "query",
113356-
"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`",
113385+
"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`",
113357113386
"schema": {
113358113387
"type": "string"
113359113388
}
@@ -113399,6 +113428,29 @@
113399113428
"default": "created"
113400113429
}
113401113430
},
113431+
"pagination-first": {
113432+
"name": "first",
113433+
"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`.",
113434+
"in": "query",
113435+
"required": false,
113436+
"schema": {
113437+
"type": "integer",
113438+
"minimum": 1,
113439+
"maximum": 100,
113440+
"default": 30
113441+
}
113442+
},
113443+
"pagination-last": {
113444+
"name": "last",
113445+
"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`.",
113446+
"in": "query",
113447+
"required": false,
113448+
"schema": {
113449+
"type": "integer",
113450+
"minimum": 1,
113451+
"maximum": 100
113452+
}
113453+
},
113402113454
"dependabot-alert-number": {
113403113455
"name": "alert_number",
113404113456
"in": "path",

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

Lines changed: 46 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22484,8 +22484,26 @@ paths:
2248422484
- "$ref": "#/components/parameters/dependabot-alert-scope"
2248522485
- "$ref": "#/components/parameters/dependabot-alert-sort"
2248622486
- "$ref": "#/components/parameters/direction"
22487-
- "$ref": "#/components/parameters/page"
22488-
- "$ref": "#/components/parameters/per-page"
22487+
- name: page
22488+
description: "**Deprecated**. Page number of the results to fetch. Use cursor-based
22489+
pagination with `before` or `after` instead."
22490+
deprecated: true
22491+
in: query
22492+
schema:
22493+
type: integer
22494+
default: 1
22495+
- name: per_page
22496+
description: "**Deprecated**. The number of results per page (max 100). Use
22497+
cursor-based pagination with `first` or `last` instead."
22498+
deprecated: true
22499+
in: query
22500+
schema:
22501+
type: integer
22502+
default: 30
22503+
- "$ref": "#/components/parameters/pagination-before"
22504+
- "$ref": "#/components/parameters/pagination-after"
22505+
- "$ref": "#/components/parameters/pagination-first"
22506+
- "$ref": "#/components/parameters/pagination-last"
2248922507
responses:
2249022508
'200':
2249122509
description: Response
@@ -22500,6 +22518,8 @@ paths:
2250022518
"$ref": "#/components/examples/dependabot-alerts"
2250122519
'304':
2250222520
"$ref": "#/components/responses/not_modified"
22521+
'400':
22522+
"$ref": "#/components/responses/bad_request"
2250322523
'403':
2250422524
"$ref": "#/components/responses/forbidden"
2250522525
'404':
@@ -85845,7 +85865,7 @@ components:
8584585865
description: |-
8584685866
A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned.
8584785867

85848-
Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `rubygems`, `rust`
85868+
Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`
8584985869
schema:
8585085870
type: string
8585185871
dependabot-alert-comma-separated-packages:
@@ -85885,6 +85905,29 @@ components:
8588585905
- created
8588685906
- updated
8588785907
default: created
85908+
pagination-first:
85909+
name: first
85910+
description: |-
85911+
The number of results per page (max 100), starting from the first matching result.
85912+
This parameter must not be used in combination with `last`.
85913+
in: query
85914+
required: false
85915+
schema:
85916+
type: integer
85917+
minimum: 1
85918+
maximum: 100
85919+
default: 30
85920+
pagination-last:
85921+
name: last
85922+
description: |-
85923+
The number of results per page (max 100), starting from the last matching result.
85924+
This parameter must not be used in combination with `first`.
85925+
in: query
85926+
required: false
85927+
schema:
85928+
type: integer
85929+
minimum: 1
85930+
maximum: 100
8588885931
dependabot-alert-number:
8588985932
name: alert_number
8589085933
in: path

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

Lines changed: 114 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -243337,7 +243337,7 @@
243337243337
{
243338243338
"name": "ecosystem",
243339243339
"in": "query",
243340-
"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`",
243340+
"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`",
243341243341
"schema": {
243342243342
"type": "string"
243343243343
}
@@ -243399,7 +243399,8 @@
243399243399
},
243400243400
{
243401243401
"name": "page",
243402-
"description": "Page number of the results to fetch.",
243402+
"description": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.",
243403+
"deprecated": true,
243403243404
"in": "query",
243404243405
"schema": {
243405243406
"type": "integer",
@@ -243408,12 +243409,54 @@
243408243409
},
243409243410
{
243410243411
"name": "per_page",
243411-
"description": "The number of results per page (max 100).",
243412+
"description": "**Deprecated**. The number of results per page (max 100). Use cursor-based pagination with `first` or `last` instead.",
243413+
"deprecated": true,
243414+
"in": "query",
243415+
"schema": {
243416+
"type": "integer",
243417+
"default": 30
243418+
}
243419+
},
243420+
{
243421+
"name": "before",
243422+
"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.",
243423+
"in": "query",
243424+
"required": false,
243425+
"schema": {
243426+
"type": "string"
243427+
}
243428+
},
243429+
{
243430+
"name": "after",
243431+
"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.",
243432+
"in": "query",
243433+
"required": false,
243434+
"schema": {
243435+
"type": "string"
243436+
}
243437+
},
243438+
{
243439+
"name": "first",
243440+
"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`.",
243412243441
"in": "query",
243442+
"required": false,
243413243443
"schema": {
243414243444
"type": "integer",
243445+
"minimum": 1,
243446+
"maximum": 100,
243415243447
"default": 30
243416243448
}
243449+
},
243450+
{
243451+
"name": "last",
243452+
"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`.",
243453+
"in": "query",
243454+
"required": false,
243455+
"schema": {
243456+
"type": "integer",
243457+
"minimum": 1,
243458+
"maximum": 100
243459+
}
243417243460
}
243418243461
],
243419243462
"responses": {
@@ -244317,6 +244360,74 @@
244317244360
"304": {
244318244361
"description": "Not modified"
244319244362
},
244363+
"400": {
244364+
"description": "Bad Request",
244365+
"content": {
244366+
"application/json": {
244367+
"schema": {
244368+
"title": "Basic Error",
244369+
"description": "Basic Error",
244370+
"type": "object",
244371+
"properties": {
244372+
"message": {
244373+
"type": "string"
244374+
},
244375+
"documentation_url": {
244376+
"type": "string"
244377+
},
244378+
"url": {
244379+
"type": "string"
244380+
},
244381+
"status": {
244382+
"type": "string"
244383+
}
244384+
}
244385+
}
244386+
},
244387+
"application/scim+json": {
244388+
"schema": {
244389+
"title": "Scim Error",
244390+
"description": "Scim Error",
244391+
"type": "object",
244392+
"properties": {
244393+
"message": {
244394+
"type": [
244395+
"string",
244396+
"null"
244397+
]
244398+
},
244399+
"documentation_url": {
244400+
"type": [
244401+
"string",
244402+
"null"
244403+
]
244404+
},
244405+
"detail": {
244406+
"type": [
244407+
"string",
244408+
"null"
244409+
]
244410+
},
244411+
"status": {
244412+
"type": "integer"
244413+
},
244414+
"scimType": {
244415+
"type": [
244416+
"string",
244417+
"null"
244418+
]
244419+
},
244420+
"schemas": {
244421+
"type": "array",
244422+
"items": {
244423+
"type": "string"
244424+
}
244425+
}
244426+
}
244427+
}
244428+
}
244429+
}
244430+
},
244320244431
"403": {
244321244432
"description": "Forbidden",
244322244433
"content": {

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

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

48888-
Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `rubygems`, `rust`
48888+
Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust`
4888948889
schema:
4889048890
type: string
4889148891
- name: package
@@ -48922,8 +48922,45 @@ paths:
4892248922
- updated
4892348923
default: created
4892448924
- *53
48925-
- *30
48926-
- *12
48925+
- name: page
48926+
description: "**Deprecated**. Page number of the results to fetch. Use cursor-based
48927+
pagination with `before` or `after` instead."
48928+
deprecated: true
48929+
in: query
48930+
schema:
48931+
type: integer
48932+
default: 1
48933+
- name: per_page
48934+
description: "**Deprecated**. The number of results per page (max 100). Use
48935+
cursor-based pagination with `first` or `last` instead."
48936+
deprecated: true
48937+
in: query
48938+
schema:
48939+
type: integer
48940+
default: 30
48941+
- *54
48942+
- *55
48943+
- name: first
48944+
description: |-
48945+
The number of results per page (max 100), starting from the first matching result.
48946+
This parameter must not be used in combination with `last`.
48947+
in: query
48948+
required: false
48949+
schema:
48950+
type: integer
48951+
minimum: 1
48952+
maximum: 100
48953+
default: 30
48954+
- name: last
48955+
description: |-
48956+
The number of results per page (max 100), starting from the last matching result.
48957+
This parameter must not be used in combination with `first`.
48958+
in: query
48959+
required: false
48960+
schema:
48961+
type: integer
48962+
minimum: 1
48963+
maximum: 100
4892748964
responses:
4892848965
'200':
4892948966
description: Response
@@ -49405,6 +49442,7 @@ paths:
4940549442
dismissed_comment:
4940649443
fixed_at:
4940749444
'304': *25
49445+
'400': *9
4940849446
'403': *22
4940949447
'404': *15
4941049448
'422': *49

0 commit comments

Comments
 (0)