Skip to content

Update OpenAPI 3.1 Descriptions #5461

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update OpenAPI 3.1 Descriptions #5461

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 85 additions & 2 deletions descriptions-next/api.github.com/api.github.com.2022-11-28.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7306,7 +7306,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"
],
Expand Down Expand Up @@ -12816,6 +12816,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",
Expand Down Expand Up @@ -76022,7 +76093,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"
],
Expand Down Expand Up @@ -291971,6 +292042,18 @@
]
}
},
"list-attestation-repositories": {
"value": [
{
"id": 123,
"name": "foo"
},
{
"id": 456,
"name": "bar"
}
]
},
"list-attestations": {
"value": {
"attestations": [
Expand Down
65 changes: 61 additions & 4 deletions descriptions-next/api.github.com/api.github.com.2022-11-28.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5139,9 +5139,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
Expand Down Expand Up @@ -9221,6 +9222,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
Expand Down Expand Up @@ -54950,7 +54998,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
Expand Down Expand Up @@ -215296,6 +215347,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:
Expand Down
Loading