Skip to content

Commit c6d49a5

Browse files
committed
fix: update operation docs to reflect current API
1 parent adf942a commit c6d49a5

File tree

4 files changed

+15
-54
lines changed

4 files changed

+15
-54
lines changed

docs/actions/setActionsOidcCustomIssuerPolicyForEnterprise.md

Lines changed: 0 additions & 45 deletions
This file was deleted.

docs/codespaces/listInOrganization.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
name: List codespaces for the organization
3-
example: octokit.rest.codespaces.listInOrganization({ org_id })
4-
route: GET /orgs/{org_id}/codespaces
3+
example: octokit.rest.codespaces.listInOrganization({ org })
4+
route: GET /orgs/{org}/codespaces
55
scope: codespaces
66
type: API method
77
---
@@ -14,7 +14,7 @@ You must authenticate using an access token with the `admin:org` scope to use th
1414

1515
```js
1616
octokit.rest.codespaces.listInOrganization({
17-
org_id,
17+
org,
1818
});
1919
```
2020

@@ -39,9 +39,14 @@ The number of results per page (max 100).
3939
Page number of the results to fetch.
4040

4141
</td></tr>
42-
<tr><td>org_id</td><td>yes</td><td>
42+
<tr><td>org</td><td>yes</td><td>
4343

44-
The unique identifier of the organization.
44+
The organization name. The name is not case sensitive.
45+
46+
</td></tr>
47+
<tr><td>org_id</td><td>no</td><td>
48+
49+
The organization name. The name is not case sensitive.
4550

4651
</td></tr>
4752
</tbody>

docs/issues/removeAssignees.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Remove assignees from an issue
3-
example: octokit.rest.issues.removeAssignees({ owner, repo, issue_number })
3+
example: octokit.rest.issues.removeAssignees({ owner, repo, issue_number, assignees })
44
route: DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees
55
scope: issues
66
type: API method
@@ -15,6 +15,7 @@ octokit.rest.issues.removeAssignees({
1515
owner,
1616
repo,
1717
issue_number,
18+
assignees,
1819
});
1920
```
2021

@@ -44,7 +45,7 @@ The name of the repository. The name is not case sensitive.
4445
The number that identifies the issue.
4546

4647
</td></tr>
47-
<tr><td>assignees</td><td>no</td><td>
48+
<tr><td>assignees</td><td>yes</td><td>
4849

4950
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._
5051

docs/repos/createAutolink.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,12 @@ The name of the repository. The name is not case sensitive.
4242
</td></tr>
4343
<tr><td>key_prefix</td><td>yes</td><td>
4444

45-
The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.
45+
The prefix appended by alphanumeric characters will generate a link any time it is found in an issue, pull request, or commit.
4646

4747
</td></tr>
4848
<tr><td>url_template</td><td>yes</td><td>
4949

50-
The URL must contain <num> for the reference number.
50+
The URL must contain `<num>` for the reference number. `<num>` matches alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`.
5151

5252
</td></tr>
5353
</tbody>

0 commit comments

Comments
 (0)