Skip to content

Commit f44c55b

Browse files
docs-botahpookhubwriter
authored
Update OpenAPI Description (#62182)
Co-authored-by: Eric Sorenson <ahpook@github.com> Co-authored-by: hubwriter <hubwriter@github.com>
1 parent 5953b5b commit f44c55b

49 files changed

Lines changed: 2553 additions & 129 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/rest/enterprise-admin/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ children:
3535
- /repo-pre-receive-hooks
3636
- /rules
3737
- /scim
38+
- /security-advisories
3839
- /users
3940
autogenerated: rest
4041
---
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: "REST API endpoints for security advisories"
3+
shortTitle: "Security advisories"
4+
intro: "Use the REST API to create and manage innersource security alerts"
5+
category:
6+
- Secure code and manage vulnerabilities
7+
versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
8+
ghec: '*'
9+
autogenerated: rest
10+
allowTitleToDifferFromFilename: true
11+
---
12+
13+
<!-- Content after this section is automatically generated -->

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -586,6 +586,34 @@
586586
}
587587
]
588588
},
589+
"enterprise_innersource_vulnerabilities": {
590+
"title": "Enterprise innersource vulnerabilities",
591+
"displayTitle": "Enterprise permissions for \"Enterprise innersource vulnerabilities\"",
592+
"permissions": [
593+
{
594+
"category": "enterprise-admin",
595+
"slug": "sync-innersource-vulnerabilities-for-an-enterprise",
596+
"subcategory": "security-advisories",
597+
"verb": "post",
598+
"requestPath": "/enterprises/{enterprise}/innersource-vulnerabilities/sync",
599+
"access": "write",
600+
"user-to-server": false,
601+
"server-to-server": true,
602+
"additional-permissions": false
603+
},
604+
{
605+
"category": "enterprise-admin",
606+
"slug": "get-innersource-vulnerability-sync-status-for-an-enterprise",
607+
"subcategory": "security-advisories",
608+
"verb": "get",
609+
"requestPath": "/enterprises/{enterprise}/innersource-vulnerabilities/sync/status/{job_id}",
610+
"access": "write",
611+
"user-to-server": false,
612+
"server-to-server": true,
613+
"additional-permissions": false
614+
}
615+
]
616+
},
589617
"enterprise_organization_installation_repositories": {
590618
"title": "Enterprise organization installation repositories",
591619
"displayTitle": "Enterprise permissions for \"Enterprise organization installation repositories\"",

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3164,6 +3164,18 @@
31643164
"verb": "get",
31653165
"requestPath": "/enterprises/{enterprise}/enterprise-roles/{role_id}/users"
31663166
},
3167+
{
3168+
"slug": "sync-innersource-vulnerabilities-for-an-enterprise",
3169+
"subcategory": "security-advisories",
3170+
"verb": "post",
3171+
"requestPath": "/enterprises/{enterprise}/innersource-vulnerabilities/sync"
3172+
},
3173+
{
3174+
"slug": "get-innersource-vulnerability-sync-status-for-an-enterprise",
3175+
"subcategory": "security-advisories",
3176+
"verb": "get",
3177+
"requestPath": "/enterprises/{enterprise}/innersource-vulnerabilities/sync/status/{job_id}"
3178+
},
31673179
{
31683180
"slug": "get-a-license-sync-status",
31693181
"subcategory": "licensing",

src/github-apps/data/ghec-2026-03-10/server-to-server-permissions.json

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -586,6 +586,34 @@
586586
}
587587
]
588588
},
589+
"enterprise_innersource_vulnerabilities": {
590+
"title": "Enterprise innersource vulnerabilities",
591+
"displayTitle": "Enterprise permissions for \"Enterprise innersource vulnerabilities\"",
592+
"permissions": [
593+
{
594+
"category": "enterprise-admin",
595+
"slug": "sync-innersource-vulnerabilities-for-an-enterprise",
596+
"subcategory": "security-advisories",
597+
"verb": "post",
598+
"requestPath": "/enterprises/{enterprise}/innersource-vulnerabilities/sync",
599+
"access": "write",
600+
"user-to-server": false,
601+
"server-to-server": true,
602+
"additional-permissions": false
603+
},
604+
{
605+
"category": "enterprise-admin",
606+
"slug": "get-innersource-vulnerability-sync-status-for-an-enterprise",
607+
"subcategory": "security-advisories",
608+
"verb": "get",
609+
"requestPath": "/enterprises/{enterprise}/innersource-vulnerabilities/sync/status/{job_id}",
610+
"access": "write",
611+
"user-to-server": false,
612+
"server-to-server": true,
613+
"additional-permissions": false
614+
}
615+
]
616+
},
589617
"enterprise_organization_installation_repositories": {
590618
"title": "Enterprise organization installation repositories",
591619
"displayTitle": "Enterprise permissions for \"Enterprise organization installation repositories\"",

src/github-apps/data/ghec-2026-03-10/server-to-server-rest.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3164,6 +3164,18 @@
31643164
"verb": "get",
31653165
"requestPath": "/enterprises/{enterprise}/enterprise-roles/{role_id}/users"
31663166
},
3167+
{
3168+
"slug": "sync-innersource-vulnerabilities-for-an-enterprise",
3169+
"subcategory": "security-advisories",
3170+
"verb": "post",
3171+
"requestPath": "/enterprises/{enterprise}/innersource-vulnerabilities/sync"
3172+
},
3173+
{
3174+
"slug": "get-innersource-vulnerability-sync-status-for-an-enterprise",
3175+
"subcategory": "security-advisories",
3176+
"verb": "get",
3177+
"requestPath": "/enterprises/{enterprise}/innersource-vulnerabilities/sync/status/{job_id}"
3178+
},
31673179
{
31683180
"slug": "get-a-license-sync-status",
31693181
"subcategory": "licensing",

src/github-apps/data/shared/entries.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

src/github-apps/data/version-index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

src/github-apps/lib/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@
6060
"2022-11-28"
6161
]
6262
},
63-
"sha": "a70b6c5b86500ea35cb362ba0cbc940a7bb2155e"
63+
"sha": "c7e0478faa2fd2efc21bf72da5227a58ae3d42c9"
6464
}

src/rest/data/fpt-2022-11-28/apps.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5789,7 +5789,7 @@
57895789
"token_last_eight": "Ae178B4a",
57905790
"hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8",
57915791
"app": {
5792-
"url": "http://my-github-app.com",
5792+
"url": "https://example.com",
57935793
"name": "my github app",
57945794
"client_id": "Iv1.8a61f9b3a7aba766"
57955795
},
@@ -15579,7 +15579,7 @@
1557915579
"token_last_eight": "Ae178B4a",
1558015580
"hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8",
1558115581
"app": {
15582-
"url": "http://my-github-app.com",
15582+
"url": "https://example.com",
1558315583
"name": "my github app",
1558415584
"client_id": "Iv1.8a61f9b3a7aba766"
1558515585
},
@@ -16523,7 +16523,7 @@
1652316523
"token_last_eight": "Ae178B4a",
1652416524
"hashed_token": "25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8",
1652516525
"app": {
16526-
"url": "http://my-github-app.com",
16526+
"url": "https://example.com",
1652716527
"name": "my github app",
1652816528
"client_id": "Iv1.8a61f9b3a7aba766"
1652916529
},

0 commit comments

Comments
 (0)