Skip to content

Commit

Permalink
feat: add support for new request parameter and response attribute, p…
Browse files Browse the repository at this point in the history
…lus in-code documentation updates (see PR body for details( (#244)

WIP
  • Loading branch information
octokitbot committed Sep 13, 2022
1 parent 7bad67d commit b40d8ef
Show file tree
Hide file tree
Showing 21 changed files with 205 additions and 44 deletions.
38 changes: 33 additions & 5 deletions cache/api.github.com.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "7.11.0",
"version": "7.12.0",
"title": "GitHub's official OpenAPI spec + Octokit extension",
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
"license": {
Expand Down Expand Up @@ -3579,7 +3579,7 @@
"/enterprises/{enterprise}/consumed-licenses": {
"get": {
"summary": "List enterprise consumed licenses",
"description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.",
"description": "Lists the license consumption information for all users, including those from connected servers, associated with an enterprise.\nTo use this endpoint, you must be an enterprise admin, and you must use an access\ntoken with the `read:enterprise` scope.\n\n**Note:** The license consumption API endpoints for enterprise accounts are currently\nin Beta and are subject to change.",
"tags": [
"enterprise-admin"
],
Expand Down Expand Up @@ -29439,6 +29439,22 @@
"default": "all"
}
},
{
"name": "permission",
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"pull",
"triage",
"push",
"maintain",
"admin"
]
}
},
{
"$ref": "#/components/parameters/per-page"
},
Expand Down Expand Up @@ -31166,7 +31182,7 @@
},
"put": {
"summary": "Create or update file contents",
"description": "Creates a new file or replaces an existing file in a repository.",
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
"tags": [
"repos"
],
Expand Down Expand Up @@ -34593,7 +34609,7 @@
"/repos/{owner}/{repo}/hooks": {
"get": {
"summary": "List repository webhooks",
"description": "",
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
"tags": [
"repos"
],
Expand Down Expand Up @@ -63849,7 +63865,15 @@
},
"github_com_enterprise_role": {
"type": "string",
"nullable": true
"nullable": true,
"description": "Deprecated: The most permissive enterprise role for a user."
},
"github_com_enterprise_roles": {
"type": "array",
"description": "All enterprise roles for a user.",
"items": {
"type": "string"
}
},
"visual_studio_subscription_user": {
"type": "boolean"
Expand Down Expand Up @@ -90734,6 +90758,9 @@
"org2:Owner"
],
"github_com_enterprise_role": "owner",
"github_com_enterprise_roles": [
"owner"
],
"visual_studio_subscription_user": false,
"github_com_verified_domain_emails": [
"monalisa@github.com"
Expand Down Expand Up @@ -90762,6 +90789,7 @@
"license_type": "enterprise",
"github_com_member_roles": [],
"github_com_enterprise_role": "",
"github_com_enterprise_roles": [],
"visual_studio_subscription_user": false,
"github_com_verified_domain_emails": [],
"github_com_saml_name_id": "",
Expand Down
22 changes: 19 additions & 3 deletions cache/ghes-3.2.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "7.11.0",
"version": "7.12.0",
"title": "GitHub's official OpenAPI spec + Octokit extension",
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
"license": {
Expand Down Expand Up @@ -25544,6 +25544,22 @@
"default": "all"
}
},
{
"name": "permission",
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"pull",
"triage",
"push",
"maintain",
"admin"
]
}
},
{
"$ref": "#/components/parameters/per-page"
},
Expand Down Expand Up @@ -27431,7 +27447,7 @@
},
"put": {
"summary": "Create or update file contents",
"description": "Creates a new file or replaces an existing file in a repository.",
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
"tags": [
"repos"
],
Expand Down Expand Up @@ -30496,7 +30512,7 @@
"/repos/{owner}/{repo}/hooks": {
"get": {
"summary": "List repository webhooks",
"description": "",
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
"tags": [
"repos"
],
Expand Down
22 changes: 19 additions & 3 deletions cache/ghes-3.3.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "7.11.0",
"version": "7.12.0",
"title": "GitHub's official OpenAPI spec + Octokit extension",
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
"license": {
Expand Down Expand Up @@ -25497,6 +25497,22 @@
"default": "all"
}
},
{
"name": "permission",
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"pull",
"triage",
"push",
"maintain",
"admin"
]
}
},
{
"$ref": "#/components/parameters/per-page"
},
Expand Down Expand Up @@ -27304,7 +27320,7 @@
},
"put": {
"summary": "Create or update file contents",
"description": "Creates a new file or replaces an existing file in a repository.",
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
"tags": [
"repos"
],
Expand Down Expand Up @@ -30289,7 +30305,7 @@
"/repos/{owner}/{repo}/hooks": {
"get": {
"summary": "List repository webhooks",
"description": "",
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
"tags": [
"repos"
],
Expand Down
22 changes: 19 additions & 3 deletions cache/ghes-3.4.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "7.11.0",
"version": "7.12.0",
"title": "GitHub's official OpenAPI spec + Octokit extension",
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
"license": {
Expand Down Expand Up @@ -27153,6 +27153,22 @@
"default": "all"
}
},
{
"name": "permission",
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"pull",
"triage",
"push",
"maintain",
"admin"
]
}
},
{
"$ref": "#/components/parameters/per-page"
},
Expand Down Expand Up @@ -28864,7 +28880,7 @@
},
"put": {
"summary": "Create or update file contents",
"description": "Creates a new file or replaces an existing file in a repository.",
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
"tags": [
"repos"
],
Expand Down Expand Up @@ -32136,7 +32152,7 @@
"/repos/{owner}/{repo}/hooks": {
"get": {
"summary": "List repository webhooks",
"description": "",
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
"tags": [
"repos"
],
Expand Down
22 changes: 19 additions & 3 deletions cache/ghes-3.5.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "7.11.0",
"version": "7.12.0",
"title": "GitHub's official OpenAPI spec + Octokit extension",
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
"license": {
Expand Down Expand Up @@ -28379,6 +28379,22 @@
"default": "all"
}
},
{
"name": "permission",
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"pull",
"triage",
"push",
"maintain",
"admin"
]
}
},
{
"$ref": "#/components/parameters/per-page"
},
Expand Down Expand Up @@ -30084,7 +30100,7 @@
},
"put": {
"summary": "Create or update file contents",
"description": "Creates a new file or replaces an existing file in a repository.",
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
"tags": [
"repos"
],
Expand Down Expand Up @@ -33368,7 +33384,7 @@
"/repos/{owner}/{repo}/hooks": {
"get": {
"summary": "List repository webhooks",
"description": "",
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
"tags": [
"repos"
],
Expand Down
22 changes: 19 additions & 3 deletions cache/ghes-3.6.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "7.11.0",
"version": "7.12.0",
"title": "GitHub's official OpenAPI spec + Octokit extension",
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
"license": {
Expand Down Expand Up @@ -28879,6 +28879,22 @@
"default": "all"
}
},
{
"name": "permission",
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"pull",
"triage",
"push",
"maintain",
"admin"
]
}
},
{
"$ref": "#/components/parameters/per-page"
},
Expand Down Expand Up @@ -30572,7 +30588,7 @@
},
"put": {
"summary": "Create or update file contents",
"description": "Creates a new file or replaces an existing file in a repository.",
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
"tags": [
"repos"
],
Expand Down Expand Up @@ -33912,7 +33928,7 @@
"/repos/{owner}/{repo}/hooks": {
"get": {
"summary": "List repository webhooks",
"description": "",
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
"tags": [
"repos"
],
Expand Down
22 changes: 19 additions & 3 deletions cache/github.ae.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "7.11.0",
"version": "7.12.0",
"title": "GitHub's official OpenAPI spec + Octokit extension",
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
"license": {
Expand Down Expand Up @@ -23425,6 +23425,22 @@
"default": "all"
}
},
{
"name": "permission",
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
"in": "query",
"required": false,
"schema": {
"type": "string",
"enum": [
"pull",
"triage",
"push",
"maintain",
"admin"
]
}
},
{
"$ref": "#/components/parameters/per-page"
},
Expand Down Expand Up @@ -25169,7 +25185,7 @@
},
"put": {
"summary": "Create or update file contents",
"description": "Creates a new file or replaces an existing file in a repository.",
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
"tags": [
"repos"
],
Expand Down Expand Up @@ -28172,7 +28188,7 @@
"/repos/{owner}/{repo}/hooks": {
"get": {
"summary": "List repository webhooks",
"description": "",
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
"tags": [
"repos"
],
Expand Down
Loading

0 comments on commit b40d8ef

Please sign in to comment.