Skip to content

Update OpenAPI 3.1 Descriptions #1645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bearcherian merged 1 commit into from
Oct 7, 2022
Merged

Update OpenAPI 3.1 Descriptions #1645

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 55 additions & 3 deletions descriptions-next/api.github.com/api.github.com.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -30989,6 +31015,9 @@
"304": {
"$ref": "#/components/responses/not_modified"
},
"400": {
"$ref": "#/components/responses/bad_request"
},
"403": {
"$ref": "#/components/responses/forbidden"
},
Expand Down Expand Up @@ -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"
}
Expand Down Expand Up @@ -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",
Expand Down
49 changes: 46 additions & 3 deletions descriptions-next/api.github.com/api.github.com.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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':
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down
117 changes: 114 additions & 3 deletions descriptions-next/api.github.com/dereferenced/api.github.com.deref.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
Expand Down Expand Up @@ -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",
Expand All @@ -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": {
Expand Down Expand Up @@ -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": {
Expand Down
44 changes: 41 additions & 3 deletions descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -49405,6 +49442,7 @@ paths:
dismissed_comment:
fixed_at:
'304': *25
'400': *9
'403': *22
'404': *15
'422': *49
Expand Down
Loading