diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 5412c00934..3a6d78e84e 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -27129,7 +27129,7 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], @@ -98905,6 +98905,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -113480,6 +113485,9 @@ "dependency_snapshots": { "$ref": "#/components/schemas/rate-limit" }, + "dependency_sbom": { + "$ref": "#/components/schemas/rate-limit" + }, "code_scanning_autofix": { "$ref": "#/components/schemas/rate-limit" } @@ -130926,7 +130934,7 @@ "type": "object", "properties": { "app": { - "$ref": "#/components/schemas/nullable-integration" + "$ref": "#/components/schemas/integration" }, "check_suite": { "$ref": "#/components/schemas/simple-check-suite" @@ -272641,7 +272649,20 @@ "resolution_comment": "Example comment", "validity": "active", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -272733,7 +272754,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] }, @@ -293853,7 +293879,20 @@ "resolution_comment": "Example comment", "validity": "inactive", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -293878,7 +293917,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] }, diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 4e06f7d9fc..7293229df7 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -19715,6 +19715,7 @@ paths: * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/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)." * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." * The `source_import` 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 "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." @@ -71855,6 +71856,10 @@ components: - enabled - disabled - not_set + code_scanning_options: + type: object + description: Feature options for code scanning + nullable: true code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -83480,6 +83485,8 @@ components: "$ref": "#/components/schemas/rate-limit" dependency_snapshots: "$ref": "#/components/schemas/rate-limit" + dependency_sbom: + "$ref": "#/components/schemas/rate-limit" code_scanning_autofix: "$ref": "#/components/schemas/rate-limit" required: @@ -96775,7 +96782,7 @@ components: type: object properties: app: - "$ref": "#/components/schemas/nullable-integration" + "$ref": "#/components/schemas/integration" check_suite: "$ref": "#/components/schemas/simple-check-suite" completed_at: @@ -204269,6 +204276,18 @@ components: validity: active publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -204357,6 +204376,10 @@ components: validity: unknown publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + has_more_locations: false public-events-items: value: - id: '22249084947' @@ -222477,6 +222500,18 @@ components: validity: inactive publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -222500,6 +222535,10 @@ components: validity: unknown publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + has_more_locations: false secret-scanning-alert-open: value: number: 42 diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 5412c00934..3a6d78e84e 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -27129,7 +27129,7 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], @@ -98905,6 +98905,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -113480,6 +113485,9 @@ "dependency_snapshots": { "$ref": "#/components/schemas/rate-limit" }, + "dependency_sbom": { + "$ref": "#/components/schemas/rate-limit" + }, "code_scanning_autofix": { "$ref": "#/components/schemas/rate-limit" } @@ -130926,7 +130934,7 @@ "type": "object", "properties": { "app": { - "$ref": "#/components/schemas/nullable-integration" + "$ref": "#/components/schemas/integration" }, "check_suite": { "$ref": "#/components/schemas/simple-check-suite" @@ -272641,7 +272649,20 @@ "resolution_comment": "Example comment", "validity": "active", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -272733,7 +272754,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] }, @@ -293853,7 +293879,20 @@ "resolution_comment": "Example comment", "validity": "inactive", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -293878,7 +293917,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] }, diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 4e06f7d9fc..7293229df7 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -19715,6 +19715,7 @@ paths: * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/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)." * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." * The `source_import` 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 "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." @@ -71855,6 +71856,10 @@ components: - enabled - disabled - not_set + code_scanning_options: + type: object + description: Feature options for code scanning + nullable: true code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -83480,6 +83485,8 @@ components: "$ref": "#/components/schemas/rate-limit" dependency_snapshots: "$ref": "#/components/schemas/rate-limit" + dependency_sbom: + "$ref": "#/components/schemas/rate-limit" code_scanning_autofix: "$ref": "#/components/schemas/rate-limit" required: @@ -96775,7 +96782,7 @@ components: type: object properties: app: - "$ref": "#/components/schemas/nullable-integration" + "$ref": "#/components/schemas/integration" check_suite: "$ref": "#/components/schemas/simple-check-suite" completed_at: @@ -204269,6 +204276,18 @@ components: validity: active publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -204357,6 +204376,10 @@ components: validity: unknown publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + has_more_locations: false public-events-items: value: - id: '22249084947' @@ -222477,6 +222500,18 @@ components: validity: inactive publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -222500,6 +222535,10 @@ components: validity: unknown publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + has_more_locations: false secret-scanning-alert-open: value: number: 42 diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index cdc15b5856..7d209d4897 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -16396,6 +16396,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -17024,6 +17029,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -17475,6 +17485,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -17859,6 +17874,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -18447,6 +18467,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -19253,6 +19278,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -23487,7 +23517,20 @@ "resolution_comment": "Example comment", "validity": "active", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -23579,7 +23622,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] } @@ -71112,6 +71160,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -71787,6 +71840,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -72130,6 +72188,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -72775,6 +72838,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -73405,6 +73473,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -74074,6 +74147,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -138862,7 +138940,20 @@ "resolution_comment": "Example comment", "validity": "active", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -138954,7 +139045,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] } @@ -160268,7 +160364,7 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], @@ -160531,6 +160627,30 @@ "used" ] }, + "dependency_sbom": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, "code_scanning_autofix": { "title": "Rate Limit", "type": "object", @@ -234777,6 +234897,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -422042,7 +422167,20 @@ "resolution_comment": "Example comment", "validity": "inactive", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -422067,7 +422205,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] } diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 0e6bdfccca..1052d93763 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -7084,6 +7084,10 @@ paths: - enabled - disabled - not_set + code_scanning_options: + type: object + description: Feature options for code scanning + nullable: true code_scanning_default_setup: type: string description: The enablement status of code scanning default @@ -9936,6 +9940,18 @@ paths: validity: active publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -10024,6 +10040,10 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + has_more_locations: false headers: Link: *58 '404': *6 @@ -43004,6 +43024,7 @@ paths: * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/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)." * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." * The `source_import` 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 "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." @@ -43056,6 +43077,7 @@ paths: actions_runner_registration: *293 scim: *293 dependency_snapshots: *293 + dependency_sbom: *293 code_scanning_autofix: *293 required: - core @@ -84453,6 +84475,18 @@ paths: validity: inactive publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -84476,6 +84510,10 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + has_more_locations: false '404': description: Repository is public or secret scanning is disabled for the repository @@ -102329,17 +102367,7 @@ x-webhooks: description: A check performed on the code of a given code change type: object properties: - app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: *61 - required: *62 + app: *5 check_suite: description: A suite of checks performed on the code of a given code change diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index cdc15b5856..7d209d4897 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -16396,6 +16396,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -17024,6 +17029,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -17475,6 +17485,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -17859,6 +17874,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -18447,6 +18467,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -19253,6 +19278,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -23487,7 +23517,20 @@ "resolution_comment": "Example comment", "validity": "active", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -23579,7 +23622,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] } @@ -71112,6 +71160,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -71787,6 +71840,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -72130,6 +72188,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -72775,6 +72838,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -73405,6 +73473,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -74074,6 +74147,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -138862,7 +138940,20 @@ "resolution_comment": "Example comment", "validity": "active", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -138954,7 +139045,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] } @@ -160268,7 +160364,7 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], @@ -160531,6 +160627,30 @@ "used" ] }, + "dependency_sbom": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, "code_scanning_autofix": { "title": "Rate Limit", "type": "object", @@ -234777,6 +234897,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -422042,7 +422167,20 @@ "resolution_comment": "Example comment", "validity": "inactive", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -422067,7 +422205,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] } diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 0e6bdfccca..1052d93763 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -7084,6 +7084,10 @@ paths: - enabled - disabled - not_set + code_scanning_options: + type: object + description: Feature options for code scanning + nullable: true code_scanning_default_setup: type: string description: The enablement status of code scanning default @@ -9936,6 +9940,18 @@ paths: validity: active publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -10024,6 +10040,10 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + has_more_locations: false headers: Link: *58 '404': *6 @@ -43004,6 +43024,7 @@ paths: * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/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)." * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." + * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/rest/dependency-graph)." * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/rest/actions/self-hosted-runners)." * The `source_import` 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 "[API Versions](https://docs.github.com/rest/about-the-rest-api/api-versions)." @@ -43056,6 +43077,7 @@ paths: actions_runner_registration: *293 scim: *293 dependency_snapshots: *293 + dependency_sbom: *293 code_scanning_autofix: *293 required: - core @@ -84453,6 +84475,18 @@ paths: validity: inactive publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -84476,6 +84510,10 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + has_more_locations: false '404': description: Repository is public or secret scanning is disabled for the repository @@ -102329,17 +102367,7 @@ x-webhooks: description: A check performed on the code of a given code change type: object properties: - app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: *61 - required: *62 + app: *5 check_suite: description: A suite of checks performed on the code of a given code change diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index 46a6de29d2..c3db82604f 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -28046,6 +28046,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -28674,6 +28679,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -29125,6 +29135,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -29509,6 +29524,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -30097,6 +30117,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -30903,6 +30928,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -47371,7 +47401,20 @@ "resolution_comment": "Example comment", "validity": "active", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -47463,7 +47506,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] } @@ -47902,6 +47950,14 @@ "type": "string", "description": "Name of the cost center." }, + "state": { + "type": "string", + "description": "State of the cost center.", + "enum": [ + "active", + "deleted" + ] + }, "resources": { "type": "array", "items": { @@ -47939,10 +47995,15 @@ { "id": "2eeb8ffe-6903-11ee-8c99-0242ac120002", "name": "Cost Center Name", + "state": "active", "resources": [ { "type": "User", "name": "Monalisa" + }, + { + "type": "Repo", + "name": "octocat/hello-world" } ] } @@ -99031,6 +99092,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -99706,6 +99772,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -100049,6 +100120,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -100694,6 +100770,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -101324,6 +101405,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -101993,6 +102079,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -171828,7 +171919,20 @@ "resolution_comment": "Example comment", "validity": "active", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -171920,7 +172024,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] } @@ -194254,7 +194363,7 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], @@ -194517,6 +194626,30 @@ "used" ] }, + "dependency_sbom": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, "code_scanning_autofix": { "title": "Rate Limit", "type": "object", @@ -271052,6 +271185,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -459674,7 +459812,20 @@ "resolution_comment": "Example comment", "validity": "inactive", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -459699,7 +459850,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] } diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index b9e8db34e7..40794ac5f8 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -12146,6 +12146,10 @@ paths: - enabled - disabled - not_set + code_scanning_options: + type: object + description: Feature options for code scanning + nullable: true code_scanning_default_setup: type: string description: The enablement status of code scanning default @@ -18158,6 +18162,18 @@ paths: validity: active publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -18246,6 +18262,10 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + has_more_locations: false headers: Link: *40 '404': *6 @@ -18514,6 +18534,12 @@ paths: name: type: string description: Name of the cost center. + state: + type: string + description: State of the cost center. + enum: + - active + - deleted resources: type: array items: @@ -18538,9 +18564,12 @@ paths: costCenters: - id: 2eeb8ffe-6903-11ee-8c99-0242ac120002 name: Cost Center Name + state: active resources: - type: User name: Monalisa + - type: Repo + name: octocat/hello-world '400': *14 '403': *29 '500': *85 @@ -50986,6 +51015,7 @@ paths: * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit)." * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//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)." * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." + * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners)." * The `source_import` 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 "[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions)." @@ -51038,6 +51068,7 @@ paths: actions_runner_registration: *393 scim: *393 dependency_snapshots: *393 + dependency_sbom: *393 code_scanning_autofix: *393 required: - core @@ -93034,6 +93065,18 @@ paths: validity: inactive publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -93057,6 +93100,10 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + has_more_locations: false '404': description: Repository is public or secret scanning is disabled for the repository @@ -114052,17 +114099,7 @@ x-webhooks: description: A check performed on the code of a given code change type: object properties: - app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: *140 - required: *141 + app: *5 check_suite: description: A suite of checks performed on the code of a given code change diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index 46a6de29d2..c3db82604f 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -28046,6 +28046,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -28674,6 +28679,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -29125,6 +29135,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -29509,6 +29524,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -30097,6 +30117,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -30903,6 +30928,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -47371,7 +47401,20 @@ "resolution_comment": "Example comment", "validity": "active", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -47463,7 +47506,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] } @@ -47902,6 +47950,14 @@ "type": "string", "description": "Name of the cost center." }, + "state": { + "type": "string", + "description": "State of the cost center.", + "enum": [ + "active", + "deleted" + ] + }, "resources": { "type": "array", "items": { @@ -47939,10 +47995,15 @@ { "id": "2eeb8ffe-6903-11ee-8c99-0242ac120002", "name": "Cost Center Name", + "state": "active", "resources": [ { "type": "User", "name": "Monalisa" + }, + { + "type": "Repo", + "name": "octocat/hello-world" } ] } @@ -99031,6 +99092,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -99706,6 +99772,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -100049,6 +100120,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -100694,6 +100770,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -101324,6 +101405,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -101993,6 +102079,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -171828,7 +171919,20 @@ "resolution_comment": "Example comment", "validity": "active", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -171920,7 +172024,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] } @@ -194254,7 +194363,7 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], @@ -194517,6 +194626,30 @@ "used" ] }, + "dependency_sbom": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, "code_scanning_autofix": { "title": "Rate Limit", "type": "object", @@ -271052,6 +271185,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -459674,7 +459812,20 @@ "resolution_comment": "Example comment", "validity": "inactive", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -459699,7 +459850,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] } diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index b9e8db34e7..40794ac5f8 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -12146,6 +12146,10 @@ paths: - enabled - disabled - not_set + code_scanning_options: + type: object + description: Feature options for code scanning + nullable: true code_scanning_default_setup: type: string description: The enablement status of code scanning default @@ -18158,6 +18162,18 @@ paths: validity: active publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -18246,6 +18262,10 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + has_more_locations: false headers: Link: *40 '404': *6 @@ -18514,6 +18534,12 @@ paths: name: type: string description: Name of the cost center. + state: + type: string + description: State of the cost center. + enum: + - active + - deleted resources: type: array items: @@ -18538,9 +18564,12 @@ paths: costCenters: - id: 2eeb8ffe-6903-11ee-8c99-0242ac120002 name: Cost Center Name + state: active resources: - type: User name: Monalisa + - type: Repo + name: octocat/hello-world '400': *14 '403': *29 '500': *85 @@ -50986,6 +51015,7 @@ paths: * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit)." * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//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)." * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." + * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners)." * The `source_import` 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 "[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions)." @@ -51038,6 +51068,7 @@ paths: actions_runner_registration: *393 scim: *393 dependency_snapshots: *393 + dependency_sbom: *393 code_scanning_autofix: *393 required: - core @@ -93034,6 +93065,18 @@ paths: validity: inactive publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -93057,6 +93100,10 @@ paths: validity: unknown publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + has_more_locations: false '404': description: Repository is public or secret scanning is disabled for the repository @@ -114052,17 +114099,7 @@ x-webhooks: description: A check performed on the code of a given code change type: object properties: - app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: *140 - required: *141 + app: *5 check_suite: description: A suite of checks performed on the code of a given code change diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 1deef6086b..4f2f17db6e 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -34821,7 +34821,7 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], @@ -113180,6 +113180,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -117065,6 +117070,14 @@ "type": "string", "description": "Name of the cost center." }, + "state": { + "type": "string", + "description": "State of the cost center.", + "enum": [ + "active", + "deleted" + ] + }, "resources": { "type": "array", "items": { @@ -127827,6 +127840,9 @@ "dependency_snapshots": { "$ref": "#/components/schemas/rate-limit" }, + "dependency_sbom": { + "$ref": "#/components/schemas/rate-limit" + }, "code_scanning_autofix": { "$ref": "#/components/schemas/rate-limit" } @@ -146534,7 +146550,7 @@ "type": "object", "properties": { "app": { - "$ref": "#/components/schemas/nullable-integration" + "$ref": "#/components/schemas/integration" }, "check_suite": { "$ref": "#/components/schemas/simple-check-suite" @@ -289943,7 +289959,20 @@ "resolution_comment": "Example comment", "validity": "active", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -290035,7 +290064,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] }, @@ -290094,10 +290128,15 @@ { "id": "2eeb8ffe-6903-11ee-8c99-0242ac120002", "name": "Cost Center Name", + "state": "active", "resources": [ { "type": "User", "name": "Monalisa" + }, + { + "type": "Repo", + "name": "octocat/hello-world" } ] } @@ -310810,7 +310849,20 @@ "resolution_comment": "Example comment", "validity": "inactive", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -310835,7 +310887,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] }, diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index bfb1a4ea85..fc09754ff0 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -25234,6 +25234,7 @@ paths: * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit)." * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//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)." * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." + * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners)." * The `source_import` 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 "[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions)." @@ -82268,6 +82269,10 @@ components: - enabled - disabled - not_set + code_scanning_options: + type: object + description: Feature options for code scanning + nullable: true code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -85299,6 +85304,12 @@ components: name: type: string description: Name of the cost center. + state: + type: string + description: State of the cost center. + enum: + - active + - deleted resources: type: array items: @@ -93878,6 +93889,8 @@ components: "$ref": "#/components/schemas/rate-limit" dependency_snapshots: "$ref": "#/components/schemas/rate-limit" + dependency_sbom: + "$ref": "#/components/schemas/rate-limit" code_scanning_autofix: "$ref": "#/components/schemas/rate-limit" required: @@ -108098,7 +108111,7 @@ components: type: object properties: app: - "$ref": "#/components/schemas/nullable-integration" + "$ref": "#/components/schemas/integration" check_suite: "$ref": "#/components/schemas/simple-check-suite" completed_at: @@ -216843,6 +216856,18 @@ components: validity: active publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -216931,6 +216956,10 @@ components: validity: unknown publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + has_more_locations: false actions-billing-usage: value: total_minutes_used: 305 @@ -216967,9 +216996,12 @@ components: costCenters: - id: 2eeb8ffe-6903-11ee-8c99-0242ac120002 name: Cost Center Name + state: active resources: - type: User name: Monalisa + - type: Repo + name: octocat/hello-world packages-billing-usage: value: total_gigabytes_bandwidth_used: 50 @@ -234769,6 +234801,18 @@ components: validity: inactive publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -234792,6 +234836,10 @@ components: validity: unknown publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + has_more_locations: false secret-scanning-alert-open: value: number: 42 diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index 1deef6086b..4f2f17db6e 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -34821,7 +34821,7 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-cloud@latest//rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-cloud@latest//rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], @@ -113180,6 +113180,11 @@ "not_set" ] }, + "code_scanning_options": { + "type": "object", + "description": "Feature options for code scanning", + "nullable": true + }, "code_scanning_default_setup": { "type": "string", "description": "The enablement status of code scanning default setup", @@ -117065,6 +117070,14 @@ "type": "string", "description": "Name of the cost center." }, + "state": { + "type": "string", + "description": "State of the cost center.", + "enum": [ + "active", + "deleted" + ] + }, "resources": { "type": "array", "items": { @@ -127827,6 +127840,9 @@ "dependency_snapshots": { "$ref": "#/components/schemas/rate-limit" }, + "dependency_sbom": { + "$ref": "#/components/schemas/rate-limit" + }, "code_scanning_autofix": { "$ref": "#/components/schemas/rate-limit" } @@ -146534,7 +146550,7 @@ "type": "object", "properties": { "app": { - "$ref": "#/components/schemas/nullable-integration" + "$ref": "#/components/schemas/integration" }, "check_suite": { "$ref": "#/components/schemas/simple-check-suite" @@ -289943,7 +289959,20 @@ "resolution_comment": "Example comment", "validity": "active", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -290035,7 +290064,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] }, @@ -290094,10 +290128,15 @@ { "id": "2eeb8ffe-6903-11ee-8c99-0242ac120002", "name": "Cost Center Name", + "state": "active", "resources": [ { "type": "User", "name": "Monalisa" + }, + { + "type": "Repo", + "name": "octocat/hello-world" } ] } @@ -310810,7 +310849,20 @@ "resolution_comment": "Example comment", "validity": "inactive", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "path": "/example/secrets.txt", + "start_line": 1, + "end_line": 1, + "start_column": 1, + "end_column": 64, + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", + "blob_url": "https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b", + "commit_sha": "f14d7debf9775f957cf4f1e8176da0786431f72b", + "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b" + }, + "has_more_locations": true }, { "number": 1, @@ -310835,7 +310887,12 @@ "resolution_comment": null, "validity": "unknown", "publicly_leaked": false, - "multi_repo": false + "multi_repo": false, + "is_base64_encoded": false, + "first_location_detected": { + "issue_title_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + }, + "has_more_locations": false } ] }, diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index bfb1a4ea85..fc09754ff0 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -25234,6 +25234,7 @@ paths: * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-cloud@latest//graphql/overview/resource-limitations#rate-limit)." * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-cloud@latest//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)." * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." + * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-cloud@latest//rest/dependency-graph)." * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-cloud@latest//rest/actions/self-hosted-runners)." * The `source_import` 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 "[API Versions](https://docs.github.com/enterprise-cloud@latest//rest/about-the-rest-api/api-versions)." @@ -82268,6 +82269,10 @@ components: - enabled - disabled - not_set + code_scanning_options: + type: object + description: Feature options for code scanning + nullable: true code_scanning_default_setup: type: string description: The enablement status of code scanning default setup @@ -85299,6 +85304,12 @@ components: name: type: string description: Name of the cost center. + state: + type: string + description: State of the cost center. + enum: + - active + - deleted resources: type: array items: @@ -93878,6 +93889,8 @@ components: "$ref": "#/components/schemas/rate-limit" dependency_snapshots: "$ref": "#/components/schemas/rate-limit" + dependency_sbom: + "$ref": "#/components/schemas/rate-limit" code_scanning_autofix: "$ref": "#/components/schemas/rate-limit" required: @@ -108098,7 +108111,7 @@ components: type: object properties: app: - "$ref": "#/components/schemas/nullable-integration" + "$ref": "#/components/schemas/integration" check_suite: "$ref": "#/components/schemas/simple-check-suite" completed_at: @@ -216843,6 +216856,18 @@ components: validity: active publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -216931,6 +216956,10 @@ components: validity: unknown publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + has_more_locations: false actions-billing-usage: value: total_minutes_used: 305 @@ -216967,9 +216996,12 @@ components: costCenters: - id: 2eeb8ffe-6903-11ee-8c99-0242ac120002 name: Cost Center Name + state: active resources: - type: User name: Monalisa + - type: Repo + name: octocat/hello-world packages-billing-usage: value: total_gigabytes_bandwidth_used: 50 @@ -234769,6 +234801,18 @@ components: validity: inactive publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + path: "/example/secrets.txt" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b + commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b + commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + has_more_locations: true - number: 1 created_at: '2020-11-06T18:18:30Z' url: https://api.github.com/repos/owner/repo/secret-scanning/alerts/1 @@ -234792,6 +234836,10 @@ components: validity: unknown publicly_leaked: false multi_repo: false + is_base64_encoded: false + first_location_detected: + issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 + has_more_locations: false secret-scanning-alert-open: value: number: 42 diff --git a/descriptions/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.json b/descriptions/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.json index 4473f49180..b07afeee13 100644 --- a/descriptions/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.json +++ b/descriptions/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.json @@ -146538,7 +146538,7 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-server@3.13/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-server@3.13/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-server@3.13/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.13/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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/enterprise-server@3.13/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-server@3.13/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-server@3.13/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-server@3.13/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.13/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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/enterprise-server@3.13/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], @@ -146777,6 +146777,30 @@ "used" ] }, + "dependency_sbom": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, "code_scanning_autofix": { "title": "Rate Limit", "type": "object", diff --git a/descriptions/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.yaml b/descriptions/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.yaml index 417c48ca72..3e4be58732 100644 --- a/descriptions/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.yaml +++ b/descriptions/ghes-3.13/dereferenced/ghes-3.13.2022-11-28.deref.yaml @@ -38706,6 +38706,7 @@ paths: * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.13/graphql/overview/resource-limitations#rate-limit)." * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.13/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)." * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph)." + * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph)." * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners)." * The `source_import` 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 "[API Versions](https://docs.github.com/enterprise-server@3.13/rest/about-the-rest-api/api-versions)." @@ -38757,6 +38758,7 @@ paths: code_scanning_upload: *292 actions_runner_registration: *292 scim: *292 + dependency_sbom: *292 code_scanning_autofix: *292 required: - core @@ -91739,17 +91741,7 @@ x-webhooks: description: A check performed on the code of a given code change type: object properties: - app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: *106 - required: *107 + app: *25 check_suite: description: A suite of checks performed on the code of a given code change diff --git a/descriptions/ghes-3.13/dereferenced/ghes-3.13.deref.json b/descriptions/ghes-3.13/dereferenced/ghes-3.13.deref.json index 4473f49180..b07afeee13 100644 --- a/descriptions/ghes-3.13/dereferenced/ghes-3.13.deref.json +++ b/descriptions/ghes-3.13/dereferenced/ghes-3.13.deref.json @@ -146538,7 +146538,7 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-server@3.13/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-server@3.13/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-server@3.13/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.13/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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/enterprise-server@3.13/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-server@3.13/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-server@3.13/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-server@3.13/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.13/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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/enterprise-server@3.13/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], @@ -146777,6 +146777,30 @@ "used" ] }, + "dependency_sbom": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, "code_scanning_autofix": { "title": "Rate Limit", "type": "object", diff --git a/descriptions/ghes-3.13/dereferenced/ghes-3.13.deref.yaml b/descriptions/ghes-3.13/dereferenced/ghes-3.13.deref.yaml index 417c48ca72..3e4be58732 100644 --- a/descriptions/ghes-3.13/dereferenced/ghes-3.13.deref.yaml +++ b/descriptions/ghes-3.13/dereferenced/ghes-3.13.deref.yaml @@ -38706,6 +38706,7 @@ paths: * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.13/graphql/overview/resource-limitations#rate-limit)." * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.13/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)." * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph)." + * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph)." * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners)." * The `source_import` 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 "[API Versions](https://docs.github.com/enterprise-server@3.13/rest/about-the-rest-api/api-versions)." @@ -38757,6 +38758,7 @@ paths: code_scanning_upload: *292 actions_runner_registration: *292 scim: *292 + dependency_sbom: *292 code_scanning_autofix: *292 required: - core @@ -91739,17 +91741,7 @@ x-webhooks: description: A check performed on the code of a given code change type: object properties: - app: - title: GitHub app - description: GitHub apps are a new way to extend GitHub. They - can be installed directly on organizations and user accounts - and granted access to specific repositories. They come with - granular permissions and built-in webhooks. GitHub apps are - first class actors within GitHub. - type: object - nullable: true - properties: *106 - required: *107 + app: *25 check_suite: description: A suite of checks performed on the code of a given code change diff --git a/descriptions/ghes-3.13/ghes-3.13.2022-11-28.json b/descriptions/ghes-3.13/ghes-3.13.2022-11-28.json index 02f6ab9c81..3a491f388c 100644 --- a/descriptions/ghes-3.13/ghes-3.13.2022-11-28.json +++ b/descriptions/ghes-3.13/ghes-3.13.2022-11-28.json @@ -25944,7 +25944,7 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-server@3.13/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-server@3.13/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-server@3.13/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.13/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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/enterprise-server@3.13/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-server@3.13/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-server@3.13/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-server@3.13/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.13/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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/enterprise-server@3.13/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], @@ -106330,6 +106330,9 @@ "scim": { "$ref": "#/components/schemas/rate-limit" }, + "dependency_sbom": { + "$ref": "#/components/schemas/rate-limit" + }, "code_scanning_autofix": { "$ref": "#/components/schemas/rate-limit" } @@ -122637,7 +122640,7 @@ "type": "object", "properties": { "app": { - "$ref": "#/components/schemas/nullable-integration" + "$ref": "#/components/schemas/integration" }, "check_suite": { "$ref": "#/components/schemas/simple-check-suite" diff --git a/descriptions/ghes-3.13/ghes-3.13.2022-11-28.yaml b/descriptions/ghes-3.13/ghes-3.13.2022-11-28.yaml index 766f3ae4cc..e60c4e8f63 100644 --- a/descriptions/ghes-3.13/ghes-3.13.2022-11-28.yaml +++ b/descriptions/ghes-3.13/ghes-3.13.2022-11-28.yaml @@ -18570,6 +18570,7 @@ paths: * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.13/graphql/overview/resource-limitations#rate-limit)." * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.13/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)." * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph)." + * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph)." * The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see "[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github)." * The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see "[Self-hosted runners](https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners)." * The `source_import` 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 "[API Versions](https://docs.github.com/enterprise-server@3.13/rest/about-the-rest-api/api-versions)." @@ -77246,6 +77247,8 @@ components: "$ref": "#/components/schemas/rate-limit" scim: "$ref": "#/components/schemas/rate-limit" + dependency_sbom: + "$ref": "#/components/schemas/rate-limit" code_scanning_autofix: "$ref": "#/components/schemas/rate-limit" required: @@ -89591,7 +89594,7 @@ components: type: object properties: app: - "$ref": "#/components/schemas/nullable-integration" + "$ref": "#/components/schemas/integration" check_suite: "$ref": "#/components/schemas/simple-check-suite" completed_at: diff --git a/descriptions/ghes-3.13/ghes-3.13.json b/descriptions/ghes-3.13/ghes-3.13.json index 02f6ab9c81..3a491f388c 100644 --- a/descriptions/ghes-3.13/ghes-3.13.json +++ b/descriptions/ghes-3.13/ghes-3.13.json @@ -25944,7 +25944,7 @@ "/rate_limit": { "get": { "summary": "Get rate limit status for the authenticated user", - "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-server@3.13/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-server@3.13/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-server@3.13/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.13/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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/enterprise-server@3.13/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "description": "> [!NOTE]\n> Accessing this endpoint does not count against your REST API rate limit.\n\nSome 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 `resources`, you'll see objects relating to different categories:\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see \"[Search](https://docs.github.com/enterprise-server@3.13/rest/search/search).\"\n* The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see \"[Search code](https://docs.github.com/enterprise-server@3.13/rest/search/search#search-code).\"\n* The `graphql` object provides your rate limit status for the GraphQL API. For more information, see \"[Resource limitations](https://docs.github.com/enterprise-server@3.13/graphql/overview/resource-limitations#rate-limit).\"\n* The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see \"[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.13/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).\"\n* The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph).\"\n* The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see \"[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph).\"\n* The `code_scanning_upload` object provides your rate limit status for uploading SARIF results to code scanning. For more information, see \"[Uploading a SARIF file to GitHub](https://docs.github.com/enterprise-server@3.13/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github).\"\n* The `actions_runner_registration` object provides your rate limit status for registering self-hosted runners in GitHub Actions. For more information, see \"[Self-hosted runners](https://docs.github.com/enterprise-server@3.13/rest/actions/self-hosted-runners).\"\n* The `source_import` 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 \"[API Versions](https://docs.github.com/enterprise-server@3.13/rest/about-the-rest-api/api-versions).\"\n\n> [!NOTE]\n> The `rate` object is closing down. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", "tags": [ "rate-limit" ], @@ -106330,6 +106330,9 @@ "scim": { "$ref": "#/components/schemas/rate-limit" }, + "dependency_sbom": { + "$ref": "#/components/schemas/rate-limit" + }, "code_scanning_autofix": { "$ref": "#/components/schemas/rate-limit" } @@ -122637,7 +122640,7 @@ "type": "object", "properties": { "app": { - "$ref": "#/components/schemas/nullable-integration" + "$ref": "#/components/schemas/integration" }, "check_suite": { "$ref": "#/components/schemas/simple-check-suite" diff --git a/descriptions/ghes-3.13/ghes-3.13.yaml b/descriptions/ghes-3.13/ghes-3.13.yaml index 766f3ae4cc..e60c4e8f63 100644 --- a/descriptions/ghes-3.13/ghes-3.13.yaml +++ b/descriptions/ghes-3.13/ghes-3.13.yaml @@ -18570,6 +18570,7 @@ paths: * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/enterprise-server@3.13/graphql/overview/resource-limitations#rate-limit)." * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/enterprise-server@3.13/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)." * The `dependency_snapshots` object provides your rate limit status for submitting snapshots to the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph)." + * The `dependency_sbom` object provides your rate limit status for requesting SBOMs from the dependency graph. For more information, see "[Dependency graph](https://docs.github.com/enterprise-server@3.13/rest/dependency-graph){"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}