Skip to content

Commit

Permalink
fix(docs): update docs to reflect that repos.listCollaborators (`GE…
Browse files Browse the repository at this point in the history 
…T /repos/{owner}/{repo}/collaborators`) can now be filtered by `permission` (#489)

WIP octokit/openapi updated
  • Loading branch information
@octokitbot
octokitbot authored Sep 13, 2022
1 parent 3cfd0e9 commit 3fb3080
Show file tree
Hide file tree
Showing 10 changed files with 80 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/ghe-32.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -642,7 +642,7 @@ octokit.repos.getWebhookConfigForRepo({owner, repo, hook_id});
octokit.repos.getWebhookDelivery({owner, repo, hook_id, delivery_id});
octokit.repos.listBranches({owner, repo, protected, per_page, page});
octokit.repos.listBranchesForHeadCommit({owner, repo, commit_sha});
octokit.repos.listCollaborators({owner, repo, affiliation, per_page, page});
octokit.repos.listCollaborators({owner, repo, affiliation, permission, per_page, page});
octokit.repos.listCommentsForCommit({owner, repo, commit_sha, per_page, page});
octokit.repos.listCommitCommentsForRepo({owner, repo, per_page, page});
octokit.repos.listCommitStatusesForRef({owner, repo, ref, per_page, page});
Expand Down
2 changes: 1 addition & 1 deletion docs/ghe-33.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -650,7 +650,7 @@ octokit.repos.getWebhookDelivery({owner, repo, hook_id, delivery_id});
octokit.repos.listAutolinks({owner, repo, page});
octokit.repos.listBranches({owner, repo, protected, per_page, page});
octokit.repos.listBranchesForHeadCommit({owner, repo, commit_sha});
octokit.repos.listCollaborators({owner, repo, affiliation, per_page, page});
octokit.repos.listCollaborators({owner, repo, affiliation, permission, per_page, page});
octokit.repos.listCommentsForCommit({owner, repo, commit_sha, per_page, page});
octokit.repos.listCommitCommentsForRepo({owner, repo, per_page, page});
octokit.repos.listCommitStatusesForRef({owner, repo, ref, per_page, page});
Expand Down
2 changes: 1 addition & 1 deletion docs/ghe-34.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -709,7 +709,7 @@ octokit.repos.listAutolinks({owner, repo, page});
octokit.repos.listBranches({owner, repo, protected, per_page, page});
octokit.repos.listBranchesForHeadCommit({owner, repo, commit_sha});
octokit.repos.listCacheInfo({owner, repo, per_page, page});
octokit.repos.listCollaborators({owner, repo, affiliation, per_page, page});
octokit.repos.listCollaborators({owner, repo, affiliation, permission, per_page, page});
octokit.repos.listCommentsForCommit({owner, repo, commit_sha, per_page, page});
octokit.repos.listCommitCommentsForRepo({owner, repo, per_page, page});
octokit.repos.listCommitStatusesForRef({owner, repo, ref, per_page, page});
Expand Down
2 changes: 1 addition & 1 deletion docs/ghe-35.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -730,7 +730,7 @@ octokit.repos.listAutolinks({owner, repo, page});
octokit.repos.listBranches({owner, repo, protected, per_page, page});
octokit.repos.listBranchesForHeadCommit({owner, repo, commit_sha});
octokit.repos.listCacheInfo({owner, repo, per_page, page});
octokit.repos.listCollaborators({owner, repo, affiliation, per_page, page});
octokit.repos.listCollaborators({owner, repo, affiliation, permission, per_page, page});
octokit.repos.listCommentsForCommit({owner, repo, commit_sha, per_page, page});
octokit.repos.listCommitCommentsForRepo({owner, repo, per_page, page});
octokit.repos.listCommitStatusesForRef({owner, repo, ref, per_page, page});
Expand Down
2 changes: 1 addition & 1 deletion docs/ghe-36.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -735,7 +735,7 @@ octokit.repos.listAutolinks({owner, repo, page});
octokit.repos.listBranches({owner, repo, protected, per_page, page});
octokit.repos.listBranchesForHeadCommit({owner, repo, commit_sha});
octokit.repos.listCacheInfo({owner, repo, per_page, page});
octokit.repos.listCollaborators({owner, repo, affiliation, per_page, page});
octokit.repos.listCollaborators({owner, repo, affiliation, permission, per_page, page});
octokit.repos.listCommentsForCommit({owner, repo, commit_sha, per_page, page});
octokit.repos.listCommitCommentsForRepo({owner, repo, per_page, page});
octokit.repos.listCommitStatusesForRef({owner, repo, ref, per_page, page});
Expand Down
17 changes: 15 additions & 2 deletions scripts/update-endpoints/generated/ghe32-endpoints.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34341,7 +34341,7 @@
"url": "/repos/{owner}/{repo}/contents/{path}",
"isDeprecated": false,
"deprecationDate": null,
"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.",
"documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/reference/repos#create-or-update-file-contents",
"previews": [],
"headers": [],
Expand Down Expand Up @@ -39421,6 +39421,19 @@
"alias": null,
"deprecated": null
},
{
"name": "permission",
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
"in": "QUERY",
"type": "string",
"required": false,
"enum": ["pull", "triage", "push", "maintain", "admin"],
"allowNull": false,
"mapToData": null,
"validation": null,
"alias": null,
"deprecated": null
},
{
"name": "per_page",
"description": "The number of results per page (max 100).",
Expand Down Expand Up @@ -41673,7 +41686,7 @@
"url": "/repos/{owner}/{repo}/hooks",
"isDeprecated": false,
"deprecationDate": null,
"description": "",
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
"documentationUrl": "https://docs.github.com/enterprise-server@3.2/rest/webhooks/repos#list-repository-webhooks",
"previews": [],
"headers": [],
Expand Down
17 changes: 15 additions & 2 deletions scripts/update-endpoints/generated/ghe33-endpoints.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34518,7 +34518,7 @@
"url": "/repos/{owner}/{repo}/contents/{path}",
"isDeprecated": false,
"deprecationDate": null,
"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.",
"documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/reference/repos#create-or-update-file-contents",
"previews": [],
"headers": [],
Expand Down Expand Up @@ -39998,6 +39998,19 @@
"alias": null,
"deprecated": null
},
{
"name": "permission",
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
"in": "QUERY",
"type": "string",
"required": false,
"enum": ["pull", "triage", "push", "maintain", "admin"],
"allowNull": false,
"mapToData": null,
"validation": null,
"alias": null,
"deprecated": null
},
{
"name": "per_page",
"description": "The number of results per page (max 100).",
Expand Down Expand Up @@ -42250,7 +42263,7 @@
"url": "/repos/{owner}/{repo}/hooks",
"isDeprecated": false,
"deprecationDate": null,
"description": "",
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
"documentationUrl": "https://docs.github.com/enterprise-server@3.3/rest/webhooks/repos#list-repository-webhooks",
"previews": [],
"headers": [],
Expand Down
17 changes: 15 additions & 2 deletions scripts/update-endpoints/generated/ghe34-endpoints.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36912,7 +36912,7 @@
"url": "/repos/{owner}/{repo}/contents/{path}",
"isDeprecated": false,
"deprecationDate": null,
"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.",
"documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/reference/repos#create-or-update-file-contents",
"previews": [],
"headers": [],
Expand Down Expand Up @@ -42473,6 +42473,19 @@
"alias": null,
"deprecated": null
},
{
"name": "permission",
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
"in": "QUERY",
"type": "string",
"required": false,
"enum": ["pull", "triage", "push", "maintain", "admin"],
"allowNull": false,
"mapToData": null,
"validation": null,
"alias": null,
"deprecated": null
},
{
"name": "per_page",
"description": "The number of results per page (max 100).",
Expand Down Expand Up @@ -44725,7 +44738,7 @@
"url": "/repos/{owner}/{repo}/hooks",
"isDeprecated": false,
"deprecationDate": null,
"description": "",
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
"documentationUrl": "https://docs.github.com/enterprise-server@3.4/rest/webhooks/repos#list-repository-webhooks",
"previews": [],
"headers": [],
Expand Down
17 changes: 15 additions & 2 deletions scripts/update-endpoints/generated/ghe35-endpoints.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38129,7 +38129,7 @@
"url": "/repos/{owner}/{repo}/contents/{path}",
"isDeprecated": false,
"deprecationDate": null,
"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.",
"documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/reference/repos#create-or-update-file-contents",
"previews": [],
"headers": [],
Expand Down Expand Up @@ -43814,6 +43814,19 @@
"alias": null,
"deprecated": null
},
{
"name": "permission",
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
"in": "QUERY",
"type": "string",
"required": false,
"enum": ["pull", "triage", "push", "maintain", "admin"],
"allowNull": false,
"mapToData": null,
"validation": null,
"alias": null,
"deprecated": null
},
{
"name": "per_page",
"description": "The number of results per page (max 100).",
Expand Down Expand Up @@ -46117,7 +46130,7 @@
"url": "/repos/{owner}/{repo}/hooks",
"isDeprecated": false,
"deprecationDate": null,
"description": "",
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
"documentationUrl": "https://docs.github.com/enterprise-server@3.5/rest/webhooks/repos#list-repository-webhooks",
"previews": [],
"headers": [],
Expand Down
17 changes: 15 additions & 2 deletions scripts/update-endpoints/generated/ghe36-endpoints.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38502,7 +38502,7 @@
"url": "/repos/{owner}/{repo}/contents/{path}",
"isDeprecated": false,
"deprecationDate": null,
"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.",
"documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/reference/repos#create-or-update-file-contents",
"previews": [],
"headers": [],
Expand Down Expand Up @@ -44187,6 +44187,19 @@
"alias": null,
"deprecated": null
},
{
"name": "permission",
"description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
"in": "QUERY",
"type": "string",
"required": false,
"enum": ["pull", "triage", "push", "maintain", "admin"],
"allowNull": false,
"mapToData": null,
"validation": null,
"alias": null,
"deprecated": null
},
{
"name": "per_page",
"description": "The number of results per page (max 100).",
Expand Down Expand Up @@ -46490,7 +46503,7 @@
"url": "/repos/{owner}/{repo}/hooks",
"isDeprecated": false,
"deprecationDate": null,
"description": "",
"description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
"documentationUrl": "https://docs.github.com/enterprise-server@3.6/rest/webhooks/repos#list-repository-webhooks",
"previews": [],
"headers": [],
Expand Down

0 comments on commit 3fb3080

Please sign in to comment.