Skip to content

Commit eab49cc

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.1 Descriptions
1 parent 45124e4 commit eab49cc

16 files changed

+1264
-60
lines changed

‎descriptions-next/api.github.com/api.github.com.2022-11-28.json‎

Lines changed: 85 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7306,7 +7306,7 @@
73067306
"/organizations/{org}/settings/billing/premium_request/usage": {
73077307
"get": {
73087308
"summary": "Get billing premium request usage report for an organization",
7309-
"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.",
7309+
"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.",
73107310
"tags": [
73117311
"billing"
73127312
],
@@ -12816,6 +12816,77 @@
1281612816
}
1281712817
}
1281812818
},
12819+
"/orgs/{org}/attestations/repositories": {
12820+
"get": {
12821+
"summary": "List attestation repositories",
12822+
"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",
12823+
"tags": [
12824+
"orgs"
12825+
],
12826+
"operationId": "orgs/list-attestation-repositories",
12827+
"externalDocs": {
12828+
"description": "API method documentation",
12829+
"url": "https://docs.github.com/rest/orgs/orgs#list-attestation-repositories"
12830+
},
12831+
"parameters": [
12832+
{
12833+
"$ref": "#/components/parameters/per-page"
12834+
},
12835+
{
12836+
"$ref": "#/components/parameters/pagination-before"
12837+
},
12838+
{
12839+
"$ref": "#/components/parameters/pagination-after"
12840+
},
12841+
{
12842+
"$ref": "#/components/parameters/org"
12843+
},
12844+
{
12845+
"name": "predicate_type",
12846+
"description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.",
12847+
"in": "query",
12848+
"required": false,
12849+
"schema": {
12850+
"type": "string"
12851+
}
12852+
}
12853+
],
12854+
"responses": {
12855+
"200": {
12856+
"description": "Response",
12857+
"content": {
12858+
"application/json": {
12859+
"schema": {
12860+
"type": "array",
12861+
"items": {
12862+
"type": "object",
12863+
"properties": {
12864+
"id": {
12865+
"type": "integer"
12866+
},
12867+
"name": {
12868+
"type": "string"
12869+
}
12870+
}
12871+
}
12872+
},
12873+
"examples": {
12874+
"default": {
12875+
"$ref": "#/components/examples/list-attestation-repositories"
12876+
}
12877+
}
12878+
}
12879+
}
12880+
}
12881+
},
12882+
"x-github": {
12883+
"githubCloudOnly": false,
12884+
"enabledForGitHubApps": true,
12885+
"category": "orgs",
12886+
"subcategory": "orgs"
12887+
}
12888+
}
12889+
},
1281912890
"/orgs/{org}/attestations/{attestation_id}": {
1282012891
"delete": {
1282112892
"summary": "Delete attestations by ID",
@@ -76022,7 +76093,7 @@
7602276093
"/users/{username}/settings/billing/premium_request/usage": {
7602376094
"get": {
7602476095
"summary": "Get billing premium request usage report for a user",
76025-
"description": "Gets a report of premium request usage for a user.",
76096+
"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.",
7602676097
"tags": [
7602776098
"billing"
7602876099
],
@@ -291971,6 +292042,18 @@
291971292042
]
291972292043
}
291973292044
},
292045+
"list-attestation-repositories": {
292046+
"value": [
292047+
{
292048+
"id": 123,
292049+
"name": "foo"
292050+
},
292051+
{
292052+
"id": 456,
292053+
"name": "bar"
292054+
}
292055+
]
292056+
},
291974292057
"list-attestations": {
291975292058
"value": {
291976292059
"attestations": [

‎descriptions-next/api.github.com/api.github.com.2022-11-28.yaml‎

Lines changed: 61 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5139,9 +5139,10 @@ paths:
51395139
"/organizations/{org}/settings/billing/premium_request/usage":
51405140
get:
51415141
summary: Get billing premium request usage report for an organization
5142-
description: Gets a report of premium request usage for an organization. To
5143-
use this endpoint, you must be an administrator of an organization within
5144-
an enterprise or an organization account.
5142+
description: |-
5143+
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.
5144+
5145+
**Note:** Only data from the past 24 months is accessible via this endpoint.
51455146
tags:
51465147
- billing
51475148
operationId: billing/get-github-billing-premium-request-usage-report-org
@@ -9221,6 +9222,53 @@ paths:
92219222
enabledForGitHubApps: true
92229223
category: orgs
92239224
subcategory: attestations
9225+
"/orgs/{org}/attestations/repositories":
9226+
get:
9227+
summary: List attestation repositories
9228+
description: |-
9229+
List repositories owned by the provided organization that have created at least one attested artifact
9230+
Results will be sorted in ascending order by repository ID
9231+
tags:
9232+
- orgs
9233+
operationId: orgs/list-attestation-repositories
9234+
externalDocs:
9235+
description: API method documentation
9236+
url: https://docs.github.com/rest/orgs/orgs#list-attestation-repositories
9237+
parameters:
9238+
- "$ref": "#/components/parameters/per-page"
9239+
- "$ref": "#/components/parameters/pagination-before"
9240+
- "$ref": "#/components/parameters/pagination-after"
9241+
- "$ref": "#/components/parameters/org"
9242+
- name: predicate_type
9243+
description: |-
9244+
Optional filter for fetching attestations with a given predicate type.
9245+
This option accepts `provenance`, `sbom`, or freeform text for custom predicate types.
9246+
in: query
9247+
required: false
9248+
schema:
9249+
type: string
9250+
responses:
9251+
'200':
9252+
description: Response
9253+
content:
9254+
application/json:
9255+
schema:
9256+
type: array
9257+
items:
9258+
type: object
9259+
properties:
9260+
id:
9261+
type: integer
9262+
name:
9263+
type: string
9264+
examples:
9265+
default:
9266+
"$ref": "#/components/examples/list-attestation-repositories"
9267+
x-github:
9268+
githubCloudOnly: false
9269+
enabledForGitHubApps: true
9270+
category: orgs
9271+
subcategory: orgs
92249272
"/orgs/{org}/attestations/{attestation_id}":
92259273
delete:
92269274
summary: Delete attestations by ID
@@ -54950,7 +54998,10 @@ paths:
5495054998
"/users/{username}/settings/billing/premium_request/usage":
5495154999
get:
5495255000
summary: Get billing premium request usage report for a user
54953-
description: Gets a report of premium request usage for a user.
55001+
description: |-
55002+
Gets a report of premium request usage for a user.
55003+
55004+
**Note:** Only data from the past 24 months is accessible via this endpoint.
5495455005
tags:
5495555006
- billing
5495655007
operationId: billing/get-github-billing-premium-request-usage-report-user
@@ -215296,6 +215347,12 @@ components:
215296215347
signatures:
215297215348
- sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==
215298215349
repository_id: 1
215350+
list-attestation-repositories:
215351+
value:
215352+
- id: 123
215353+
name: foo
215354+
- id: 456
215355+
name: bar
215299215356
list-attestations:
215300215357
value:
215301215358
attestations:

‎descriptions-next/api.github.com/api.github.com.json‎

Lines changed: 85 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7306,7 +7306,7 @@
73067306
"/organizations/{org}/settings/billing/premium_request/usage": {
73077307
"get": {
73087308
"summary": "Get billing premium request usage report for an organization",
7309-
"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.",
7309+
"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.",
73107310
"tags": [
73117311
"billing"
73127312
],
@@ -12816,6 +12816,77 @@
1281612816
}
1281712817
}
1281812818
},
12819+
"/orgs/{org}/attestations/repositories": {
12820+
"get": {
12821+
"summary": "List attestation repositories",
12822+
"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",
12823+
"tags": [
12824+
"orgs"
12825+
],
12826+
"operationId": "orgs/list-attestation-repositories",
12827+
"externalDocs": {
12828+
"description": "API method documentation",
12829+
"url": "https://docs.github.com/rest/orgs/orgs#list-attestation-repositories"
12830+
},
12831+
"parameters": [
12832+
{
12833+
"$ref": "#/components/parameters/per-page"
12834+
},
12835+
{
12836+
"$ref": "#/components/parameters/pagination-before"
12837+
},
12838+
{
12839+
"$ref": "#/components/parameters/pagination-after"
12840+
},
12841+
{
12842+
"$ref": "#/components/parameters/org"
12843+
},
12844+
{
12845+
"name": "predicate_type",
12846+
"description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.",
12847+
"in": "query",
12848+
"required": false,
12849+
"schema": {
12850+
"type": "string"
12851+
}
12852+
}
12853+
],
12854+
"responses": {
12855+
"200": {
12856+
"description": "Response",
12857+
"content": {
12858+
"application/json": {
12859+
"schema": {
12860+
"type": "array",
12861+
"items": {
12862+
"type": "object",
12863+
"properties": {
12864+
"id": {
12865+
"type": "integer"
12866+
},
12867+
"name": {
12868+
"type": "string"
12869+
}
12870+
}
12871+
}
12872+
},
12873+
"examples": {
12874+
"default": {
12875+
"$ref": "#/components/examples/list-attestation-repositories"
12876+
}
12877+
}
12878+
}
12879+
}
12880+
}
12881+
},
12882+
"x-github": {
12883+
"githubCloudOnly": false,
12884+
"enabledForGitHubApps": true,
12885+
"category": "orgs",
12886+
"subcategory": "orgs"
12887+
}
12888+
}
12889+
},
1281912890
"/orgs/{org}/attestations/{attestation_id}": {
1282012891
"delete": {
1282112892
"summary": "Delete attestations by ID",
@@ -76022,7 +76093,7 @@
7602276093
"/users/{username}/settings/billing/premium_request/usage": {
7602376094
"get": {
7602476095
"summary": "Get billing premium request usage report for a user",
76025-
"description": "Gets a report of premium request usage for a user.",
76096+
"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.",
7602676097
"tags": [
7602776098
"billing"
7602876099
],
@@ -291971,6 +292042,18 @@
291971292042
]
291972292043
}
291973292044
},
292045+
"list-attestation-repositories": {
292046+
"value": [
292047+
{
292048+
"id": 123,
292049+
"name": "foo"
292050+
},
292051+
{
292052+
"id": 456,
292053+
"name": "bar"
292054+
}
292055+
]
292056+
},
291974292057
"list-attestations": {
291975292058
"value": {
291976292059
"attestations": [

0 commit comments

Comments
 (0)