diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 5e24ec116..9c8005b30 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -2259,7 +2259,7 @@ "/enterprises/{enterprise}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for enterprise members", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nThe time zone in the response is in UTC time, that means that the cutoff time for the \"day\" is UTC time.\n\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -97691,6 +97691,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -98281,6 +98286,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -104958,6 +104968,33 @@ } } }, + "repository-rule-params-required-reviewer-configuration": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer_id": { + "type": "string", + "description": "Node ID of the team which must review changes to matching files." + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer_id" + ] + }, "repository-rule-pull-request": { "title": "pull_request", "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", @@ -115959,6 +115996,13 @@ "SPDX-2.3" ] }, + "comment": { + "type": "string", + "description": "An optional comment about the SPDX document.", + "examples": [ + "Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/" + ] + }, "creationInfo": { "type": "object", "properties": { @@ -115999,21 +116043,11 @@ "CC0-1.0" ] }, - "documentDescribes": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "github/github" - ] - }, - "description": "The name of the repository that the SPDX document describes." - }, "documentNamespace": { "type": "string", "description": "The namespace for the SPDX document.", "examples": [ - "https://github.com/example/dependency_graph/sbom-123" + "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57" ] }, "packages": { @@ -116032,7 +116066,7 @@ "type": "string", "description": "The name of the package.", "examples": [ - "rubygems:github/github" + "github/github" ] }, "versionInfo": { @@ -116125,8 +116159,35 @@ "name", "versionInfo", "downloadLocation", - "filesAnalyzed", - "supplier" + "filesAnalyzed" + ] + }, + "relationships": { + "type": "array", + "items": { + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of relationship between the two SPDX elements.", + "examples": [ + "DEPENDS_ON" + ] + }, + "spdxElementId": { + "type": "string", + "description": "The SPDX identifier of the package that is the source of the relationship." + }, + "relatedSpdxElement": { + "type": "string", + "description": "The SPDX identifier of the package that is the target of the relationship." + } + } + }, + "required": [ + "relationshipType", + "spdxElementId", + "relatedSpdxElement" ] } }, @@ -116136,7 +116197,6 @@ "creationInfo", "name", "dataLicense", - "documentDescribes", "documentNamespace", "packages" ] @@ -274320,7 +274380,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -288945,20 +289006,50 @@ }, "name": "github/example", "dataLicense": "CC0-1.0", - "documentDescribes": [ - "github/example" - ], - "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456", + "documentNamespace": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "packages": [ { + "name": "rails", "SPDXID": "SPDXRef-Package", - "name": "rubygems:rails", "versionInfo": "1.0.0", "downloadLocation": "NOASSERTION", "filesAnalyzed": false, "licenseConcluded": "MIT", "licenseDeclared": "MIT", - "copyrightText": "Copyright (c) 1985 GitHub.com" + "copyrightText": "Copyright (c) 1985 GitHub.com", + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:gem/rails@1.0.0" + } + ] + }, + { + "name": "github/example", + "SPDXID": "SPDXRef-Repository", + "versionInfo": "main", + "downloadLocation": "NOASSERTION", + "filesAnalyzed": false, + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:github/example@main" + } + ] + } + ], + "relationships": [ + { + "relationshipType": "DEPENDS_ON", + "spdxElementId": "SPDXRef-Repository", + "relatedSpdxElement": "SPDXRef-Package" + }, + { + "relationshipType": "DESCRIBES", + "spdxElementId": "SPDXRef-DOCUMENT", + "relatedSpdxElement": "SPDXRef-Repository" } ] } diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 4b7a9412b..3009f959a 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -1592,6 +1592,8 @@ paths: and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE. + The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + Only owners and billing managers can view Copilot usage metrics for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -70752,6 +70754,11 @@ components: type: string size: type: integer + encoding: + type: string + description: The encoding used for `content`. Currently, `"utf-8"` + and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -71165,6 +71172,11 @@ components: type: boolean content: type: string + encoding: + type: string + description: The encoding used for `content`. Currently, `"utf-8"` + and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -76165,6 +76177,31 @@ components: type: string enum: - required_signatures + repository-rule-params-required-reviewer-configuration: + title: RequiredReviewerConfiguration + description: A reviewing team, and file patterns describing which files they + must approve changes to. + type: object + properties: + file_patterns: + type: array + description: Array of file patterns. Pull requests which change matching + files must be approved by the specified team. File patterns use the same + syntax as `.gitignore` files. + items: + type: string + minimum_approvals: + type: integer + description: Minimum number of approvals required from the specified team. + If set to zero, the team will be added to the pull request but approval + is optional. + reviewer_id: + type: string + description: Node ID of the team which must review changes to matching files. + required: + - file_patterns + - minimum_approvals + - reviewer_id repository-rule-pull-request: title: pull_request description: Require all commits be made to a non-target branch and submitted @@ -84106,6 +84143,12 @@ components: conforms to. examples: - SPDX-2.3 + comment: + type: string + description: An optional comment about the SPDX document. + examples: + - 'Exact versions could not be resolved for some packages. For more + information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/' creationInfo: type: object properties: @@ -84134,18 +84177,11 @@ components: description: The license under which the SPDX document is licensed. examples: - CC0-1.0 - documentDescribes: - type: array - items: - type: string - examples: - - github/github - description: The name of the repository that the SPDX document describes. documentNamespace: type: string description: The namespace for the SPDX document. examples: - - https://github.com/example/dependency_graph/sbom-123 + - https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: type: array items: @@ -84160,7 +84196,7 @@ components: type: string description: The name of the package. examples: - - rubygems:github/github + - github/github versionInfo: type: string description: |- @@ -84240,14 +84276,34 @@ components: - versionInfo - downloadLocation - filesAnalyzed - - supplier + relationships: + type: array + items: + type: object + properties: + relationshipType: + type: string + description: The type of relationship between the two SPDX elements. + examples: + - DEPENDS_ON + spdxElementId: + type: string + description: The SPDX identifier of the package that is the source + of the relationship. + relatedSpdxElement: + type: string + description: The SPDX identifier of the package that is the target + of the relationship. + required: + - relationshipType + - spdxElementId + - relatedSpdxElement required: - SPDXID - spdxVersion - creationInfo - name - dataLicense - - documentDescribes - documentNamespace - packages required: @@ -202216,6 +202272,7 @@ components: size: 23 truncated: false content: Hello world from GitHub + encoding: utf-8 public: true created_at: '2022-09-20T12:11:58Z' updated_at: '2022-09-21T10:28:06Z' @@ -214776,18 +214833,36 @@ components: - 'Tool: GitHub.com-Dependency-Graph' name: github/example dataLicense: CC0-1.0 - documentDescribes: - - github/example - documentNamespace: https://github.com/github/example/dependency_graph/sbom-abcdef123456 + documentNamespace: https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: - - SPDXID: SPDXRef-Package - name: rubygems:rails + - name: rails + SPDXID: SPDXRef-Package versionInfo: 1.0.0 downloadLocation: NOASSERTION filesAnalyzed: false licenseConcluded: MIT licenseDeclared: MIT copyrightText: Copyright (c) 1985 GitHub.com + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:gem/rails@1.0.0 + - name: github/example + SPDXID: SPDXRef-Repository + versionInfo: main + downloadLocation: NOASSERTION + filesAnalyzed: false + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:github/example@main + relationships: + - relationshipType: DEPENDS_ON + spdxElementId: SPDXRef-Repository + relatedSpdxElement: SPDXRef-Package + - relationshipType: DESCRIBES + spdxElementId: SPDXRef-DOCUMENT + relatedSpdxElement: SPDXRef-Repository dependency-graph-create-snapshot-request: value: version: 0 diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 5e24ec116..9c8005b30 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -2259,7 +2259,7 @@ "/enterprises/{enterprise}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for enterprise members", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nThe time zone in the response is in UTC time, that means that the cutoff time for the \"day\" is UTC time.\n\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -97691,6 +97691,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -98281,6 +98286,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -104958,6 +104968,33 @@ } } }, + "repository-rule-params-required-reviewer-configuration": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer_id": { + "type": "string", + "description": "Node ID of the team which must review changes to matching files." + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer_id" + ] + }, "repository-rule-pull-request": { "title": "pull_request", "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", @@ -115959,6 +115996,13 @@ "SPDX-2.3" ] }, + "comment": { + "type": "string", + "description": "An optional comment about the SPDX document.", + "examples": [ + "Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/" + ] + }, "creationInfo": { "type": "object", "properties": { @@ -115999,21 +116043,11 @@ "CC0-1.0" ] }, - "documentDescribes": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "github/github" - ] - }, - "description": "The name of the repository that the SPDX document describes." - }, "documentNamespace": { "type": "string", "description": "The namespace for the SPDX document.", "examples": [ - "https://github.com/example/dependency_graph/sbom-123" + "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57" ] }, "packages": { @@ -116032,7 +116066,7 @@ "type": "string", "description": "The name of the package.", "examples": [ - "rubygems:github/github" + "github/github" ] }, "versionInfo": { @@ -116125,8 +116159,35 @@ "name", "versionInfo", "downloadLocation", - "filesAnalyzed", - "supplier" + "filesAnalyzed" + ] + }, + "relationships": { + "type": "array", + "items": { + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of relationship between the two SPDX elements.", + "examples": [ + "DEPENDS_ON" + ] + }, + "spdxElementId": { + "type": "string", + "description": "The SPDX identifier of the package that is the source of the relationship." + }, + "relatedSpdxElement": { + "type": "string", + "description": "The SPDX identifier of the package that is the target of the relationship." + } + } + }, + "required": [ + "relationshipType", + "spdxElementId", + "relatedSpdxElement" ] } }, @@ -116136,7 +116197,6 @@ "creationInfo", "name", "dataLicense", - "documentDescribes", "documentNamespace", "packages" ] @@ -274320,7 +274380,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -288945,20 +289006,50 @@ }, "name": "github/example", "dataLicense": "CC0-1.0", - "documentDescribes": [ - "github/example" - ], - "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456", + "documentNamespace": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "packages": [ { + "name": "rails", "SPDXID": "SPDXRef-Package", - "name": "rubygems:rails", "versionInfo": "1.0.0", "downloadLocation": "NOASSERTION", "filesAnalyzed": false, "licenseConcluded": "MIT", "licenseDeclared": "MIT", - "copyrightText": "Copyright (c) 1985 GitHub.com" + "copyrightText": "Copyright (c) 1985 GitHub.com", + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:gem/rails@1.0.0" + } + ] + }, + { + "name": "github/example", + "SPDXID": "SPDXRef-Repository", + "versionInfo": "main", + "downloadLocation": "NOASSERTION", + "filesAnalyzed": false, + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:github/example@main" + } + ] + } + ], + "relationships": [ + { + "relationshipType": "DEPENDS_ON", + "spdxElementId": "SPDXRef-Repository", + "relatedSpdxElement": "SPDXRef-Package" + }, + { + "relationshipType": "DESCRIBES", + "spdxElementId": "SPDXRef-DOCUMENT", + "relatedSpdxElement": "SPDXRef-Repository" } ] } diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 4b7a9412b..3009f959a 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -1592,6 +1592,8 @@ paths: and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE. + The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + Only owners and billing managers can view Copilot usage metrics for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -70752,6 +70754,11 @@ components: type: string size: type: integer + encoding: + type: string + description: The encoding used for `content`. Currently, `"utf-8"` + and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -71165,6 +71172,11 @@ components: type: boolean content: type: string + encoding: + type: string + description: The encoding used for `content`. Currently, `"utf-8"` + and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -76165,6 +76177,31 @@ components: type: string enum: - required_signatures + repository-rule-params-required-reviewer-configuration: + title: RequiredReviewerConfiguration + description: A reviewing team, and file patterns describing which files they + must approve changes to. + type: object + properties: + file_patterns: + type: array + description: Array of file patterns. Pull requests which change matching + files must be approved by the specified team. File patterns use the same + syntax as `.gitignore` files. + items: + type: string + minimum_approvals: + type: integer + description: Minimum number of approvals required from the specified team. + If set to zero, the team will be added to the pull request but approval + is optional. + reviewer_id: + type: string + description: Node ID of the team which must review changes to matching files. + required: + - file_patterns + - minimum_approvals + - reviewer_id repository-rule-pull-request: title: pull_request description: Require all commits be made to a non-target branch and submitted @@ -84106,6 +84143,12 @@ components: conforms to. examples: - SPDX-2.3 + comment: + type: string + description: An optional comment about the SPDX document. + examples: + - 'Exact versions could not be resolved for some packages. For more + information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/' creationInfo: type: object properties: @@ -84134,18 +84177,11 @@ components: description: The license under which the SPDX document is licensed. examples: - CC0-1.0 - documentDescribes: - type: array - items: - type: string - examples: - - github/github - description: The name of the repository that the SPDX document describes. documentNamespace: type: string description: The namespace for the SPDX document. examples: - - https://github.com/example/dependency_graph/sbom-123 + - https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: type: array items: @@ -84160,7 +84196,7 @@ components: type: string description: The name of the package. examples: - - rubygems:github/github + - github/github versionInfo: type: string description: |- @@ -84240,14 +84276,34 @@ components: - versionInfo - downloadLocation - filesAnalyzed - - supplier + relationships: + type: array + items: + type: object + properties: + relationshipType: + type: string + description: The type of relationship between the two SPDX elements. + examples: + - DEPENDS_ON + spdxElementId: + type: string + description: The SPDX identifier of the package that is the source + of the relationship. + relatedSpdxElement: + type: string + description: The SPDX identifier of the package that is the target + of the relationship. + required: + - relationshipType + - spdxElementId + - relatedSpdxElement required: - SPDXID - spdxVersion - creationInfo - name - dataLicense - - documentDescribes - documentNamespace - packages required: @@ -202216,6 +202272,7 @@ components: size: 23 truncated: false content: Hello world from GitHub + encoding: utf-8 public: true created_at: '2022-09-20T12:11:58Z' updated_at: '2022-09-21T10:28:06Z' @@ -214776,18 +214833,36 @@ components: - 'Tool: GitHub.com-Dependency-Graph' name: github/example dataLicense: CC0-1.0 - documentDescribes: - - github/example - documentNamespace: https://github.com/github/example/dependency_graph/sbom-abcdef123456 + documentNamespace: https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: - - SPDXID: SPDXRef-Package - name: rubygems:rails + - name: rails + SPDXID: SPDXRef-Package versionInfo: 1.0.0 downloadLocation: NOASSERTION filesAnalyzed: false licenseConcluded: MIT licenseDeclared: MIT copyrightText: Copyright (c) 1985 GitHub.com + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:gem/rails@1.0.0 + - name: github/example + SPDXID: SPDXRef-Repository + versionInfo: main + downloadLocation: NOASSERTION + filesAnalyzed: false + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:github/example@main + relationships: + - relationshipType: DEPENDS_ON + spdxElementId: SPDXRef-Repository + relatedSpdxElement: SPDXRef-Package + - relationshipType: DESCRIBES + spdxElementId: SPDXRef-DOCUMENT + relatedSpdxElement: SPDXRef-Repository dependency-graph-create-snapshot-request: value: version: 0 diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 768200447..e926827f9 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -19340,7 +19340,7 @@ "/enterprises/{enterprise}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for enterprise members", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nThe time zone in the response is in UTC time, that means that the cutoff time for the \"day\" is UTC time.\n\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -28176,6 +28176,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -29789,6 +29794,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -30012,7 +30022,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -30334,6 +30345,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -31019,6 +31035,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -32585,6 +32606,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -32808,7 +32834,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -34068,6 +34095,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -34291,7 +34323,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -37872,6 +37905,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -38284,6 +38322,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -40186,6 +40229,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -40409,7 +40457,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -287600,6 +287649,13 @@ "SPDX-2.3" ] }, + "comment": { + "type": "string", + "description": "An optional comment about the SPDX document.", + "examples": [ + "Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/" + ] + }, "creationInfo": { "type": "object", "properties": { @@ -287640,21 +287696,11 @@ "CC0-1.0" ] }, - "documentDescribes": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "github/github" - ] - }, - "description": "The name of the repository that the SPDX document describes." - }, "documentNamespace": { "type": "string", "description": "The namespace for the SPDX document.", "examples": [ - "https://github.com/example/dependency_graph/sbom-123" + "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57" ] }, "packages": { @@ -287673,7 +287719,7 @@ "type": "string", "description": "The name of the package.", "examples": [ - "rubygems:github/github" + "github/github" ] }, "versionInfo": { @@ -287766,8 +287812,35 @@ "name", "versionInfo", "downloadLocation", - "filesAnalyzed", - "supplier" + "filesAnalyzed" + ] + }, + "relationships": { + "type": "array", + "items": { + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of relationship between the two SPDX elements.", + "examples": [ + "DEPENDS_ON" + ] + }, + "spdxElementId": { + "type": "string", + "description": "The SPDX identifier of the package that is the source of the relationship." + }, + "relatedSpdxElement": { + "type": "string", + "description": "The SPDX identifier of the package that is the target of the relationship." + } + } + }, + "required": [ + "relationshipType", + "spdxElementId", + "relatedSpdxElement" ] } }, @@ -287777,7 +287850,6 @@ "creationInfo", "name", "dataLicense", - "documentDescribes", "documentNamespace", "packages" ] @@ -287801,20 +287873,50 @@ }, "name": "github/example", "dataLicense": "CC0-1.0", - "documentDescribes": [ - "github/example" - ], - "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456", + "documentNamespace": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "packages": [ { + "name": "rails", "SPDXID": "SPDXRef-Package", - "name": "rubygems:rails", "versionInfo": "1.0.0", "downloadLocation": "NOASSERTION", "filesAnalyzed": false, "licenseConcluded": "MIT", "licenseDeclared": "MIT", - "copyrightText": "Copyright (c) 1985 GitHub.com" + "copyrightText": "Copyright (c) 1985 GitHub.com", + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:gem/rails@1.0.0" + } + ] + }, + { + "name": "github/example", + "SPDXID": "SPDXRef-Repository", + "versionInfo": "main", + "downloadLocation": "NOASSERTION", + "filesAnalyzed": false, + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:github/example@main" + } + ] + } + ], + "relationships": [ + { + "relationshipType": "DEPENDS_ON", + "spdxElementId": "SPDXRef-Repository", + "relatedSpdxElement": "SPDXRef-Package" + }, + { + "relationshipType": "DESCRIBES", + "spdxElementId": "SPDXRef-DOCUMENT", + "relatedSpdxElement": "SPDXRef-Repository" } ] } @@ -587425,6 +587527,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 5fe5fc88e..733851fcd 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -8194,6 +8194,8 @@ paths: and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE. + The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + Only owners and billing managers can view Copilot usage metrics for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -10974,6 +10976,11 @@ paths: type: string size: type: integer + encoding: + type: string + description: The encoding used for `content`. Currently, + `"utf-8"` and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -11507,6 +11514,11 @@ paths: type: boolean content: type: string + encoding: + type: string + description: The encoding used for `content`. Currently, + `"utf-8"` and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -11548,6 +11560,7 @@ paths: size: 23 truncated: false content: Hello world from GitHub + encoding: utf-8 public: true created_at: '2022-09-20T12:11:58Z' updated_at: '2022-09-21T10:28:06Z' @@ -61744,6 +61757,12 @@ paths: document conforms to. examples: - SPDX-2.3 + comment: + type: string + description: An optional comment about the SPDX document. + examples: + - 'Exact versions could not be resolved for some packages. + For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/' creationInfo: type: object properties: @@ -61774,19 +61793,11 @@ paths: licensed. examples: - CC0-1.0 - documentDescribes: - type: array - items: - type: string - examples: - - github/github - description: The name of the repository that the SPDX document - describes. documentNamespace: type: string description: The namespace for the SPDX document. examples: - - https://github.com/example/dependency_graph/sbom-123 + - https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: type: array items: @@ -61801,7 +61812,7 @@ paths: type: string description: The name of the package. examples: - - rubygems:github/github + - github/github versionInfo: type: string description: |- @@ -61881,14 +61892,35 @@ paths: - versionInfo - downloadLocation - filesAnalyzed - - supplier + relationships: + type: array + items: + type: object + properties: + relationshipType: + type: string + description: The type of relationship between the two + SPDX elements. + examples: + - DEPENDS_ON + spdxElementId: + type: string + description: The SPDX identifier of the package that + is the source of the relationship. + relatedSpdxElement: + type: string + description: The SPDX identifier of the package that + is the target of the relationship. + required: + - relationshipType + - spdxElementId + - relatedSpdxElement required: - SPDXID - spdxVersion - creationInfo - name - dataLicense - - documentDescribes - documentNamespace - packages required: @@ -61905,18 +61937,36 @@ paths: - 'Tool: GitHub.com-Dependency-Graph' name: github/example dataLicense: CC0-1.0 - documentDescribes: - - github/example - documentNamespace: https://github.com/github/example/dependency_graph/sbom-abcdef123456 + documentNamespace: https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: - - SPDXID: SPDXRef-Package - name: rubygems:rails + - name: rails + SPDXID: SPDXRef-Package versionInfo: 1.0.0 downloadLocation: NOASSERTION filesAnalyzed: false licenseConcluded: MIT licenseDeclared: MIT copyrightText: Copyright (c) 1985 GitHub.com + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:gem/rails@1.0.0 + - name: github/example + SPDXID: SPDXRef-Repository + versionInfo: main + downloadLocation: NOASSERTION + filesAnalyzed: false + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:github/example@main + relationships: + - relationshipType: DEPENDS_ON + spdxElementId: SPDXRef-Repository + relatedSpdxElement: SPDXRef-Package + - relationshipType: DESCRIBES + spdxElementId: SPDXRef-DOCUMENT + relatedSpdxElement: SPDXRef-Repository headers: Link: *37 '404': *6 diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 768200447..e926827f9 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -19340,7 +19340,7 @@ "/enterprises/{enterprise}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for enterprise members", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nThe time zone in the response is in UTC time, that means that the cutoff time for the \"day\" is UTC time.\n\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -28176,6 +28176,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -29789,6 +29794,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -30012,7 +30022,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -30334,6 +30345,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -31019,6 +31035,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -32585,6 +32606,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -32808,7 +32834,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -34068,6 +34095,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -34291,7 +34323,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -37872,6 +37905,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -38284,6 +38322,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -40186,6 +40229,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -40409,7 +40457,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -287600,6 +287649,13 @@ "SPDX-2.3" ] }, + "comment": { + "type": "string", + "description": "An optional comment about the SPDX document.", + "examples": [ + "Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/" + ] + }, "creationInfo": { "type": "object", "properties": { @@ -287640,21 +287696,11 @@ "CC0-1.0" ] }, - "documentDescribes": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "github/github" - ] - }, - "description": "The name of the repository that the SPDX document describes." - }, "documentNamespace": { "type": "string", "description": "The namespace for the SPDX document.", "examples": [ - "https://github.com/example/dependency_graph/sbom-123" + "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57" ] }, "packages": { @@ -287673,7 +287719,7 @@ "type": "string", "description": "The name of the package.", "examples": [ - "rubygems:github/github" + "github/github" ] }, "versionInfo": { @@ -287766,8 +287812,35 @@ "name", "versionInfo", "downloadLocation", - "filesAnalyzed", - "supplier" + "filesAnalyzed" + ] + }, + "relationships": { + "type": "array", + "items": { + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of relationship between the two SPDX elements.", + "examples": [ + "DEPENDS_ON" + ] + }, + "spdxElementId": { + "type": "string", + "description": "The SPDX identifier of the package that is the source of the relationship." + }, + "relatedSpdxElement": { + "type": "string", + "description": "The SPDX identifier of the package that is the target of the relationship." + } + } + }, + "required": [ + "relationshipType", + "spdxElementId", + "relatedSpdxElement" ] } }, @@ -287777,7 +287850,6 @@ "creationInfo", "name", "dataLicense", - "documentDescribes", "documentNamespace", "packages" ] @@ -287801,20 +287873,50 @@ }, "name": "github/example", "dataLicense": "CC0-1.0", - "documentDescribes": [ - "github/example" - ], - "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456", + "documentNamespace": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "packages": [ { + "name": "rails", "SPDXID": "SPDXRef-Package", - "name": "rubygems:rails", "versionInfo": "1.0.0", "downloadLocation": "NOASSERTION", "filesAnalyzed": false, "licenseConcluded": "MIT", "licenseDeclared": "MIT", - "copyrightText": "Copyright (c) 1985 GitHub.com" + "copyrightText": "Copyright (c) 1985 GitHub.com", + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:gem/rails@1.0.0" + } + ] + }, + { + "name": "github/example", + "SPDXID": "SPDXRef-Repository", + "versionInfo": "main", + "downloadLocation": "NOASSERTION", + "filesAnalyzed": false, + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:github/example@main" + } + ] + } + ], + "relationships": [ + { + "relationshipType": "DEPENDS_ON", + "spdxElementId": "SPDXRef-Repository", + "relatedSpdxElement": "SPDXRef-Package" + }, + { + "relationshipType": "DESCRIBES", + "spdxElementId": "SPDXRef-DOCUMENT", + "relatedSpdxElement": "SPDXRef-Repository" } ] } @@ -587425,6 +587527,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 5fe5fc88e..733851fcd 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -8194,6 +8194,8 @@ paths: and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE. + The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + Only owners and billing managers can view Copilot usage metrics for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -10974,6 +10976,11 @@ paths: type: string size: type: integer + encoding: + type: string + description: The encoding used for `content`. Currently, + `"utf-8"` and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -11507,6 +11514,11 @@ paths: type: boolean content: type: string + encoding: + type: string + description: The encoding used for `content`. Currently, + `"utf-8"` and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -11548,6 +11560,7 @@ paths: size: 23 truncated: false content: Hello world from GitHub + encoding: utf-8 public: true created_at: '2022-09-20T12:11:58Z' updated_at: '2022-09-21T10:28:06Z' @@ -61744,6 +61757,12 @@ paths: document conforms to. examples: - SPDX-2.3 + comment: + type: string + description: An optional comment about the SPDX document. + examples: + - 'Exact versions could not be resolved for some packages. + For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/' creationInfo: type: object properties: @@ -61774,19 +61793,11 @@ paths: licensed. examples: - CC0-1.0 - documentDescribes: - type: array - items: - type: string - examples: - - github/github - description: The name of the repository that the SPDX document - describes. documentNamespace: type: string description: The namespace for the SPDX document. examples: - - https://github.com/example/dependency_graph/sbom-123 + - https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: type: array items: @@ -61801,7 +61812,7 @@ paths: type: string description: The name of the package. examples: - - rubygems:github/github + - github/github versionInfo: type: string description: |- @@ -61881,14 +61892,35 @@ paths: - versionInfo - downloadLocation - filesAnalyzed - - supplier + relationships: + type: array + items: + type: object + properties: + relationshipType: + type: string + description: The type of relationship between the two + SPDX elements. + examples: + - DEPENDS_ON + spdxElementId: + type: string + description: The SPDX identifier of the package that + is the source of the relationship. + relatedSpdxElement: + type: string + description: The SPDX identifier of the package that + is the target of the relationship. + required: + - relationshipType + - spdxElementId + - relatedSpdxElement required: - SPDXID - spdxVersion - creationInfo - name - dataLicense - - documentDescribes - documentNamespace - packages required: @@ -61905,18 +61937,36 @@ paths: - 'Tool: GitHub.com-Dependency-Graph' name: github/example dataLicense: CC0-1.0 - documentDescribes: - - github/example - documentNamespace: https://github.com/github/example/dependency_graph/sbom-abcdef123456 + documentNamespace: https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: - - SPDXID: SPDXRef-Package - name: rubygems:rails + - name: rails + SPDXID: SPDXRef-Package versionInfo: 1.0.0 downloadLocation: NOASSERTION filesAnalyzed: false licenseConcluded: MIT licenseDeclared: MIT copyrightText: Copyright (c) 1985 GitHub.com + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:gem/rails@1.0.0 + - name: github/example + SPDXID: SPDXRef-Repository + versionInfo: main + downloadLocation: NOASSERTION + filesAnalyzed: false + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:github/example@main + relationships: + - relationshipType: DEPENDS_ON + spdxElementId: SPDXRef-Repository + relatedSpdxElement: SPDXRef-Package + - relationshipType: DESCRIBES + spdxElementId: SPDXRef-DOCUMENT + relatedSpdxElement: SPDXRef-Repository headers: Link: *37 '404': *6 diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 817a8fc68..e96f61900 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -28685,7 +28685,7 @@ "/enterprises/{enterprise}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for enterprise members", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nThe time zone in the response is in UTC time, that means that the cutoff time for the \"day\" is UTC time.\n\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -39247,6 +39247,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -40860,6 +40865,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -41083,7 +41093,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -41405,6 +41416,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -42090,6 +42106,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -43656,6 +43677,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -43879,7 +43905,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -45139,6 +45166,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -45362,7 +45394,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -48943,6 +48976,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -49355,6 +49393,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -51257,6 +51300,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -51480,7 +51528,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -306051,6 +306100,13 @@ "SPDX-2.3" ] }, + "comment": { + "type": "string", + "description": "An optional comment about the SPDX document.", + "examples": [ + "Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/" + ] + }, "creationInfo": { "type": "object", "properties": { @@ -306091,21 +306147,11 @@ "CC0-1.0" ] }, - "documentDescribes": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "github/github" - ] - }, - "description": "The name of the repository that the SPDX document describes." - }, "documentNamespace": { "type": "string", "description": "The namespace for the SPDX document.", "examples": [ - "https://github.com/example/dependency_graph/sbom-123" + "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57" ] }, "packages": { @@ -306124,7 +306170,7 @@ "type": "string", "description": "The name of the package.", "examples": [ - "rubygems:github/github" + "github/github" ] }, "versionInfo": { @@ -306217,8 +306263,35 @@ "name", "versionInfo", "downloadLocation", - "filesAnalyzed", - "supplier" + "filesAnalyzed" + ] + }, + "relationships": { + "type": "array", + "items": { + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of relationship between the two SPDX elements.", + "examples": [ + "DEPENDS_ON" + ] + }, + "spdxElementId": { + "type": "string", + "description": "The SPDX identifier of the package that is the source of the relationship." + }, + "relatedSpdxElement": { + "type": "string", + "description": "The SPDX identifier of the package that is the target of the relationship." + } + } + }, + "required": [ + "relationshipType", + "spdxElementId", + "relatedSpdxElement" ] } }, @@ -306228,7 +306301,6 @@ "creationInfo", "name", "dataLicense", - "documentDescribes", "documentNamespace", "packages" ] @@ -306252,20 +306324,50 @@ }, "name": "github/example", "dataLicense": "CC0-1.0", - "documentDescribes": [ - "github/example" - ], - "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456", + "documentNamespace": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "packages": [ { + "name": "rails", "SPDXID": "SPDXRef-Package", - "name": "rubygems:rails", "versionInfo": "1.0.0", "downloadLocation": "NOASSERTION", "filesAnalyzed": false, "licenseConcluded": "MIT", "licenseDeclared": "MIT", - "copyrightText": "Copyright (c) 1985 GitHub.com" + "copyrightText": "Copyright (c) 1985 GitHub.com", + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:gem/rails@1.0.0" + } + ] + }, + { + "name": "github/example", + "SPDXID": "SPDXRef-Repository", + "versionInfo": "main", + "downloadLocation": "NOASSERTION", + "filesAnalyzed": false, + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:github/example@main" + } + ] + } + ], + "relationships": [ + { + "relationshipType": "DEPENDS_ON", + "spdxElementId": "SPDXRef-Repository", + "relatedSpdxElement": "SPDXRef-Package" + }, + { + "relationshipType": "DESCRIBES", + "spdxElementId": "SPDXRef-DOCUMENT", + "relatedSpdxElement": "SPDXRef-Repository" } ] } @@ -618279,6 +618381,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index a75f26fd0..230f91fa3 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -12046,6 +12046,8 @@ paths: and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE. + The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + Only owners and billing managers can view Copilot usage metrics for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -15227,6 +15229,11 @@ paths: type: string size: type: integer + encoding: + type: string + description: The encoding used for `content`. Currently, + `"utf-8"` and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -15760,6 +15767,11 @@ paths: type: boolean content: type: string + encoding: + type: string + description: The encoding used for `content`. Currently, + `"utf-8"` and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -15801,6 +15813,7 @@ paths: size: 23 truncated: false content: Hello world from GitHub + encoding: utf-8 public: true created_at: '2022-09-20T12:11:58Z' updated_at: '2022-09-21T10:28:06Z' @@ -66966,6 +66979,12 @@ paths: document conforms to. examples: - SPDX-2.3 + comment: + type: string + description: An optional comment about the SPDX document. + examples: + - 'Exact versions could not be resolved for some packages. + For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/' creationInfo: type: object properties: @@ -66996,19 +67015,11 @@ paths: licensed. examples: - CC0-1.0 - documentDescribes: - type: array - items: - type: string - examples: - - github/github - description: The name of the repository that the SPDX document - describes. documentNamespace: type: string description: The namespace for the SPDX document. examples: - - https://github.com/example/dependency_graph/sbom-123 + - https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: type: array items: @@ -67023,7 +67034,7 @@ paths: type: string description: The name of the package. examples: - - rubygems:github/github + - github/github versionInfo: type: string description: |- @@ -67103,14 +67114,35 @@ paths: - versionInfo - downloadLocation - filesAnalyzed - - supplier + relationships: + type: array + items: + type: object + properties: + relationshipType: + type: string + description: The type of relationship between the two + SPDX elements. + examples: + - DEPENDS_ON + spdxElementId: + type: string + description: The SPDX identifier of the package that + is the source of the relationship. + relatedSpdxElement: + type: string + description: The SPDX identifier of the package that + is the target of the relationship. + required: + - relationshipType + - spdxElementId + - relatedSpdxElement required: - SPDXID - spdxVersion - creationInfo - name - dataLicense - - documentDescribes - documentNamespace - packages required: @@ -67127,18 +67159,36 @@ paths: - 'Tool: GitHub.com-Dependency-Graph' name: github/example dataLicense: CC0-1.0 - documentDescribes: - - github/example - documentNamespace: https://github.com/github/example/dependency_graph/sbom-abcdef123456 + documentNamespace: https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: - - SPDXID: SPDXRef-Package - name: rubygems:rails + - name: rails + SPDXID: SPDXRef-Package versionInfo: 1.0.0 downloadLocation: NOASSERTION filesAnalyzed: false licenseConcluded: MIT licenseDeclared: MIT copyrightText: Copyright (c) 1985 GitHub.com + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:gem/rails@1.0.0 + - name: github/example + SPDXID: SPDXRef-Repository + versionInfo: main + downloadLocation: NOASSERTION + filesAnalyzed: false + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:github/example@main + relationships: + - relationshipType: DEPENDS_ON + spdxElementId: SPDXRef-Repository + relatedSpdxElement: SPDXRef-Package + - relationshipType: DESCRIBES + spdxElementId: SPDXRef-DOCUMENT + relatedSpdxElement: SPDXRef-Repository headers: Link: *37 '404': *6 diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 817a8fc68..e96f61900 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -28685,7 +28685,7 @@ "/enterprises/{enterprise}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for enterprise members", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nThe time zone in the response is in UTC time, that means that the cutoff time for the \"day\" is UTC time.\n\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -39247,6 +39247,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -40860,6 +40865,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -41083,7 +41093,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -41405,6 +41416,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -42090,6 +42106,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -43656,6 +43677,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -43879,7 +43905,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -45139,6 +45166,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -45362,7 +45394,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -48943,6 +48976,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -49355,6 +49393,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -51257,6 +51300,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -51480,7 +51528,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -306051,6 +306100,13 @@ "SPDX-2.3" ] }, + "comment": { + "type": "string", + "description": "An optional comment about the SPDX document.", + "examples": [ + "Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/" + ] + }, "creationInfo": { "type": "object", "properties": { @@ -306091,21 +306147,11 @@ "CC0-1.0" ] }, - "documentDescribes": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "github/github" - ] - }, - "description": "The name of the repository that the SPDX document describes." - }, "documentNamespace": { "type": "string", "description": "The namespace for the SPDX document.", "examples": [ - "https://github.com/example/dependency_graph/sbom-123" + "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57" ] }, "packages": { @@ -306124,7 +306170,7 @@ "type": "string", "description": "The name of the package.", "examples": [ - "rubygems:github/github" + "github/github" ] }, "versionInfo": { @@ -306217,8 +306263,35 @@ "name", "versionInfo", "downloadLocation", - "filesAnalyzed", - "supplier" + "filesAnalyzed" + ] + }, + "relationships": { + "type": "array", + "items": { + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of relationship between the two SPDX elements.", + "examples": [ + "DEPENDS_ON" + ] + }, + "spdxElementId": { + "type": "string", + "description": "The SPDX identifier of the package that is the source of the relationship." + }, + "relatedSpdxElement": { + "type": "string", + "description": "The SPDX identifier of the package that is the target of the relationship." + } + } + }, + "required": [ + "relationshipType", + "spdxElementId", + "relatedSpdxElement" ] } }, @@ -306228,7 +306301,6 @@ "creationInfo", "name", "dataLicense", - "documentDescribes", "documentNamespace", "packages" ] @@ -306252,20 +306324,50 @@ }, "name": "github/example", "dataLicense": "CC0-1.0", - "documentDescribes": [ - "github/example" - ], - "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456", + "documentNamespace": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "packages": [ { + "name": "rails", "SPDXID": "SPDXRef-Package", - "name": "rubygems:rails", "versionInfo": "1.0.0", "downloadLocation": "NOASSERTION", "filesAnalyzed": false, "licenseConcluded": "MIT", "licenseDeclared": "MIT", - "copyrightText": "Copyright (c) 1985 GitHub.com" + "copyrightText": "Copyright (c) 1985 GitHub.com", + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:gem/rails@1.0.0" + } + ] + }, + { + "name": "github/example", + "SPDXID": "SPDXRef-Repository", + "versionInfo": "main", + "downloadLocation": "NOASSERTION", + "filesAnalyzed": false, + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:github/example@main" + } + ] + } + ], + "relationships": [ + { + "relationshipType": "DEPENDS_ON", + "spdxElementId": "SPDXRef-Repository", + "relatedSpdxElement": "SPDXRef-Package" + }, + { + "relationshipType": "DESCRIBES", + "spdxElementId": "SPDXRef-DOCUMENT", + "relatedSpdxElement": "SPDXRef-Repository" } ] } @@ -618279,6 +618381,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index a75f26fd0..230f91fa3 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -12046,6 +12046,8 @@ paths: and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE. + The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + Only owners and billing managers can view Copilot usage metrics for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -15227,6 +15229,11 @@ paths: type: string size: type: integer + encoding: + type: string + description: The encoding used for `content`. Currently, + `"utf-8"` and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -15760,6 +15767,11 @@ paths: type: boolean content: type: string + encoding: + type: string + description: The encoding used for `content`. Currently, + `"utf-8"` and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -15801,6 +15813,7 @@ paths: size: 23 truncated: false content: Hello world from GitHub + encoding: utf-8 public: true created_at: '2022-09-20T12:11:58Z' updated_at: '2022-09-21T10:28:06Z' @@ -66966,6 +66979,12 @@ paths: document conforms to. examples: - SPDX-2.3 + comment: + type: string + description: An optional comment about the SPDX document. + examples: + - 'Exact versions could not be resolved for some packages. + For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/' creationInfo: type: object properties: @@ -66996,19 +67015,11 @@ paths: licensed. examples: - CC0-1.0 - documentDescribes: - type: array - items: - type: string - examples: - - github/github - description: The name of the repository that the SPDX document - describes. documentNamespace: type: string description: The namespace for the SPDX document. examples: - - https://github.com/example/dependency_graph/sbom-123 + - https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: type: array items: @@ -67023,7 +67034,7 @@ paths: type: string description: The name of the package. examples: - - rubygems:github/github + - github/github versionInfo: type: string description: |- @@ -67103,14 +67114,35 @@ paths: - versionInfo - downloadLocation - filesAnalyzed - - supplier + relationships: + type: array + items: + type: object + properties: + relationshipType: + type: string + description: The type of relationship between the two + SPDX elements. + examples: + - DEPENDS_ON + spdxElementId: + type: string + description: The SPDX identifier of the package that + is the source of the relationship. + relatedSpdxElement: + type: string + description: The SPDX identifier of the package that + is the target of the relationship. + required: + - relationshipType + - spdxElementId + - relatedSpdxElement required: - SPDXID - spdxVersion - creationInfo - name - dataLicense - - documentDescribes - documentNamespace - packages required: @@ -67127,18 +67159,36 @@ paths: - 'Tool: GitHub.com-Dependency-Graph' name: github/example dataLicense: CC0-1.0 - documentDescribes: - - github/example - documentNamespace: https://github.com/github/example/dependency_graph/sbom-abcdef123456 + documentNamespace: https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: - - SPDXID: SPDXRef-Package - name: rubygems:rails + - name: rails + SPDXID: SPDXRef-Package versionInfo: 1.0.0 downloadLocation: NOASSERTION filesAnalyzed: false licenseConcluded: MIT licenseDeclared: MIT copyrightText: Copyright (c) 1985 GitHub.com + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:gem/rails@1.0.0 + - name: github/example + SPDXID: SPDXRef-Repository + versionInfo: main + downloadLocation: NOASSERTION + filesAnalyzed: false + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:github/example@main + relationships: + - relationshipType: DEPENDS_ON + spdxElementId: SPDXRef-Repository + relatedSpdxElement: SPDXRef-Package + - relationshipType: DESCRIBES + spdxElementId: SPDXRef-DOCUMENT + relatedSpdxElement: SPDXRef-Repository headers: Link: *37 '404': *6 diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index 4b603e719..eaeeeeafd 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -4767,7 +4767,7 @@ "/enterprises/{enterprise}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for enterprise members", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nThe time zone in the response is in UTC time, that means that the cutoff time for the \"day\" is UTC time.\n\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -107181,6 +107181,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -107771,6 +107776,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -114408,6 +114418,33 @@ } } }, + "repository-rule-params-required-reviewer-configuration": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer_id": { + "type": "string", + "description": "Node ID of the team which must review changes to matching files." + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer_id" + ] + }, "repository-rule-pull-request": { "title": "pull_request", "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", @@ -125349,6 +125386,13 @@ "SPDX-2.3" ] }, + "comment": { + "type": "string", + "description": "An optional comment about the SPDX document.", + "examples": [ + "Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/" + ] + }, "creationInfo": { "type": "object", "properties": { @@ -125389,21 +125433,11 @@ "CC0-1.0" ] }, - "documentDescribes": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "github/github" - ] - }, - "description": "The name of the repository that the SPDX document describes." - }, "documentNamespace": { "type": "string", "description": "The namespace for the SPDX document.", "examples": [ - "https://github.com/example/dependency_graph/sbom-123" + "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57" ] }, "packages": { @@ -125422,7 +125456,7 @@ "type": "string", "description": "The name of the package.", "examples": [ - "rubygems:github/github" + "github/github" ] }, "versionInfo": { @@ -125515,8 +125549,35 @@ "name", "versionInfo", "downloadLocation", - "filesAnalyzed", - "supplier" + "filesAnalyzed" + ] + }, + "relationships": { + "type": "array", + "items": { + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of relationship between the two SPDX elements.", + "examples": [ + "DEPENDS_ON" + ] + }, + "spdxElementId": { + "type": "string", + "description": "The SPDX identifier of the package that is the source of the relationship." + }, + "relatedSpdxElement": { + "type": "string", + "description": "The SPDX identifier of the package that is the target of the relationship." + } + } + }, + "required": [ + "relationshipType", + "spdxElementId", + "relatedSpdxElement" ] } }, @@ -125526,7 +125587,6 @@ "creationInfo", "name", "dataLicense", - "documentDescribes", "documentNamespace", "packages" ] @@ -286101,7 +286161,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -300448,20 +300509,50 @@ }, "name": "github/example", "dataLicense": "CC0-1.0", - "documentDescribes": [ - "github/example" - ], - "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456", + "documentNamespace": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "packages": [ { + "name": "rails", "SPDXID": "SPDXRef-Package", - "name": "rubygems:rails", "versionInfo": "1.0.0", "downloadLocation": "NOASSERTION", "filesAnalyzed": false, "licenseConcluded": "MIT", "licenseDeclared": "MIT", - "copyrightText": "Copyright (c) 1985 GitHub.com" + "copyrightText": "Copyright (c) 1985 GitHub.com", + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:gem/rails@1.0.0" + } + ] + }, + { + "name": "github/example", + "SPDXID": "SPDXRef-Repository", + "versionInfo": "main", + "downloadLocation": "NOASSERTION", + "filesAnalyzed": false, + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:github/example@main" + } + ] + } + ], + "relationships": [ + { + "relationshipType": "DEPENDS_ON", + "spdxElementId": "SPDXRef-Repository", + "relatedSpdxElement": "SPDXRef-Package" + }, + { + "relationshipType": "DESCRIBES", + "spdxElementId": "SPDXRef-DOCUMENT", + "relatedSpdxElement": "SPDXRef-Repository" } ] } diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index b36b04dda..b4e7b565b 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -3403,6 +3403,8 @@ paths: and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE. + The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + Only owners and billing managers can view Copilot usage metrics for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -77736,6 +77738,11 @@ components: type: string size: type: integer + encoding: + type: string + description: The encoding used for `content`. Currently, `"utf-8"` + and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -78149,6 +78156,11 @@ components: type: boolean content: type: string + encoding: + type: string + description: The encoding used for `content`. Currently, `"utf-8"` + and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -83118,6 +83130,31 @@ components: type: string enum: - required_signatures + repository-rule-params-required-reviewer-configuration: + title: RequiredReviewerConfiguration + description: A reviewing team, and file patterns describing which files they + must approve changes to. + type: object + properties: + file_patterns: + type: array + description: Array of file patterns. Pull requests which change matching + files must be approved by the specified team. File patterns use the same + syntax as `.gitignore` files. + items: + type: string + minimum_approvals: + type: integer + description: Minimum number of approvals required from the specified team. + If set to zero, the team will be added to the pull request but approval + is optional. + reviewer_id: + type: string + description: Node ID of the team which must review changes to matching files. + required: + - file_patterns + - minimum_approvals + - reviewer_id repository-rule-pull-request: title: pull_request description: Require all commits be made to a non-target branch and submitted @@ -91012,6 +91049,12 @@ components: conforms to. examples: - SPDX-2.3 + comment: + type: string + description: An optional comment about the SPDX document. + examples: + - 'Exact versions could not be resolved for some packages. For more + information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/' creationInfo: type: object properties: @@ -91040,18 +91083,11 @@ components: description: The license under which the SPDX document is licensed. examples: - CC0-1.0 - documentDescribes: - type: array - items: - type: string - examples: - - github/github - description: The name of the repository that the SPDX document describes. documentNamespace: type: string description: The namespace for the SPDX document. examples: - - https://github.com/example/dependency_graph/sbom-123 + - https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: type: array items: @@ -91066,7 +91102,7 @@ components: type: string description: The name of the package. examples: - - rubygems:github/github + - github/github versionInfo: type: string description: |- @@ -91146,14 +91182,34 @@ components: - versionInfo - downloadLocation - filesAnalyzed - - supplier + relationships: + type: array + items: + type: object + properties: + relationshipType: + type: string + description: The type of relationship between the two SPDX elements. + examples: + - DEPENDS_ON + spdxElementId: + type: string + description: The SPDX identifier of the package that is the source + of the relationship. + relatedSpdxElement: + type: string + description: The SPDX identifier of the package that is the target + of the relationship. + required: + - relationshipType + - spdxElementId + - relatedSpdxElement required: - SPDXID - spdxVersion - creationInfo - name - dataLicense - - documentDescribes - documentNamespace - packages required: @@ -210846,6 +210902,7 @@ components: size: 23 truncated: false content: Hello world from GitHub + encoding: utf-8 public: true created_at: '2022-09-20T12:11:58Z' updated_at: '2022-09-21T10:28:06Z' @@ -223179,18 +223236,36 @@ components: - 'Tool: GitHub.com-Dependency-Graph' name: github/example dataLicense: CC0-1.0 - documentDescribes: - - github/example - documentNamespace: https://github.com/github/example/dependency_graph/sbom-abcdef123456 + documentNamespace: https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: - - SPDXID: SPDXRef-Package - name: rubygems:rails + - name: rails + SPDXID: SPDXRef-Package versionInfo: 1.0.0 downloadLocation: NOASSERTION filesAnalyzed: false licenseConcluded: MIT licenseDeclared: MIT copyrightText: Copyright (c) 1985 GitHub.com + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:gem/rails@1.0.0 + - name: github/example + SPDXID: SPDXRef-Repository + versionInfo: main + downloadLocation: NOASSERTION + filesAnalyzed: false + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:github/example@main + relationships: + - relationshipType: DEPENDS_ON + spdxElementId: SPDXRef-Repository + relatedSpdxElement: SPDXRef-Package + - relationshipType: DESCRIBES + spdxElementId: SPDXRef-DOCUMENT + relatedSpdxElement: SPDXRef-Repository dependency-graph-create-snapshot-request: value: version: 0 diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index 4b603e719..eaeeeeafd 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -4767,7 +4767,7 @@ "/enterprises/{enterprise}/copilot/usage": { "get": { "summary": "Get a summary of Copilot usage for enterprise members", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nThe time zone in the response is in UTC time, that means that the cutoff time for the \"day\" is UTC time.\n\nOnly owners and billing managers can view Copilot usage metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], @@ -107181,6 +107181,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -107771,6 +107776,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -114408,6 +114418,33 @@ } } }, + "repository-rule-params-required-reviewer-configuration": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files.", + "items": { + "type": "string" + } + }, + "minimum_approvals": { + "type": "integer", + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + }, + "reviewer_id": { + "type": "string", + "description": "Node ID of the team which must review changes to matching files." + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer_id" + ] + }, "repository-rule-pull-request": { "title": "pull_request", "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", @@ -125349,6 +125386,13 @@ "SPDX-2.3" ] }, + "comment": { + "type": "string", + "description": "An optional comment about the SPDX document.", + "examples": [ + "Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/" + ] + }, "creationInfo": { "type": "object", "properties": { @@ -125389,21 +125433,11 @@ "CC0-1.0" ] }, - "documentDescribes": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "github/github" - ] - }, - "description": "The name of the repository that the SPDX document describes." - }, "documentNamespace": { "type": "string", "description": "The namespace for the SPDX document.", "examples": [ - "https://github.com/example/dependency_graph/sbom-123" + "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57" ] }, "packages": { @@ -125422,7 +125456,7 @@ "type": "string", "description": "The name of the package.", "examples": [ - "rubygems:github/github" + "github/github" ] }, "versionInfo": { @@ -125515,8 +125549,35 @@ "name", "versionInfo", "downloadLocation", - "filesAnalyzed", - "supplier" + "filesAnalyzed" + ] + }, + "relationships": { + "type": "array", + "items": { + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of relationship between the two SPDX elements.", + "examples": [ + "DEPENDS_ON" + ] + }, + "spdxElementId": { + "type": "string", + "description": "The SPDX identifier of the package that is the source of the relationship." + }, + "relatedSpdxElement": { + "type": "string", + "description": "The SPDX identifier of the package that is the target of the relationship." + } + } + }, + "required": [ + "relationshipType", + "spdxElementId", + "relatedSpdxElement" ] } }, @@ -125526,7 +125587,6 @@ "creationInfo", "name", "dataLicense", - "documentDescribes", "documentNamespace", "packages" ] @@ -286101,7 +286161,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -300448,20 +300509,50 @@ }, "name": "github/example", "dataLicense": "CC0-1.0", - "documentDescribes": [ - "github/example" - ], - "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456", + "documentNamespace": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "packages": [ { + "name": "rails", "SPDXID": "SPDXRef-Package", - "name": "rubygems:rails", "versionInfo": "1.0.0", "downloadLocation": "NOASSERTION", "filesAnalyzed": false, "licenseConcluded": "MIT", "licenseDeclared": "MIT", - "copyrightText": "Copyright (c) 1985 GitHub.com" + "copyrightText": "Copyright (c) 1985 GitHub.com", + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:gem/rails@1.0.0" + } + ] + }, + { + "name": "github/example", + "SPDXID": "SPDXRef-Repository", + "versionInfo": "main", + "downloadLocation": "NOASSERTION", + "filesAnalyzed": false, + "externalRefs": [ + { + "referenceCategory": "PACKAGE-MANAGER", + "referenceType": "purl", + "referenceLocator": "pkg:github/example@main" + } + ] + } + ], + "relationships": [ + { + "relationshipType": "DEPENDS_ON", + "spdxElementId": "SPDXRef-Repository", + "relatedSpdxElement": "SPDXRef-Package" + }, + { + "relationshipType": "DESCRIBES", + "spdxElementId": "SPDXRef-DOCUMENT", + "relatedSpdxElement": "SPDXRef-Repository" } ] } diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index b36b04dda..b4e7b565b 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -3403,6 +3403,8 @@ paths: and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, they must have telemetry enabled in their IDE. + The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. + Only owners and billing managers can view Copilot usage metrics for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. @@ -77736,6 +77738,11 @@ components: type: string size: type: integer + encoding: + type: string + description: The encoding used for `content`. Currently, `"utf-8"` + and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -78149,6 +78156,11 @@ components: type: boolean content: type: string + encoding: + type: string + description: The encoding used for `content`. Currently, `"utf-8"` + and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -83118,6 +83130,31 @@ components: type: string enum: - required_signatures + repository-rule-params-required-reviewer-configuration: + title: RequiredReviewerConfiguration + description: A reviewing team, and file patterns describing which files they + must approve changes to. + type: object + properties: + file_patterns: + type: array + description: Array of file patterns. Pull requests which change matching + files must be approved by the specified team. File patterns use the same + syntax as `.gitignore` files. + items: + type: string + minimum_approvals: + type: integer + description: Minimum number of approvals required from the specified team. + If set to zero, the team will be added to the pull request but approval + is optional. + reviewer_id: + type: string + description: Node ID of the team which must review changes to matching files. + required: + - file_patterns + - minimum_approvals + - reviewer_id repository-rule-pull-request: title: pull_request description: Require all commits be made to a non-target branch and submitted @@ -91012,6 +91049,12 @@ components: conforms to. examples: - SPDX-2.3 + comment: + type: string + description: An optional comment about the SPDX document. + examples: + - 'Exact versions could not be resolved for some packages. For more + information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/' creationInfo: type: object properties: @@ -91040,18 +91083,11 @@ components: description: The license under which the SPDX document is licensed. examples: - CC0-1.0 - documentDescribes: - type: array - items: - type: string - examples: - - github/github - description: The name of the repository that the SPDX document describes. documentNamespace: type: string description: The namespace for the SPDX document. examples: - - https://github.com/example/dependency_graph/sbom-123 + - https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: type: array items: @@ -91066,7 +91102,7 @@ components: type: string description: The name of the package. examples: - - rubygems:github/github + - github/github versionInfo: type: string description: |- @@ -91146,14 +91182,34 @@ components: - versionInfo - downloadLocation - filesAnalyzed - - supplier + relationships: + type: array + items: + type: object + properties: + relationshipType: + type: string + description: The type of relationship between the two SPDX elements. + examples: + - DEPENDS_ON + spdxElementId: + type: string + description: The SPDX identifier of the package that is the source + of the relationship. + relatedSpdxElement: + type: string + description: The SPDX identifier of the package that is the target + of the relationship. + required: + - relationshipType + - spdxElementId + - relatedSpdxElement required: - SPDXID - spdxVersion - creationInfo - name - dataLicense - - documentDescribes - documentNamespace - packages required: @@ -210846,6 +210902,7 @@ components: size: 23 truncated: false content: Hello world from GitHub + encoding: utf-8 public: true created_at: '2022-09-20T12:11:58Z' updated_at: '2022-09-21T10:28:06Z' @@ -223179,18 +223236,36 @@ components: - 'Tool: GitHub.com-Dependency-Graph' name: github/example dataLicense: CC0-1.0 - documentDescribes: - - github/example - documentNamespace: https://github.com/github/example/dependency_graph/sbom-abcdef123456 + documentNamespace: https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: - - SPDXID: SPDXRef-Package - name: rubygems:rails + - name: rails + SPDXID: SPDXRef-Package versionInfo: 1.0.0 downloadLocation: NOASSERTION filesAnalyzed: false licenseConcluded: MIT licenseDeclared: MIT copyrightText: Copyright (c) 1985 GitHub.com + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:gem/rails@1.0.0 + - name: github/example + SPDXID: SPDXRef-Repository + versionInfo: main + downloadLocation: NOASSERTION + filesAnalyzed: false + externalRefs: + - referenceCategory: PACKAGE-MANAGER + referenceType: purl + referenceLocator: pkg:github/example@main + relationships: + - relationshipType: DEPENDS_ON + spdxElementId: SPDXRef-Repository + relatedSpdxElement: SPDXRef-Package + - relationshipType: DESCRIBES + spdxElementId: SPDXRef-DOCUMENT + relatedSpdxElement: SPDXRef-Repository dependency-graph-create-snapshot-request: value: version: 0 diff --git a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json index 46bf992b4..56d2d0457 100644 --- a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json @@ -47927,6 +47927,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -49540,6 +49545,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -49763,7 +49773,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -50085,6 +50096,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -50770,6 +50786,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -52336,6 +52357,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -52559,7 +52585,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -53819,6 +53846,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -54042,7 +54074,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -57623,6 +57656,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -58035,6 +58073,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -59937,6 +59980,11 @@ }, "content": { "type": "string" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } @@ -60160,7 +60208,8 @@ "raw_url": "https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md", "size": 23, "truncated": false, - "content": "Hello world from GitHub" + "content": "Hello world from GitHub", + "encoding": "utf-8" } }, "public": true, @@ -254967,6 +255016,13 @@ "SPDX-2.3" ] }, + "comment": { + "type": "string", + "description": "An optional comment about the SPDX document.", + "examples": [ + "Exact versions could not be resolved for some packages. For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/" + ] + }, "creationInfo": { "type": "object", "properties": { @@ -255007,21 +255063,11 @@ "CC0-1.0" ] }, - "documentDescribes": { - "type": "array", - "items": { - "type": "string", - "examples": [ - "github/github" - ] - }, - "description": "The name of the repository that the SPDX document describes." - }, "documentNamespace": { "type": "string", "description": "The namespace for the SPDX document.", "examples": [ - "https://github.com/example/dependency_graph/sbom-123" + "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57" ] }, "packages": { @@ -255040,7 +255086,7 @@ "type": "string", "description": "The name of the package.", "examples": [ - "rubygems:github/github" + "github/github" ] }, "versionInfo": { @@ -255138,6 +255184,34 @@ "licenseDeclared", "supplier" ] + }, + "relationships": { + "type": "array", + "items": { + "type": "object", + "properties": { + "relationshipType": { + "type": "string", + "description": "The type of relationship between the two SPDX elements.", + "examples": [ + "DEPENDS_ON" + ] + }, + "spdxElementId": { + "type": "string", + "description": "The SPDX identifier of the package that is the source of the relationship." + }, + "relatedSpdxElement": { + "type": "string", + "description": "The SPDX identifier of the package that is the target of the relationship." + } + } + }, + "required": [ + "relationshipType", + "spdxElementId", + "relatedSpdxElement" + ] } }, "required": [ @@ -255146,7 +255220,6 @@ "creationInfo", "name", "dataLicense", - "documentDescribes", "documentNamespace", "packages" ] @@ -255170,10 +255243,7 @@ }, "name": "github/example", "dataLicense": "CC0-1.0", - "documentDescribes": [ - "github/example" - ], - "documentNamespace": "https://github.com/github/example/dependency_graph/sbom-abcdef123456", + "documentNamespace": "https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57", "packages": [ { "SPDXID": "SPDXRef-Package", @@ -255184,6 +255254,18 @@ "licenseConcluded": "NOASSERTION", "licenseDeclared": "NOASSERTION" } + ], + "relationships": [ + { + "relationshipType": "DEPENDS_ON", + "spdxElementId": "SPDXRef-Repository", + "relatedSpdxElement": "SPDXRef-Package" + }, + { + "relationshipType": "DESCRIBES", + "spdxElementId": "SPDXRef-DOCUMENT", + "relatedSpdxElement": "SPDXRef-Repository" + } ] } } @@ -501103,6 +501185,11 @@ }, "size": { "type": "integer" + }, + "encoding": { + "type": "string", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "default": "utf-8" } } } diff --git a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml index fc911f063..bf8e9cbfe 100644 --- a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml +++ b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml @@ -14980,6 +14980,11 @@ paths: type: string size: type: integer + encoding: + type: string + description: The encoding used for `content`. Currently, + `"utf-8"` and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -15513,6 +15518,11 @@ paths: type: boolean content: type: string + encoding: + type: string + description: The encoding used for `content`. Currently, + `"utf-8"` and `"base64"` are supported. + default: utf-8 public: type: boolean created_at: @@ -15554,6 +15564,7 @@ paths: size: 23 truncated: false content: Hello world from GitHub + encoding: utf-8 public: true created_at: '2022-09-20T12:11:58Z' updated_at: '2022-09-21T10:28:06Z' @@ -54284,6 +54295,12 @@ paths: document conforms to. examples: - SPDX-2.3 + comment: + type: string + description: An optional comment about the SPDX document. + examples: + - 'Exact versions could not be resolved for some packages. + For more information: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/' creationInfo: type: object properties: @@ -54314,19 +54331,11 @@ paths: licensed. examples: - CC0-1.0 - documentDescribes: - type: array - items: - type: string - examples: - - github/github - description: The name of the repository that the SPDX document - describes. documentNamespace: type: string description: The namespace for the SPDX document. examples: - - https://github.com/example/dependency_graph/sbom-123 + - https://spdx.org/spdxdocs/protobom/15e41dd2-f961-4f4d-b8dc-f8f57ad70d57 packages: type: array items: @@ -54341,7 +54350,7 @@ paths: type: string description: The name of the package. examples: - - rubygems:github/github + - github/github versionInfo: type: string description: |- @@ -54424,13 +54433,35 @@ paths: - licenseConcluded - licenseDeclared - supplier + relationships: + type: array + items: + type: object + properties: + relationshipType: + type: string + description: The type of relationship between the two + SPDX elements. + examples: + - DEPENDS_ON + spdxElementId: + type: string + description: The SPDX identifier of the package that + {"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}