-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: many unreleased updates to endpoint methods (#607)
* WIP octokit/openapi updated * WIP octokit/openapi updated
- Loading branch information
1 parent
92ff437
commit 1e9bf68
Showing
261 changed files
with
10,200 additions
and
5,945 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
name: Add selected repository to an organization variable | ||
example: octokit.rest.actions.addSelectedRepoToOrgVariable({ org, name, repository_id }) | ||
route: PUT /orgs/{org}/actions/variables/{name}/repositories/{repository_id} | ||
scope: actions | ||
type: API method | ||
--- | ||
|
||
# Add selected repository to an organization variable | ||
|
||
Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. | ||
|
||
```js | ||
octokit.rest.actions.addSelectedRepoToOrgVariable({ | ||
org, | ||
name, | ||
repository_id, | ||
}); | ||
``` | ||
|
||
## Parameters | ||
|
||
<table> | ||
<thead> | ||
<tr> | ||
<th>name</th> | ||
<th>required</th> | ||
<th>description</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr><td>org</td><td>yes</td><td> | ||
|
||
The organization name. The name is not case sensitive. | ||
|
||
</td></tr> | ||
<tr><td>name</td><td>yes</td><td> | ||
|
||
The name of the variable. | ||
|
||
</td></tr> | ||
<tr><td>repository_id</td><td>yes</td><td> | ||
|
||
</td></tr> | ||
</tbody> | ||
</table> | ||
|
||
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
name: Add a repository to a required workflow | ||
example: octokit.rest.actions.addSelectedRepoToRequiredWorkflow({ org, required_workflow_id, repository_id }) | ||
route: PUT /orgs/{org}/actions/required_workflows/{required_workflow_id}/repositories/{repository_id} | ||
scope: actions | ||
type: API method | ||
--- | ||
|
||
# Add a repository to a required workflow | ||
|
||
Adds a repository to a required workflow. To use this endpoint, the required workflow must be configured to run on selected repositories. | ||
|
||
You must authenticate using an access token with the `admin:org` scope to use this endpoint. | ||
|
||
For more information, see "[Required Workflows](https://docs.github.com/actions/using-workflows/required-workflows)." | ||
|
||
```js | ||
octokit.rest.actions.addSelectedRepoToRequiredWorkflow({ | ||
org, | ||
required_workflow_id, | ||
repository_id, | ||
}); | ||
``` | ||
|
||
## Parameters | ||
|
||
<table> | ||
<thead> | ||
<tr> | ||
<th>name</th> | ||
<th>required</th> | ||
<th>description</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr><td>org</td><td>yes</td><td> | ||
|
||
The organization name. The name is not case sensitive. | ||
|
||
</td></tr> | ||
<tr><td>required_workflow_id</td><td>yes</td><td> | ||
|
||
The unique identifier of the required workflow. | ||
|
||
</td></tr> | ||
<tr><td>repository_id</td><td>yes</td><td> | ||
|
||
The unique identifier of the repository. | ||
|
||
</td></tr> | ||
</tbody> | ||
</table> | ||
|
||
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#add-a-repository-to-selected-repositories-list-for-a-required-workflow). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
--- | ||
name: Create an environment variable | ||
example: octokit.rest.actions.createEnvironmentVariable({ repository_id, environment_name, name, value }) | ||
route: POST /repositories/{repository_id}/environments/{environment_name}/variables | ||
scope: actions | ||
type: API method | ||
--- | ||
|
||
# Create an environment variable | ||
|
||
Create an environment variable that you can reference in a GitHub Actions workflow. | ||
You must authenticate using an access token with the `repo` scope to use this endpoint. | ||
GitHub Apps must have the `environment:write` repository permission to use this endpoint. | ||
|
||
```js | ||
octokit.rest.actions.createEnvironmentVariable({ | ||
repository_id, | ||
environment_name, | ||
name, | ||
value, | ||
}); | ||
``` | ||
|
||
## Parameters | ||
|
||
<table> | ||
<thead> | ||
<tr> | ||
<th>name</th> | ||
<th>required</th> | ||
<th>description</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr><td>repository_id</td><td>yes</td><td> | ||
|
||
The unique identifier of the repository. | ||
|
||
</td></tr> | ||
<tr><td>environment_name</td><td>yes</td><td> | ||
|
||
The name of the environment. | ||
|
||
</td></tr> | ||
<tr><td>name</td><td>yes</td><td> | ||
|
||
The name of the variable. | ||
|
||
</td></tr> | ||
<tr><td>value</td><td>yes</td><td> | ||
|
||
The value of the variable. | ||
|
||
</td></tr> | ||
</tbody> | ||
</table> | ||
|
||
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/variables#create-an-environment-variable). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
--- | ||
name: Create an organization variable | ||
example: octokit.rest.actions.createOrgVariable({ org, name, value, visibility }) | ||
route: POST /orgs/{org}/actions/variables | ||
scope: actions | ||
type: API method | ||
--- | ||
|
||
# Create an organization variable | ||
|
||
Creates an organization variable that you can reference in a GitHub Actions workflow. | ||
You must authenticate using an access token with the `admin:org` scope to use this endpoint. | ||
GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. | ||
|
||
```js | ||
octokit.rest.actions.createOrgVariable({ | ||
org, | ||
name, | ||
value, | ||
visibility, | ||
}); | ||
``` | ||
|
||
## Parameters | ||
|
||
<table> | ||
<thead> | ||
<tr> | ||
<th>name</th> | ||
<th>required</th> | ||
<th>description</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr><td>org</td><td>yes</td><td> | ||
|
||
The organization name. The name is not case sensitive. | ||
|
||
</td></tr> | ||
<tr><td>name</td><td>yes</td><td> | ||
|
||
The name of the variable. | ||
|
||
</td></tr> | ||
<tr><td>value</td><td>yes</td><td> | ||
|
||
The value of the variable. | ||
|
||
</td></tr> | ||
<tr><td>visibility</td><td>yes</td><td> | ||
|
||
The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable. | ||
|
||
</td></tr> | ||
<tr><td>selected_repository_ids</td><td>no</td><td> | ||
|
||
An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`. | ||
|
||
</td></tr> | ||
</tbody> | ||
</table> | ||
|
||
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/variables#create-an-organization-variable). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
--- | ||
name: Create a repository variable | ||
example: octokit.rest.actions.createRepoVariable({ owner, repo, name, value }) | ||
route: POST /repos/{owner}/{repo}/actions/variables | ||
scope: actions | ||
type: API method | ||
--- | ||
|
||
# Create a repository variable | ||
|
||
Creates a repository variable that you can reference in a GitHub Actions workflow. | ||
You must authenticate using an access token with the `repo` scope to use this endpoint. | ||
GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. | ||
|
||
```js | ||
octokit.rest.actions.createRepoVariable({ | ||
owner, | ||
repo, | ||
name, | ||
value, | ||
}); | ||
``` | ||
|
||
## Parameters | ||
|
||
<table> | ||
<thead> | ||
<tr> | ||
<th>name</th> | ||
<th>required</th> | ||
<th>description</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr><td>owner</td><td>yes</td><td> | ||
|
||
The account owner of the repository. The name is not case sensitive. | ||
|
||
</td></tr> | ||
<tr><td>repo</td><td>yes</td><td> | ||
|
||
The name of the repository. The name is not case sensitive. | ||
|
||
</td></tr> | ||
<tr><td>name</td><td>yes</td><td> | ||
|
||
The name of the variable. | ||
|
||
</td></tr> | ||
<tr><td>value</td><td>yes</td><td> | ||
|
||
The value of the variable. | ||
|
||
</td></tr> | ||
</tbody> | ||
</table> | ||
|
||
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/actions/variables#create-a-repository-variable). |
Oops, something went wrong.