From 60cb2575c52eed843ca45ee5e1392fba27b19c5d Mon Sep 17 00:00:00 2001 From: github-openapi-bot Date: Thu, 6 Oct 2022 16:22:11 -0700 Subject: [PATCH] Update OpenAPI 3.1 Descriptions --- .../api.github.com/api.github.com.json | 58 ++++++++- .../api.github.com/api.github.com.yaml | 49 +++++++- .../dereferenced/api.github.com.deref.json | 117 +++++++++++++++++- .../dereferenced/api.github.com.deref.yaml | 44 ++++++- .../ghec/dereferenced/ghec.deref.json | 117 +++++++++++++++++- .../ghec/dereferenced/ghec.deref.yaml | 44 ++++++- descriptions-next/ghec/ghec.json | 58 ++++++++- descriptions-next/ghec/ghec.yaml | 49 +++++++- 8 files changed, 512 insertions(+), 24 deletions(-) diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 5fa01541cf..498861bf9b 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -30961,10 +30961,36 @@ "$ref": "#/components/parameters/direction" }, { - "$ref": "#/components/parameters/page" + "name": "page", + "description": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", + "deprecated": true, + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } }, { - "$ref": "#/components/parameters/per-page" + "name": "per_page", + "description": "**Deprecated**. The number of results per page (max 100). Use cursor-based pagination with `first` or `last` instead.", + "deprecated": true, + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/pagination-first" + }, + { + "$ref": "#/components/parameters/pagination-last" } ], "responses": { @@ -30989,6 +31015,9 @@ "304": { "$ref": "#/components/responses/not_modified" }, + "400": { + "$ref": "#/components/responses/bad_request" + }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -113353,7 +113382,7 @@ "dependabot-alert-comma-separated-ecosystems": { "name": "ecosystem", "in": "query", - "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`", + "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`", "schema": { "type": "string" } @@ -113399,6 +113428,29 @@ "default": "created" } }, + "pagination-first": { + "name": "first", + "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`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + "pagination-last": { + "name": "last", + "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`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100 + } + }, "dependabot-alert-number": { "name": "alert_number", "in": "path", diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 59f59905ac..ad74e2994b 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -22484,8 +22484,26 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - - "$ref": "#/components/parameters/page" - - "$ref": "#/components/parameters/per-page" + - name: page + description: "**Deprecated**. Page number of the results to fetch. Use cursor-based + pagination with `before` or `after` instead." + deprecated: true + in: query + schema: + type: integer + default: 1 + - name: per_page + description: "**Deprecated**. The number of results per page (max 100). Use + cursor-based pagination with `first` or `last` instead." + deprecated: true + in: query + schema: + type: integer + default: 30 + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/pagination-first" + - "$ref": "#/components/parameters/pagination-last" responses: '200': description: Response @@ -22500,6 +22518,8 @@ paths: "$ref": "#/components/examples/dependabot-alerts" '304': "$ref": "#/components/responses/not_modified" + '400': + "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '404': @@ -85845,7 +85865,7 @@ components: description: |- A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. - Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `rubygems`, `rust` + Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string dependabot-alert-comma-separated-packages: @@ -85885,6 +85905,29 @@ components: - created - updated default: created + pagination-first: + name: first + description: |- + The number of results per page (max 100), starting from the first matching result. + This parameter must not be used in combination with `last`. + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + pagination-last: + name: last + description: |- + The number of results per page (max 100), starting from the last matching result. + This parameter must not be used in combination with `first`. + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 dependabot-alert-number: name: alert_number in: path diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 542dc95581..68be818862 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -243337,7 +243337,7 @@ { "name": "ecosystem", "in": "query", - "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`", + "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`", "schema": { "type": "string" } @@ -243399,7 +243399,8 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", + "deprecated": true, "in": "query", "schema": { "type": "integer", @@ -243408,12 +243409,54 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "**Deprecated**. The number of results per page (max 100). Use cursor-based pagination with `first` or `last` instead.", + "deprecated": true, + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "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.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "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.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "first", + "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`.", "in": "query", + "required": false, "schema": { "type": "integer", + "minimum": 1, + "maximum": 100, "default": 30 } + }, + { + "name": "last", + "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`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100 + } } ], "responses": { @@ -244317,6 +244360,74 @@ "304": { "description": "Not modified" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, "403": { "description": "Forbidden", "content": { diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index ea9bc7d411..dd6f569501 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -48885,7 +48885,7 @@ paths: description: |- A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. - Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `rubygems`, `rust` + Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - name: package @@ -48922,8 +48922,45 @@ paths: - updated default: created - *53 - - *30 - - *12 + - name: page + description: "**Deprecated**. Page number of the results to fetch. Use cursor-based + pagination with `before` or `after` instead." + deprecated: true + in: query + schema: + type: integer + default: 1 + - name: per_page + description: "**Deprecated**. The number of results per page (max 100). Use + cursor-based pagination with `first` or `last` instead." + deprecated: true + in: query + schema: + type: integer + default: 30 + - *54 + - *55 + - name: first + description: |- + The number of results per page (max 100), starting from the first matching result. + This parameter must not be used in combination with `last`. + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: last + description: |- + The number of results per page (max 100), starting from the last matching result. + This parameter must not be used in combination with `first`. + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 responses: '200': description: Response @@ -49405,6 +49442,7 @@ paths: dismissed_comment: fixed_at: '304': *25 + '400': *9 '403': *22 '404': *15 '422': *49 diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 52ca09b6d1..97bf08dc30 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -246796,7 +246796,7 @@ { "name": "ecosystem", "in": "query", - "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`", + "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`", "schema": { "type": "string" } @@ -246858,7 +246858,8 @@ }, { "name": "page", - "description": "Page number of the results to fetch.", + "description": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", + "deprecated": true, "in": "query", "schema": { "type": "integer", @@ -246867,12 +246868,54 @@ }, { "name": "per_page", - "description": "The number of results per page (max 100).", + "description": "**Deprecated**. The number of results per page (max 100). Use cursor-based pagination with `first` or `last` instead.", + "deprecated": true, + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results before this cursor.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for results after this cursor.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "first", + "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`.", "in": "query", + "required": false, "schema": { "type": "integer", + "minimum": 1, + "maximum": 100, "default": 30 } + }, + { + "name": "last", + "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`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100 + } } ], "responses": { @@ -247776,6 +247819,74 @@ "304": { "description": "Not modified" }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, "403": { "description": "Forbidden", "content": { diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index b985a99fdc..ab8adbe653 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -50408,7 +50408,7 @@ paths: description: |- A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. - Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `rubygems`, `rust` + Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - name: package @@ -50445,8 +50445,45 @@ paths: - updated default: created - *53 - - *30 - - *12 + - name: page + description: "**Deprecated**. Page number of the results to fetch. Use cursor-based + pagination with `before` or `after` instead." + deprecated: true + in: query + schema: + type: integer + default: 1 + - name: per_page + description: "**Deprecated**. The number of results per page (max 100). Use + cursor-based pagination with `first` or `last` instead." + deprecated: true + in: query + schema: + type: integer + default: 30 + - *54 + - *55 + - name: first + description: |- + The number of results per page (max 100), starting from the first matching result. + This parameter must not be used in combination with `last`. + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + - name: last + description: |- + The number of results per page (max 100), starting from the last matching result. + This parameter must not be used in combination with `first`. + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 responses: '200': description: Response @@ -50928,6 +50965,7 @@ paths: dismissed_comment: fixed_at: '304': *25 + '400': *9 '403': *22 '404': *15 '422': *49 diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index ac9014f651..6906a51bc8 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -32197,10 +32197,36 @@ "$ref": "#/components/parameters/direction" }, { - "$ref": "#/components/parameters/page" + "name": "page", + "description": "**Deprecated**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead.", + "deprecated": true, + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } }, { - "$ref": "#/components/parameters/per-page" + "name": "per_page", + "description": "**Deprecated**. The number of results per page (max 100). Use cursor-based pagination with `first` or `last` instead.", + "deprecated": true, + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/pagination-first" + }, + { + "$ref": "#/components/parameters/pagination-last" } ], "responses": { @@ -32225,6 +32251,9 @@ "304": { "$ref": "#/components/responses/not_modified" }, + "400": { + "$ref": "#/components/responses/bad_request" + }, "403": { "$ref": "#/components/responses/forbidden" }, @@ -116735,7 +116764,7 @@ "dependabot-alert-comma-separated-ecosystems": { "name": "ecosystem", "in": "query", - "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`", + "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`", "schema": { "type": "string" } @@ -116781,6 +116810,29 @@ "default": "created" } }, + "pagination-first": { + "name": "first", + "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`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100, + "default": 30 + } + }, + "pagination-last": { + "name": "last", + "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`.", + "in": "query", + "required": false, + "schema": { + "type": "integer", + "minimum": 1, + "maximum": 100 + } + }, "dependabot-alert-number": { "name": "alert_number", "in": "path", diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index 071ca17ad7..f54cee0026 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -23346,8 +23346,26 @@ paths: - "$ref": "#/components/parameters/dependabot-alert-scope" - "$ref": "#/components/parameters/dependabot-alert-sort" - "$ref": "#/components/parameters/direction" - - "$ref": "#/components/parameters/page" - - "$ref": "#/components/parameters/per-page" + - name: page + description: "**Deprecated**. Page number of the results to fetch. Use cursor-based + pagination with `before` or `after` instead." + deprecated: true + in: query + schema: + type: integer + default: 1 + - name: per_page + description: "**Deprecated**. The number of results per page (max 100). Use + cursor-based pagination with `first` or `last` instead." + deprecated: true + in: query + schema: + type: integer + default: 30 + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/pagination-first" + - "$ref": "#/components/parameters/pagination-last" responses: '200': description: Response @@ -23362,6 +23380,8 @@ paths: "$ref": "#/components/examples/dependabot-alerts" '304': "$ref": "#/components/responses/not_modified" + '400': + "$ref": "#/components/responses/bad_request" '403': "$ref": "#/components/responses/forbidden" '404': @@ -88230,7 +88250,7 @@ components: description: |- A comma-separated list of ecosystems. If specified, only alerts for these ecosystems will be returned. - Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `rubygems`, `rust` + Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string dependabot-alert-comma-separated-packages: @@ -88270,6 +88290,29 @@ components: - created - updated default: created + pagination-first: + name: first + description: |- + The number of results per page (max 100), starting from the first matching result. + This parameter must not be used in combination with `last`. + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 + default: 30 + pagination-last: + name: last + description: |- + The number of results per page (max 100), starting from the last matching result. + This parameter must not be used in combination with `first`. + in: query + required: false + schema: + type: integer + minimum: 1 + maximum: 100 dependabot-alert-number: name: alert_number in: path