Skip to content

Commit

Permalink
Add Actions permissions API operations (github#15805)
Browse files Browse the repository at this point in the history
* Add new section for Actions permissions API

* Add description for new 'Permissions' section

* Apply suggestions from code review

* add latest rest-api-operations module

Co-authored-by: Leona B. Campbell <[email protected]>
Co-authored-by: Rachael Sewell <[email protected]>
  • Loading branch information
3 people authored Oct 9, 2020
1 parent f5d1c08 commit d48df93
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 8 deletions.
14 changes: 12 additions & 2 deletions content/rest/reference/actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,16 @@ The Artifacts API allows you to download, delete, and retrieve information about
{% if operation.subcategory == 'artifacts' %}{% include rest_operation %}{% endif %}
{% endfor %}

## Permissions

The Permissions API allows you to set permissions for what organizations and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions are allowed to run. For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#disabling-or-limiting-github-actions-for-your-repository-or-organization)."

You can also set permissions for an enterprise. For more information, see the "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin#github-actions)" REST API.

{% for operation in currentRestOperations %}
{% if operation.subcategory == 'permissions' %}{% include rest_operation %}{% endif %}
{% endfor %}

## Secrets

The Secrets API lets you create, update, delete, and retrieve information about encrypted secrets. {% data reusables.actions.about-secrets %} For more information, see "[Creating and using encrypted secrets](/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets)."
Expand All @@ -40,7 +50,7 @@ The Self-hosted Runners API allows you to register, view, and delete self-hosted

{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_app %}s must have the `administration` permission for repositories or the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to the repository or organization to use this API.

You can manage self-hosted runners for an enterprise. For more information, see the "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin#actions)" REST API.
You can manage self-hosted runners for an enterprise. For more information, see the "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin#github-actions)" REST API.

{% for operation in currentRestOperations %}
{% if operation.subcategory == 'self-hosted-runners' %}{% include rest_operation %}{% endif %}
Expand All @@ -52,7 +62,7 @@ The Self-hosted Runners Groups API allows you manage groups of self-hosted runne

{% data reusables.actions.actions-authentication %} {% data variables.product.prodname_github_app %}s must have the `administration` permission for repositories or the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to the repository or organization to use this API.

You can manage self-hosted runner groups for an enterprise. For more information, see the "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin#actions)" REST API.
You can manage self-hosted runner groups for an enterprise. For more information, see the "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin##github-actions)" REST API.

{% for operation in currentRestOperations %}
{% if operation.subcategory == 'self-hosted-runner-groups' %}{% include rest_operation %}{% endif %}
Expand Down
10 changes: 5 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"@github-docs/data-directory": "^1.2.0",
"@github-docs/frontmatter": "^1.3.1",
"@github-docs/render-content": "^5.0.0",
"@github/rest-api-operations": "^2.1.0",
"@github/rest-api-operations": "^3.1.0",
"@octokit/rest": "^16.38.1",
"@primer/css": "^15.1.0",
"@primer/octicons": "^11.0.0",
Expand Down

0 comments on commit d48df93

Please sign in to comment.