Skip to content

Commit

Permalink
Update OpenAPI Description (github#36319)
Browse files Browse the repository at this point in the history
Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com>
  • Loading branch information
docubot and saritai authored Apr 12, 2023
1 parent 1630df9 commit 5788b58
Show file tree
Hide file tree
Showing 24 changed files with 21,511 additions and 15,479 deletions.
5 changes: 4 additions & 1 deletion content/rest/dependency-graph/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Dependency Graph
intro: Use the REST API to view dependency changes and their security impact on your repository.
intro: >-
Use the REST API to view dependency changes and their security impact on your
repository.
versions:
fpt: '*'
ghes: '>=3.6'
Expand All @@ -10,6 +12,7 @@ topics:
children:
- /dependency-review
- /dependency-submission
- /sboms
redirect_from:
- /rest/reference/dependency-graph
autogenerated: rest
Expand Down
14 changes: 14 additions & 0 deletions content/rest/dependency-graph/sboms.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Software bill of materials (SBOM)
shortTitle: Software bill of materials (SBOM)
intro: 'Use the REST API to export the software bill of materials (SBOM) for a repository.'
versions:
fpt: '*'
ghec: '*'
topics:
- API
autogenerated: rest
allowTitleToDifferFromFilename: true
---

<!-- Content after this section is automatically generated -->
5 changes: 4 additions & 1 deletion content/rest/orgs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: Organizations
intro: 'Use the REST API to control and manage all your {% data variables.product.product_name %} organizations.'
intro: >-
Use the REST API to control and manage all your {% data
variables.product.product_name %} organizations.
allowTitleToDifferFromFilename: true
redirect_from:
- /v3/orgs
Expand All @@ -18,6 +20,7 @@ children:
- /custom-roles
- /members
- /outside-collaborators
- /personal-access-tokens
- /security-managers
- /webhooks
autogenerated: rest
Expand Down
20 changes: 20 additions & 0 deletions content/rest/orgs/personal-access-tokens.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Personal access tokens
shortTitle: Personal access tokens
intro: 'Use the REST API to manage {% data variables.product.pat_v2 %}s.'
versions:
fpt: '*'
ghec: '*'
topics:
- API
autogenerated: rest
allowTitleToDifferFromFilename: true
---

{% note %}

**Note**: {% data reusables.user-settings.pat-v2-beta %}

{% endnote %}

<!-- Content after this section is automatically generated -->
2 changes: 2 additions & 0 deletions content/rest/users/social-accounts.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,5 @@ autogenerated: rest
## About social account administration

{% data reusables.user-settings.user-api %}

<!-- Content after this section is automatically generated -->
16 changes: 8 additions & 8 deletions src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json
Original file line number Diff line number Diff line change
Expand Up @@ -2288,49 +2288,49 @@
},
{
"slug": "list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "get",
"requestPath": "/organizations/{org}/personal-access-token-requests"
},
{
"slug": "review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "post",
"requestPath": "/organizations/{org}/personal-access-token-requests"
},
{
"slug": "review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "post",
"requestPath": "/organizations/{org}/personal-access-token-requests/{pat_request_id}"
},
{
"slug": "list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "get",
"requestPath": "/organizations/{org}/personal-access-token-requests/{pat_request_id}/repositories"
},
{
"slug": "list-fine-grained-personal-access-tokens-with-access-to-organization-resources",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "get",
"requestPath": "/organizations/{org}/personal-access-tokens"
},
{
"slug": "update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "post",
"requestPath": "/organizations/{org}/personal-access-tokens"
},
{
"slug": "update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "post",
"requestPath": "/organizations/{org}/personal-access-tokens/{pat_id}"
},
{
"slug": "list-repositories-a-fine-grained-personal-access-token-has-access-to",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "get",
"requestPath": "/organizations/{org}/personal-access-tokens/{pat_id}/repositories"
},
Expand Down
16 changes: 8 additions & 8 deletions src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json
Original file line number Diff line number Diff line change
Expand Up @@ -2400,49 +2400,49 @@
},
{
"slug": "list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "get",
"requestPath": "/organizations/{org}/personal-access-token-requests"
},
{
"slug": "review-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "post",
"requestPath": "/organizations/{org}/personal-access-token-requests"
},
{
"slug": "review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "post",
"requestPath": "/organizations/{org}/personal-access-token-requests/{pat_request_id}"
},
{
"slug": "list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "get",
"requestPath": "/organizations/{org}/personal-access-token-requests/{pat_request_id}/repositories"
},
{
"slug": "list-fine-grained-personal-access-tokens-with-access-to-organization-resources",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "get",
"requestPath": "/organizations/{org}/personal-access-tokens"
},
{
"slug": "update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "post",
"requestPath": "/organizations/{org}/personal-access-tokens"
},
{
"slug": "update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "post",
"requestPath": "/organizations/{org}/personal-access-tokens/{pat_id}"
},
{
"slug": "list-repositories-a-fine-grained-personal-access-token-has-access-to",
"subcategory": "orgs",
"subcategory": "personal-access-tokens",
"verb": "get",
"requestPath": "/organizations/{org}/personal-access-tokens/{pat_id}/repositories"
},
Expand Down
2 changes: 1 addition & 1 deletion src/github-apps/lib/config.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"sha": "e27c8f10a2208e6a8df88e64d2b40c9c7a1ecd2d"
"sha": "e462c64f50b84f040ac76cd2205984ddf151b67f"
}
12 changes: 3 additions & 9 deletions src/rest/data/client-side-rest-api-redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -232,18 +232,10 @@
"/rest/activity#set-a-thread-subscription": "/rest/activity/notifications#set-a-thread-subscription",
"/rest/activity#delete-a-thread-subscription": "/rest/activity/notifications#delete-a-thread-subscription",
"/rest/orgs#list-organizations": "/rest/orgs/orgs#list-organizations",
"/rest/orgs/orgs#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens": "/rest/orgs/orgs#list-requests-to-access-organization-resources-with-fine-grained-personal-access-tokens",
"/rest/orgs#orgs": "/rest/orgs/orgs",
"/rest/orgs/orgs#review-requests-to-access-organization-resources-with-a-fine-grained-personal-access-token": "/rest/orgs/orgs#review-requests-to-access-organization-resources-with-a-fine-grained-personal-access-token",
"/rest/orgs/orgs#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token": "/rest/orgs/orgs#review-a-request-to-access-organization-resources-with-a-fine-grained-personal-access-token",
"/rest/orgs/orgs#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token": "/rest/orgs/orgs#list-repositories-requested-to-be-accessed-by-a-fine-grained-personal-access-token",
"/rest/orgs/orgs#list-fine-grained-personal-access-tokens-with-access-to-organization-resources": "/rest/orgs/orgs#list-fine-grained-personal-access-tokens-with-access-to-organization-resources",
"/rest/orgs/orgs#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens": "/rest/orgs/orgs#update-the-access-to-organization-resources-via-fine-grained-personal-access-tokens",
"/rest/orgs/orgs#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources": "/rest/orgs/orgs#update-the-access-a-fine-grained-personal-access-token-has-to-organization-resources",
"/rest/orgs/orgs#list-repositories-a-fine-grained-personal-access-token-has-access-to": "/rest/orgs/orgs#list-repositories-a-fine-grained-personal-access-token-has-access-to",
"/rest/orgs#get-an-organization": "/rest/orgs/orgs#get-an-organization",
"/rest/orgs#update-an-organization": "/rest/orgs/orgs#update-an-organization",
"/rest/orgs/orgs/#delete-an-organization": "/rest/orgs/orgs#delete-an-organization",
"/rest/orgs#orgs": "/rest/orgs/orgs",
"/rest/actions#get-github-actions-cache-usage-for-an-organization": "/rest/actions/cache#get-github-actions-cache-usage-for-an-organization",
"/rest/actions#cache": "/rest/actions/cache",
"/rest/actions#list-repositories-with-github-actions-cache-usage-for-an-organization": "/rest/actions/cache#list-repositories-with-github-actions-cache-usage-for-an-organization",
Expand Down Expand Up @@ -638,6 +630,8 @@
"/rest/dependabot#delete-a-repository-secret": "/rest/dependabot/secrets#delete-a-repository-secret",
"/rest/dependency-graph#get-a-diff-of-the-dependencies-between-commits": "/rest/dependency-graph/dependency-review#get-a-diff-of-the-dependencies-between-commits",
"/rest/dependency-graph#dependency-review": "/rest/dependency-graph/dependency-review",
"/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository": "/rest/dependency-graph/sboms#export-a-software-bill-of-materials-sbom-for-a-repository",
"/rest/dependency-graph#sboms": "/rest/dependency-graph/sboms",
"/rest/dependency-graph#create-a-snapshot-of-dependencies-for-a-repository": "/rest/dependency-graph/dependency-submission#create-a-snapshot-of-dependencies-for-a-repository",
"/rest/dependency-graph#dependency-submission": "/rest/dependency-graph/dependency-submission",
"/rest/deployments/deployments#list-deployments": "/rest/deployments/deployments#list-deployments",
Expand Down
Loading

0 comments on commit 5788b58

Please sign in to comment.