fix: update operation docs to reflect current API

octokit · Jul 2, 2022 · c6d49a5 · c6d49a5
1 parent adf942a
commit c6d49a5
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 54 deletions.
diff --git a/docs/actions/setActionsOidcCustomIssuerPolicyForEnterprise.md b/docs/actions/setActionsOidcCustomIssuerPolicyForEnterprise.md
diff --git 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.
 
 </td></tr>
-<tr><td>org_id</td><td>yes</td><td>
+<tr><td>org</td><td>yes</td><td>
 
-The unique identifier of the organization.
+The organization name. The name is not case sensitive.
+
+</td></tr>
+<tr><td>org_id</td><td>no</td><td>
+
+The organization name. The name is not case sensitive.
 
 </td></tr>
   </tbody>

diff --git 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.
 
 </td></tr>
-<tr><td>assignees</td><td>no</td><td>
+<tr><td>assignees</td><td>yes</td><td>
 
 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
@@ -42,12 +42,12 @@ The name of the repository. The name is not case sensitive.
 </td></tr>
 <tr><td>key_prefix</td><td>yes</td><td>
 
-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.
 
 </td></tr>
 <tr><td>url_template</td><td>yes</td><td>
 
-The URL must contain <num> for the reference number.
+The URL must contain `<num>` for the reference number. `<num>` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`.
 
 </td></tr>
   </tbody>