Skip to content

Commit e6aa639

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

16 files changed

+1264
-60
lines changed

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

Lines changed: 85 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7256,7 +7256,7 @@
72567256
"/organizations/{org}/settings/billing/premium_request/usage": {
72577257
"get": {
72587258
"summary": "Get billing premium request usage report for an organization",
7259-
"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.",
7259+
"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.",
72607260
"tags": [
72617261
"billing"
72627262
],
@@ -12734,6 +12734,77 @@
1273412734
}
1273512735
}
1273612736
},
12737+
"/orgs/{org}/attestations/repositories": {
12738+
"get": {
12739+
"summary": "List attestation repositories",
12740+
"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",
12741+
"tags": [
12742+
"orgs"
12743+
],
12744+
"operationId": "orgs/list-attestation-repositories",
12745+
"externalDocs": {
12746+
"description": "API method documentation",
12747+
"url": "https://docs.github.com/rest/orgs/orgs#list-attestation-repositories"
12748+
},
12749+
"parameters": [
12750+
{
12751+
"$ref": "#/components/parameters/per-page"
12752+
},
12753+
{
12754+
"$ref": "#/components/parameters/pagination-before"
12755+
},
12756+
{
12757+
"$ref": "#/components/parameters/pagination-after"
12758+
},
12759+
{
12760+
"$ref": "#/components/parameters/org"
12761+
},
12762+
{
12763+
"name": "predicate_type",
12764+
"description": "Optional filter for fetching attestations with a given predicate type.\nThis option accepts `provenance`, `sbom`, or freeform text for custom predicate types.",
12765+
"in": "query",
12766+
"required": false,
12767+
"schema": {
12768+
"type": "string"
12769+
}
12770+
}
12771+
],
12772+
"responses": {
12773+
"200": {
12774+
"description": "Response",
12775+
"content": {
12776+
"application/json": {
12777+
"schema": {
12778+
"type": "array",
12779+
"items": {
12780+
"type": "object",
12781+
"properties": {
12782+
"id": {
12783+
"type": "integer"
12784+
},
12785+
"name": {
12786+
"type": "string"
12787+
}
12788+
}
12789+
}
12790+
},
12791+
"examples": {
12792+
"default": {
12793+
"$ref": "#/components/examples/list-attestation-repositories"
12794+
}
12795+
}
12796+
}
12797+
}
12798+
}
12799+
},
12800+
"x-github": {
12801+
"githubCloudOnly": false,
12802+
"enabledForGitHubApps": true,
12803+
"category": "orgs",
12804+
"subcategory": "orgs"
12805+
}
12806+
}
12807+
},
1273712808
"/orgs/{org}/attestations/{attestation_id}": {
1273812809
"delete": {
1273912810
"summary": "Delete attestations by ID",
@@ -75625,7 +75696,7 @@
7562575696
"/users/{username}/settings/billing/premium_request/usage": {
7562675697
"get": {
7562775698
"summary": "Get billing premium request usage report for a user",
75628-
"description": "Gets a report of premium request usage for a user.",
75699+
"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.",
7562975700
"tags": [
7563075701
"billing"
7563175702
],
@@ -283043,6 +283114,18 @@
283043283114
]
283044283115
}
283045283116
},
283117+
"list-attestation-repositories": {
283118+
"value": [
283119+
{
283120+
"id": 123,
283121+
"name": "foo"
283122+
},
283123+
{
283124+
"id": 456,
283125+
"name": "bar"
283126+
}
283127+
]
283128+
},
283046283129
"list-attestations": {
283047283130
"value": {
283048283131
"attestations": [

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

Lines changed: 61 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5116,9 +5116,10 @@ paths:
51165116
"/organizations/{org}/settings/billing/premium_request/usage":
51175117
get:
51185118
summary: Get billing premium request usage report for an organization
5119-
description: Gets a report of premium request usage for an organization. To
5120-
use this endpoint, you must be an administrator of an organization within
5121-
an enterprise or an organization account.
5119+
description: |-
5120+
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.
5121+
5122+
**Note:** Only data from the past 24 months is accessible via this endpoint.
51225123
tags:
51235124
- billing
51245125
operationId: billing/get-github-billing-premium-request-usage-report-org
@@ -9182,6 +9183,53 @@ paths:
91829183
enabledForGitHubApps: true
91839184
category: orgs
91849185
subcategory: attestations
9186+
"/orgs/{org}/attestations/repositories":
9187+
get:
9188+
summary: List attestation repositories
9189+
description: |-
9190+
List repositories owned by the provided organization that have created at least one attested artifact
9191+
Results will be sorted in ascending order by repository ID
9192+
tags:
9193+
- orgs
9194+
operationId: orgs/list-attestation-repositories
9195+
externalDocs:
9196+
description: API method documentation
9197+
url: https://docs.github.com/rest/orgs/orgs#list-attestation-repositories
9198+
parameters:
9199+
- "$ref": "#/components/parameters/per-page"
9200+
- "$ref": "#/components/parameters/pagination-before"
9201+
- "$ref": "#/components/parameters/pagination-after"
9202+
- "$ref": "#/components/parameters/org"
9203+
- name: predicate_type
9204+
description: |-
9205+
Optional filter for fetching attestations with a given predicate type.
9206+
This option accepts `provenance`, `sbom`, or freeform text for custom predicate types.
9207+
in: query
9208+
required: false
9209+
schema:
9210+
type: string
9211+
responses:
9212+
'200':
9213+
description: Response
9214+
content:
9215+
application/json:
9216+
schema:
9217+
type: array
9218+
items:
9219+
type: object
9220+
properties:
9221+
id:
9222+
type: integer
9223+
name:
9224+
type: string
9225+
examples:
9226+
default:
9227+
"$ref": "#/components/examples/list-attestation-repositories"
9228+
x-github:
9229+
githubCloudOnly: false
9230+
enabledForGitHubApps: true
9231+
category: orgs
9232+
subcategory: orgs
91859233
"/orgs/{org}/attestations/{attestation_id}":
91869234
delete:
91879235
summary: Delete attestations by ID
@@ -54750,7 +54798,10 @@ paths:
5475054798
"/users/{username}/settings/billing/premium_request/usage":
5475154799
get:
5475254800
summary: Get billing premium request usage report for a user
54753-
description: Gets a report of premium request usage for a user.
54801+
description: |-
54802+
Gets a report of premium request usage for a user.
54803+
54804+
**Note:** Only data from the past 24 months is accessible via this endpoint.
5475454805
tags:
5475554806
- billing
5475654807
operationId: billing/get-github-billing-premium-request-usage-report-user
@@ -212043,6 +212094,12 @@ components:
212043212094
signatures:
212044212095
- sig: MEQCIEGIGAm7gZVLLpsrPcjndEjiuctE2/c9+j9KGvazz3rlAiAd6O16T5hkzRM3IbRPzm+xT40mNQZxefd7laDP6x2XLQ==
212045212096
repository_id: 1
212097+
list-attestation-repositories:
212098+
value:
212099+
- id: 123
212100+
name: foo
212101+
- id: 456
212102+
name: bar
212046212103
list-attestations:
212047212104
value:
212048212105
attestations:

0 commit comments

Comments
 (0)