Skip to content

Commit 9fe3479

Browse files
docs-bothubwriter
andauthored
Update OpenAPI Description (#56216)
Co-authored-by: hubwriter <[email protected]>
1 parent bee3990 commit 9fe3479

File tree

17 files changed

+4061
-442
lines changed

17 files changed

+4061
-442
lines changed

src/github-apps/lib/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@
6060
"2022-11-28"
6161
]
6262
},
63-
"sha": "23d16a0c0808c8241b1076d63e8d3f2e75cb6632"
63+
"sha": "9110306f93c1eb8c466c225060db871095a84f63"
6464
}

src/rest/data/fpt-2022-11-28/schema.json

Lines changed: 176 additions & 7 deletions
Large diffs are not rendered by default.

src/rest/data/ghec-2022-11-28/schema.json

Lines changed: 189 additions & 7 deletions
Large diffs are not rendered by default.

src/rest/data/ghes-3.13-2022-11-28/schema.json

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -418603,6 +418603,30 @@
418603418603
"used"
418604418604
]
418605418605
},
418606+
"dependency_sbom": {
418607+
"title": "Rate Limit",
418608+
"type": "object",
418609+
"properties": {
418610+
"limit": {
418611+
"type": "integer"
418612+
},
418613+
"remaining": {
418614+
"type": "integer"
418615+
},
418616+
"reset": {
418617+
"type": "integer"
418618+
},
418619+
"used": {
418620+
"type": "integer"
418621+
}
418622+
},
418623+
"required": [
418624+
"limit",
418625+
"remaining",
418626+
"reset",
418627+
"used"
418628+
]
418629+
},
418606418630
"code_scanning_autofix": {
418607418631
"title": "Rate Limit",
418608418632
"type": "object",
@@ -418667,7 +418691,7 @@
418667418691
}
418668418692
],
418669418693
"previews": [],
418670-
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nAccessing this endpoint does not count against your REST API rate limit.</p>\n</div>\n<p>Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under <code>resources</code>, you'll see objects relating to different categories:</p>\n<ul>\n<li>The <code>core</code> object provides your rate limit status for all non-search-related resources in the REST API.</li>\n<li>The <code>search</code> object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/search/search\">Search</a>.\"</li>\n<li>The <code>code_search</code> object provides your rate limit status for the REST API for searching code. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/search/search#search-code\">Search code</a>.\"</li>\n<li>The <code>graphql</code> object provides your rate limit status for the GraphQL API. For more information, see \"<a href=\"https://docs.github.com/[email protected]/graphql/overview/resource-limitations#rate-limit\">Resource limitations</a>.\"</li>\n<li>The <code>integration_manifest</code> object provides your rate limit status for the <code>POST /app-manifests/{code}/conversions</code> operation. For more information, see \"<a href=\"https://docs.github.com/[email protected]/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration\">Creating a GitHub App from a manifest</a>.\"</li>\n<li>The <code>dependency_snapshots</code> object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/dependency-graph\">Dependency graph</a>.\"</li>\n<li>The <code>code_scanning_upload</code> object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"<a href=\"https://docs.github.com/[email protected]/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github\">Uploading a SARIF file to GitHub</a>.\"</li>\n<li>The <code>actions_runner_registration</code> object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/actions/self-hosted-runners\">Self-hosted runners</a>.\"</li>\n<li>The <code>source_import</code> object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"<a href=\"https://docs.github.com/[email protected]/rest/about-the-rest-api/api-versions\">API Versions</a>.\"</li>\n</ul>\n<div class=\"ghd-alert ghd-alert-accent\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe <code>rate</code> object is closing down. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>\n</div>",
418694+
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nAccessing this endpoint does not count against your REST API rate limit.</p>\n</div>\n<p>Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under <code>resources</code>, you'll see objects relating to different categories:</p>\n<ul>\n<li>The <code>core</code> object provides your rate limit status for all non-search-related resources in the REST API.</li>\n<li>The <code>search</code> object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/search/search\">Search</a>.\"</li>\n<li>The <code>code_search</code> object provides your rate limit status for the REST API for searching code. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/search/search#search-code\">Search code</a>.\"</li>\n<li>The <code>graphql</code> object provides your rate limit status for the GraphQL API. For more information, see \"<a href=\"https://docs.github.com/[email protected]/graphql/overview/resource-limitations#rate-limit\">Resource limitations</a>.\"</li>\n<li>The <code>integration_manifest</code> object provides your rate limit status for the <code>POST /app-manifests/{code}/conversions</code> operation. For more information, see \"<a href=\"https://docs.github.com/[email protected]/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration\">Creating a GitHub App from a manifest</a>.\"</li>\n<li>The <code>dependency_snapshots</code> object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/dependency-graph\">Dependency graph</a>.\"</li>\n<li>The <code>dependency_sbom</code> object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/dependency-graph\">Dependency graph</a>.\"</li>\n<li>The <code>code_scanning_upload</code> object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"<a href=\"https://docs.github.com/[email protected]/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github\">Uploading a SARIF file to GitHub</a>.\"</li>\n<li>The <code>actions_runner_registration</code> object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/actions/self-hosted-runners\">Self-hosted runners</a>.\"</li>\n<li>The <code>source_import</code> object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"<a href=\"https://docs.github.com/[email protected]/rest/about-the-rest-api/api-versions\">API Versions</a>.\"</li>\n</ul>\n<div class=\"ghd-alert ghd-alert-accent\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe <code>rate</code> object is closing down. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>\n</div>",
418671418695
"statusCodes": [
418672418696
{
418673418697
"httpStatusCode": "200",

src/rest/data/ghes-3.14-2022-11-28/schema.json

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -421852,6 +421852,30 @@
421852421852
"used"
421853421853
]
421854421854
},
421855+
"dependency_sbom": {
421856+
"title": "Rate Limit",
421857+
"type": "object",
421858+
"properties": {
421859+
"limit": {
421860+
"type": "integer"
421861+
},
421862+
"remaining": {
421863+
"type": "integer"
421864+
},
421865+
"reset": {
421866+
"type": "integer"
421867+
},
421868+
"used": {
421869+
"type": "integer"
421870+
}
421871+
},
421872+
"required": [
421873+
"limit",
421874+
"remaining",
421875+
"reset",
421876+
"used"
421877+
]
421878+
},
421855421879
"code_scanning_autofix": {
421856421880
"title": "Rate Limit",
421857421881
"type": "object",
@@ -421916,7 +421940,7 @@
421916421940
}
421917421941
],
421918421942
"previews": [],
421919-
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nAccessing this endpoint does not count against your REST API rate limit.</p>\n</div>\n<p>Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under <code>resources</code>, you'll see objects relating to different categories:</p>\n<ul>\n<li>The <code>core</code> object provides your rate limit status for all non-search-related resources in the REST API.</li>\n<li>The <code>search</code> object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/search/search\">Search</a>.\"</li>\n<li>The <code>code_search</code> object provides your rate limit status for the REST API for searching code. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/search/search#search-code\">Search code</a>.\"</li>\n<li>The <code>graphql</code> object provides your rate limit status for the GraphQL API. For more information, see \"<a href=\"https://docs.github.com/[email protected]/graphql/overview/resource-limitations#rate-limit\">Resource limitations</a>.\"</li>\n<li>The <code>integration_manifest</code> object provides your rate limit status for the <code>POST /app-manifests/{code}/conversions</code> operation. For more information, see \"<a href=\"https://docs.github.com/[email protected]/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration\">Creating a GitHub App from a manifest</a>.\"</li>\n<li>The <code>dependency_snapshots</code> object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/dependency-graph\">Dependency graph</a>.\"</li>\n<li>The <code>code_scanning_upload</code> object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"<a href=\"https://docs.github.com/[email protected]/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github\">Uploading a SARIF file to GitHub</a>.\"</li>\n<li>The <code>actions_runner_registration</code> object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/actions/self-hosted-runners\">Self-hosted runners</a>.\"</li>\n<li>The <code>source_import</code> object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"<a href=\"https://docs.github.com/[email protected]/rest/about-the-rest-api/api-versions\">API Versions</a>.\"</li>\n</ul>\n<div class=\"ghd-alert ghd-alert-accent\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe <code>rate</code> object is closing down. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>\n</div>",
421943+
"descriptionHTML": "<div class=\"ghd-alert ghd-alert-accent\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nAccessing this endpoint does not count against your REST API rate limit.</p>\n</div>\n<p>Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under <code>resources</code>, you'll see objects relating to different categories:</p>\n<ul>\n<li>The <code>core</code> object provides your rate limit status for all non-search-related resources in the REST API.</li>\n<li>The <code>search</code> object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/search/search\">Search</a>.\"</li>\n<li>The <code>code_search</code> object provides your rate limit status for the REST API for searching code. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/search/search#search-code\">Search code</a>.\"</li>\n<li>The <code>graphql</code> object provides your rate limit status for the GraphQL API. For more information, see \"<a href=\"https://docs.github.com/[email protected]/graphql/overview/resource-limitations#rate-limit\">Resource limitations</a>.\"</li>\n<li>The <code>integration_manifest</code> object provides your rate limit status for the <code>POST /app-manifests/{code}/conversions</code> operation. For more information, see \"<a href=\"https://docs.github.com/[email protected]/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration\">Creating a GitHub App from a manifest</a>.\"</li>\n<li>The <code>dependency_snapshots</code> object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/dependency-graph\">Dependency graph</a>.\"</li>\n<li>The <code>dependency_sbom</code> object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/dependency-graph\">Dependency graph</a>.\"</li>\n<li>The <code>code_scanning_upload</code> object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"<a href=\"https://docs.github.com/[email protected]/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github\">Uploading a SARIF file to GitHub</a>.\"</li>\n<li>The <code>actions_runner_registration</code> object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"<a href=\"https://docs.github.com/[email protected]/rest/actions/self-hosted-runners\">Self-hosted runners</a>.\"</li>\n<li>The <code>source_import</code> object is no longer in use for any API endpoints, and it will be removed in the next API version. For more information about API versions, see \"<a href=\"https://docs.github.com/[email protected]/rest/about-the-rest-api/api-versions\">API Versions</a>.\"</li>\n</ul>\n<div class=\"ghd-alert ghd-alert-accent\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThe <code>rate</code> object is closing down. If you're writing new API client code or updating existing code, you should use the <code>core</code> object instead of the <code>rate</code> object. The <code>core</code> object contains the same information that is present in the <code>rate</code> object.</p>\n</div>",
421920421944
"statusCodes": [
421921421945
{
421922421946
"httpStatusCode": "200",

0 commit comments

Comments
 (0)