Skip to content

Commit bd24cfd

Browse files
docs-botisaacmbrownheiskr
authored
Update OpenAPI Description (#57441)
Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
1 parent e21e1e0 commit bd24cfd

File tree

29 files changed

+1884
-4044
lines changed

29 files changed

+1884
-4044
lines changed

‎content/rest/orgs/artifact-metadata.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: Artifact metadata
3+
shortTitle: Artifact metadata
4+
intro: "Use these endpoints to retrieve and manage metadata for artifacts in your organization. Artifact metadata provides information about build artifacts, their provenance, and related details."
5+
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
6+
fpt: '*'
7+
ghec: '*'
8+
topics:
9+
- API
10+
autogenerated: rest
11+
allowTitleToDifferFromFilename: true
12+
---
13+
14+
<!-- Content after this section is automatically generated -->

‎content/rest/orgs/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ topics:
1616
- API
1717
children:
1818
- /api-insights
19+
- /artifact-metadata
1920
- /attestations
2021
- /blocking
2122
- /bypass-requests

‎content/rest/projects-classic/cards.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
---
2-
title: 'REST API endpoints for {% data variables.product.prodname_project_v1_caps %} cards'
2+
title: >-
3+
REST API endpoints for {% data variables.product.prodname_project_v1_caps %}
4+
cards
35
shortTitle: Cards
46
allowTitleToDifferFromFilename: true
57
intro: >-
68
Use the REST API to create and manage cards on a {% data
79
variables.projects.projects_v1_board %}.
810
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
9-
fpt: '*'
1011
ghec: '*'
11-
ghes: '*'
12+
ghes: <=3.16
1213
topics:
1314
- API
1415
autogenerated: rest

‎src/fixtures/fixtures/rest-redirects.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@
9595
"/en/enterprise/2.18/v3/users/gpg_keys": "/en/enterprise/2.18/user/rest/reference/users#gpg-keys",
9696
"/en/enterprise/2.18/v3/users": "/en/enterprise/2.18/user/rest/reference/users",
9797
"/en/enterprise/2.18/v3/users/keys": "/en/enterprise/2.18/user/rest/reference/users#keys",
98-
"/en/enterprise/2.19/v3/activity/event_types": "/en/enterprise-server@2.19/developers/webhooks-and-events/github-event-types",
98+
"/en/enterprise/2.19/v3/activity/event_types": "/en/enterprise-server@2.19/developers/webhooks-and-events/github-event-types",
9999
"/en/enterprise/2.19/v3/activity/events/types": "/en/enterprise-server@2.19/developers/webhooks-and-events/webhook-events-and-payloads",
100100
"/en/enterprise/2.19/v3/activity/events": "/en/enterprise-server@2.19/rest/reference/activity#events",
101101
"/en/enterprise/2.19/v3/activity/feeds": "/en/enterprise-server@2.19/rest/reference/activity#feeds",
@@ -460,7 +460,7 @@
460460
"/v3/orgs/outside_collaborators": "/en/rest/orgs/outside-collaborators",
461461
"/v3/orgs/pre_receive_hooks": "/en/enterprise-server/rest/enterprise-admin/org-pre-receive-hooks",
462462
"/v3/orgs/teams": "/en/rest/teams/teams",
463-
"/v3/projects/cards": "/en/rest/projects-classic/cards",
463+
"/v3/projects/cards": "/en/enterprise-cloud@latest/rest/projects-classic/cards",
464464
"/v3/projects/collaborators": "/en/rest/projects-classic/collaborators",
465465
"/v3/projects/columns": "/en/rest/projects-classic/columns",
466466
"/v3/projects": "/en/rest/projects-classic",

‎src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5139,6 +5139,24 @@
51395139
"additional-permissions": false,
51405140
"access": "read"
51415141
},
5142+
{
5143+
"category": "orgs",
5144+
"slug": "create-artifact-metadata-storage-record",
5145+
"subcategory": "artifact-metadata",
5146+
"verb": "post",
5147+
"requestPath": "/orgs/{org}/artifacts/metadata/storage-record",
5148+
"additional-permissions": false,
5149+
"access": "write"
5150+
},
5151+
{
5152+
"category": "orgs",
5153+
"slug": "list-artifact-storage-records",
5154+
"subcategory": "artifact-metadata",
5155+
"verb": "get",
5156+
"requestPath": "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records",
5157+
"additional-permissions": false,
5158+
"access": "read"
5159+
},
51425160
{
51435161
"category": "repos",
51445162
"slug": "list-repository-activities",

‎src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3000,6 +3000,18 @@
30003000
"verb": "delete",
30013001
"requestPath": "/orgs/{org}"
30023002
},
3003+
{
3004+
"slug": "create-artifact-metadata-storage-record",
3005+
"subcategory": "artifact-metadata",
3006+
"verb": "post",
3007+
"requestPath": "/orgs/{org}/artifacts/metadata/storage-record"
3008+
},
3009+
{
3010+
"slug": "list-artifact-storage-records",
3011+
"subcategory": "artifact-metadata",
3012+
"verb": "get",
3013+
"requestPath": "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records"
3014+
},
30033015
{
30043016
"slug": "delete-attestations-in-bulk",
30053017
"subcategory": "attestations",

‎src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6477,6 +6477,28 @@
64776477
"server-to-server": true,
64786478
"additional-permissions": false
64796479
},
6480+
{
6481+
"category": "orgs",
6482+
"slug": "create-artifact-metadata-storage-record",
6483+
"subcategory": "artifact-metadata",
6484+
"verb": "post",
6485+
"requestPath": "/orgs/{org}/artifacts/metadata/storage-record",
6486+
"access": "write",
6487+
"user-to-server": true,
6488+
"server-to-server": true,
6489+
"additional-permissions": false
6490+
},
6491+
{
6492+
"category": "orgs",
6493+
"slug": "list-artifact-storage-records",
6494+
"subcategory": "artifact-metadata",
6495+
"verb": "get",
6496+
"requestPath": "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records",
6497+
"access": "read",
6498+
"user-to-server": true,
6499+
"server-to-server": true,
6500+
"additional-permissions": false
6501+
},
64806502
{
64816503
"category": "repos",
64826504
"slug": "list-repository-activities",

‎src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2894,6 +2894,18 @@
28942894
"verb": "delete",
28952895
"requestPath": "/orgs/{org}"
28962896
},
2897+
{
2898+
"slug": "create-artifact-metadata-storage-record",
2899+
"subcategory": "artifact-metadata",
2900+
"verb": "post",
2901+
"requestPath": "/orgs/{org}/artifacts/metadata/storage-record"
2902+
},
2903+
{
2904+
"slug": "list-artifact-storage-records",
2905+
"subcategory": "artifact-metadata",
2906+
"verb": "get",
2907+
"requestPath": "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records"
2908+
},
28972909
{
28982910
"slug": "list-attestations-by-bulk-subject-digests",
28992911
"subcategory": "orgs",

‎src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3374,6 +3374,18 @@
33743374
"verb": "delete",
33753375
"requestPath": "/orgs/{org}"
33763376
},
3377+
{
3378+
"slug": "create-artifact-metadata-storage-record",
3379+
"subcategory": "artifact-metadata",
3380+
"verb": "post",
3381+
"requestPath": "/orgs/{org}/artifacts/metadata/storage-record"
3382+
},
3383+
{
3384+
"slug": "list-artifact-storage-records",
3385+
"subcategory": "artifact-metadata",
3386+
"verb": "get",
3387+
"requestPath": "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records"
3388+
},
33773389
{
33783390
"slug": "list-attestations-by-bulk-subject-digests",
33793391
"subcategory": "orgs",

‎src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5892,6 +5892,24 @@
58925892
"additional-permissions": false,
58935893
"access": "read"
58945894
},
5895+
{
5896+
"category": "orgs",
5897+
"slug": "create-artifact-metadata-storage-record",
5898+
"subcategory": "artifact-metadata",
5899+
"verb": "post",
5900+
"requestPath": "/orgs/{org}/artifacts/metadata/storage-record",
5901+
"additional-permissions": false,
5902+
"access": "write"
5903+
},
5904+
{
5905+
"category": "orgs",
5906+
"slug": "list-artifact-storage-records",
5907+
"subcategory": "artifact-metadata",
5908+
"verb": "get",
5909+
"requestPath": "/orgs/{org}/artifacts/{subject_digest}/metadata/storage-records",
5910+
"additional-permissions": false,
5911+
"access": "read"
5912+
},
58955913
{
58965914
"category": "repos",
58975915
"slug": "list-repository-activities",

0 commit comments

Comments
 (0)