diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 2b51a42e7..a83868935 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -7256,7 +7256,7 @@ "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", - "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.", + "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -12734,6 +12734,77 @@ } } }, + "/orgs/{org}/attestations/repositories": { + "get": { + "summary": "List attestation repositories", + "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#list-attestation-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestation-repositories" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/attestations/{attestation_id}": { "delete": { "summary": "Delete attestations by ID", @@ -75625,7 +75696,7 @@ "/users/{username}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for a user", - "description": "Gets a report of premium request usage for a user.", + "description": "Gets a report of premium request usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -283043,6 +283114,18 @@ ] } }, + "list-attestation-repositories": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + }, "list-attestations": { "value": { "attestations": [ diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 9427653ab..af4e65b00 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -5116,9 +5116,10 @@ paths: "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization - description: Gets a report of premium request usage for an organization. To - use this endpoint, you must be an administrator of an organization within - an enterprise or an organization account. + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-org @@ -9182,6 +9183,53 @@ paths: enabledForGitHubApps: true category: orgs subcategory: attestations + "/orgs/{org}/attestations/repositories": + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#list-attestation-repositories + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/org" + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + "$ref": "#/components/examples/list-attestation-repositories" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/attestations/{attestation_id}": delete: summary: Delete attestations by ID @@ -54750,7 +54798,10 @@ paths: "/users/{username}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for a user - description: Gets a report of premium request usage for a user. + description: |- + Gets a report of premium request usage for a user. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-user @@ -212043,6 +212094,12 @@ components: signatures: - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== repository_id: 1 + list-attestation-repositories: + value: + - id: 123 + name: foo + - id: 456 + name: bar list-attestations: value: attestations: diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 2b51a42e7..a83868935 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -7256,7 +7256,7 @@ "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", - "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.", + "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -12734,6 +12734,77 @@ } } }, + "/orgs/{org}/attestations/repositories": { + "get": { + "summary": "List attestation repositories", + "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#list-attestation-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/pagination-before" + }, + { + "$ref": "#/components/parameters/pagination-after" + }, + { + "$ref": "#/components/parameters/org" + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/list-attestation-repositories" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/attestations/{attestation_id}": { "delete": { "summary": "Delete attestations by ID", @@ -75625,7 +75696,7 @@ "/users/{username}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for a user", - "description": "Gets a report of premium request usage for a user.", + "description": "Gets a report of premium request usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -283043,6 +283114,18 @@ ] } }, + "list-attestation-repositories": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + }, "list-attestations": { "value": { "attestations": [ diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 9427653ab..af4e65b00 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -5116,9 +5116,10 @@ paths: "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization - description: Gets a report of premium request usage for an organization. To - use this endpoint, you must be an administrator of an organization within - an enterprise or an organization account. + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-org @@ -9182,6 +9183,53 @@ paths: enabledForGitHubApps: true category: orgs subcategory: attestations + "/orgs/{org}/attestations/repositories": + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#list-attestation-repositories + parameters: + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/pagination-before" + - "$ref": "#/components/parameters/pagination-after" + - "$ref": "#/components/parameters/org" + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + "$ref": "#/components/examples/list-attestation-repositories" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/attestations/{attestation_id}": delete: summary: Delete attestations by ID @@ -54750,7 +54798,10 @@ paths: "/users/{username}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for a user - description: Gets a report of premium request usage for a user. + description: |- + Gets a report of premium request usage for a user. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-user @@ -212043,6 +212094,12 @@ components: signatures: - sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ== repository_id: 1 + list-attestation-repositories: + value: + - id: 123 + name: foo + - id: 456 + name: bar list-attestations: value: attestations: diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 744d87ec2..ea741a81d 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -65205,7 +65205,7 @@ "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", - "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.", + "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -83791,6 +83791,110 @@ } } }, + "/orgs/{org}/attestations/repositories": { + "get": { + "summary": "List attestation repositories", + "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#list-attestation-repositories" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/attestations/{attestation_id}": { "delete": { "summary": "Delete attestations by ID", @@ -655215,7 +655319,7 @@ "/users/{username}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for a user", - "description": "Gets a report of premium request usage for a user.", + "description": "Gets a report of premium request usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index f6e9af8bd..0dfbcb5ef 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -17767,9 +17767,10 @@ paths: "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization - description: Gets a report of premium request usage for an organization. To - use this endpoint, you must be an administrator of an organization within - an enterprise or an organization account. + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-org @@ -23946,6 +23947,57 @@ paths: enabledForGitHubApps: true category: orgs subcategory: attestations + "/orgs/{org}/attestations/repositories": + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#list-attestation-repositories + parameters: + - *17 + - *40 + - *41 + - *105 + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + value: + - id: 123 + name: foo + - id: 456 + name: bar + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/attestations/{attestation_id}": delete: summary: Delete attestations by ID @@ -105892,7 +105944,10 @@ paths: "/users/{username}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for a user - description: Gets a report of premium request usage for a user. + description: |- + Gets a report of premium request usage for a user. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-user diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 744d87ec2..ea741a81d 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -65205,7 +65205,7 @@ "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", - "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.", + "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -83791,6 +83791,110 @@ } } }, + "/orgs/{org}/attestations/repositories": { + "get": { + "summary": "List attestation repositories", + "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/orgs#list-attestation-repositories" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/attestations/{attestation_id}": { "delete": { "summary": "Delete attestations by ID", @@ -655215,7 +655319,7 @@ "/users/{username}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for a user", - "description": "Gets a report of premium request usage for a user.", + "description": "Gets a report of premium request usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index f6e9af8bd..0dfbcb5ef 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -17767,9 +17767,10 @@ paths: "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization - description: Gets a report of premium request usage for an organization. To - use this endpoint, you must be an administrator of an organization within - an enterprise or an organization account. + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-org @@ -23946,6 +23947,57 @@ paths: enabledForGitHubApps: true category: orgs subcategory: attestations + "/orgs/{org}/attestations/repositories": + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/orgs/orgs#list-attestation-repositories + parameters: + - *17 + - *40 + - *41 + - *105 + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + value: + - id: 123 + name: foo + - id: 456 + name: bar + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/attestations/{attestation_id}": delete: summary: Delete attestations by ID @@ -105892,7 +105944,10 @@ paths: "/users/{username}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for a user - description: Gets a report of premium request usage for a user. + description: |- + Gets a report of premium request usage for a user. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-user diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index c2fc1bc49..070eb7c91 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -57751,7 +57751,7 @@ "/enterprises/{enterprise}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an enterprise", - "description": "Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.", + "description": "Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -100932,7 +100932,7 @@ "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", - "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.", + "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -119821,6 +119821,110 @@ } } }, + "/orgs/{org}/attestations/repositories": { + "get": { + "summary": "List attestation repositories", + "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-attestation-repositories" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "before", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "after", + "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "predicate_type", + "description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": [ + { + "id": 123, + "name": "foo" + }, + { + "id": 456, + "name": "bar" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/attestations/{attestation_id}": { "delete": { "summary": "Delete attestations by ID", @@ -716702,7 +716806,7 @@ "/users/{username}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for a user", - "description": "Gets a report of premium request usage for a user.", + "description": "Gets a report of premium request usage for a user.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index b2f4ab095..71b7f9458 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -21004,8 +21004,10 @@ paths: "/enterprises/{enterprise}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an enterprise - description: Gets a report of premium request usage for an enterprise. To use - this endpoint, you must be an administrator or billing manager of the enterprise. + description: |- + Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-ghe @@ -29234,9 +29236,10 @@ paths: "/organizations/{org}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for an organization - description: Gets a report of premium request usage for an organization. To - use this endpoint, you must be an administrator of an organization within - an enterprise or an organization account. + description: |- + Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-org @@ -34648,6 +34651,57 @@ paths: enabledForGitHubApps: true category: orgs subcategory: attestations + "/orgs/{org}/attestations/repositories": + get: + summary: List attestation repositories + description: |- + List repositories owned by the provided organization that have created at least one attested artifact + Results will be sorted in ascending order by repository ID + tags: + - orgs + operationId: orgs/list-attestation-repositories + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-attestation-repositories + parameters: + - *17 + - *99 + - *100 + - *78 + - name: predicate_type + description: |- + Optional filter for fetching attestations with a given predicate type. + This option accepts `provenance`, `sbom`, or freeform text for custom predicate types. + in: query + required: false + schema: + type: string + responses: + '200': + description: Response + content: + application/json: + schema: + type: array + items: + type: object + properties: + id: + type: integer + name: + type: string + examples: + default: + value: + - id: 123 + name: foo + - id: 456 + name: bar + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/attestations/{attestation_id}": delete: summary: Delete attestations by ID @@ -119558,7 +119612,10 @@ paths: "/users/{username}/settings/billing/premium_request/usage": get: summary: Get billing premium request usage report for a user - description: Gets a report of premium request usage for a user. + description: |- + Gets a report of premium request usage for a user. + + **Note:** Only data from the past 24 months is accessible via this endpoint. tags: - billing operationId: billing/get-github-billing-premium-request-usage-report-user diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index c2fc1bc49..070eb7c91 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -57751,7 +57751,7 @@ "/enterprises/{enterprise}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an enterprise", - "description": "Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.", + "description": "Gets a report of premium request usage for an enterprise. To use this endpoint, you must be an administrator or billing manager of the enterprise.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -100932,7 +100932,7 @@ "/organizations/{org}/settings/billing/premium_request/usage": { "get": { "summary": "Get billing premium request usage report for an organization", - "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.", + "description": "Gets a report of premium request usage for an organization. To use this endpoint, you must be an administrator of an organization within an enterprise or an organization account.\n\n**Note:** Only data from the past 24 months is accessible via this endpoint.", "tags": [ "billing" ], @@ -119821,6 +119821,110 @@ } } }, + "/orgs/{org}/attestations/repositories": { + "get": { + "summary": "List attestation repositories", + "description": "List repositories owned by the provided organization that have created at least one attested artifact\nResults will be sorted in ascending order by repository ID", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-attestation-repositories", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-attestation-repositories" + }, + "parameters": [ + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest//rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + {"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}