From c6d49a5a2cf5dd10e41c2fce74b78b682f8209d0 Mon Sep 17 00:00:00 2001 From: Tim Rogers Date: Sat, 2 Jul 2022 18:49:24 +0100 Subject: [PATCH] fix: update operation docs to reflect current API --- ...ionsOidcCustomIssuerPolicyForEnterprise.md | 45 ------------------- docs/codespaces/listInOrganization.md | 15 ++++--- docs/issues/removeAssignees.md | 5 ++- docs/repos/createAutolink.md | 4 +- 4 files changed, 15 insertions(+), 54 deletions(-) delete mode 100644 docs/actions/setActionsOidcCustomIssuerPolicyForEnterprise.md diff --git a/docs/actions/setActionsOidcCustomIssuerPolicyForEnterprise.md b/docs/actions/setActionsOidcCustomIssuerPolicyForEnterprise.md deleted file mode 100644 index 929bb24a5..000000000 --- a/docs/actions/setActionsOidcCustomIssuerPolicyForEnterprise.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -name: Set the GitHub Actions OIDC custom issuer policy for an enterprise -example: octokit.rest.actions.setActionsOidcCustomIssuerPolicyForEnterprise({ enterprise }) -route: PUT /enterprises/{enterprise}/actions/oidc/customization/issuer -scope: actions -type: API method ---- - -# Set the GitHub Actions OIDC custom issuer policy for an enterprise - -Sets the GitHub Actions OpenID Connect (OIDC) custom issuer policy for an enterprise. -You must authenticate using an access token with the `admin:enterprise` scope to use this endpoint. -GitHub Apps must have the `enterprise_administration:write` permission to use this endpoint. - -```js -octokit.rest.actions.setActionsOidcCustomIssuerPolicyForEnterprise({ - enterprise, -}); -``` - -## Parameters - - - - - - - - - - - - - -
namerequireddescription
enterpriseyes - -The slug version of the enterprise name. You can also substitute this value with the enterprise id. - -
include_enterprise_slugno - -Whether the enterprise customer requested a custom issuer URL. - -
- -See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions/oidc#set-actions-oidc-custom-issuer-policy-for-enterprise). diff --git a/docs/codespaces/listInOrganization.md b/docs/codespaces/listInOrganization.md index 92e7ee898..5be10d00e 100644 --- a/docs/codespaces/listInOrganization.md +++ b/docs/codespaces/listInOrganization.md @@ -1,7 +1,7 @@ --- name: List codespaces for the organization -example: octokit.rest.codespaces.listInOrganization({ org_id }) -route: GET /orgs/{org_id}/codespaces +example: octokit.rest.codespaces.listInOrganization({ org }) +route: GET /orgs/{org}/codespaces scope: codespaces type: API method --- @@ -14,7 +14,7 @@ You must authenticate using an access token with the `admin:org` scope to use th ```js octokit.rest.codespaces.listInOrganization({ - org_id, + org, }); ``` @@ -39,9 +39,14 @@ The number of results per page (max 100). Page number of the results to fetch. -org_idyes +orgyes -The unique identifier of the organization. +The organization name. The name is not case sensitive. + + +org_idno + +The organization name. The name is not case sensitive. diff --git a/docs/issues/removeAssignees.md b/docs/issues/removeAssignees.md index c8515da71..ff38432b9 100644 --- a/docs/issues/removeAssignees.md +++ b/docs/issues/removeAssignees.md @@ -1,6 +1,6 @@ --- name: Remove assignees from an issue -example: octokit.rest.issues.removeAssignees({ owner, repo, issue_number }) +example: octokit.rest.issues.removeAssignees({ owner, repo, issue_number, assignees }) route: DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees scope: issues type: API method @@ -15,6 +15,7 @@ octokit.rest.issues.removeAssignees({ owner, repo, issue_number, + assignees, }); ``` @@ -44,7 +45,7 @@ The name of the repository. The name is not case sensitive. The number that identifies the issue. -assigneesno +assigneesyes Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ diff --git a/docs/repos/createAutolink.md b/docs/repos/createAutolink.md index c9ba9baf8..62646067f 100644 --- a/docs/repos/createAutolink.md +++ b/docs/repos/createAutolink.md @@ -42,12 +42,12 @@ The name of the repository. The name is not case sensitive. key_prefixyes -The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit. +The prefix appended by alphanumeric characters will generate a link any time it is found in an issue, pull request, or commit. url_templateyes -The URL must contain for the reference number. +The URL must contain `` for the reference number. `` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`.