Skip to content

Commit a276f96

Browse files
Update OpenAPI 3.0 Descriptions
1 parent 1cd73ab commit a276f96

24 files changed

+528
-184
lines changed

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

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2177,10 +2177,12 @@
21772177
},
21782178
"advanced_security": {
21792179
"type": "string",
2180-
"description": "The enablement status of GitHub Advanced Security",
2180+
"description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.",
21812181
"enum": [
21822182
"enabled",
2183-
"disabled"
2183+
"disabled",
2184+
"code_security",
2185+
"secret_protection"
21842186
],
21852187
"default": "disabled"
21862188
},
@@ -2526,10 +2528,12 @@
25262528
},
25272529
"advanced_security": {
25282530
"type": "string",
2529-
"description": "The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings.",
2531+
"description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.",
25302532
"enum": [
25312533
"enabled",
2532-
"disabled"
2534+
"disabled",
2535+
"code_security",
2536+
"secret_protection"
25332537
]
25342538
},
25352539
"dependency_graph": {
@@ -11405,10 +11409,12 @@
1140511409
},
1140611410
"advanced_security": {
1140711411
"type": "string",
11408-
"description": "The enablement status of GitHub Advanced Security",
11412+
"description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.",
1140911413
"enum": [
1141011414
"enabled",
11411-
"disabled"
11415+
"disabled",
11416+
"code_security",
11417+
"secret_protection"
1141211418
],
1141311419
"default": "disabled"
1141411420
},
@@ -11868,10 +11874,12 @@
1186811874
},
1186911875
"advanced_security": {
1187011876
"type": "string",
11871-
"description": "The enablement status of GitHub Advanced Security",
11877+
"description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.",
1187211878
"enum": [
1187311879
"enabled",
11874-
"disabled"
11880+
"disabled",
11881+
"code_security",
11882+
"secret_protection"
1187511883
]
1187611884
},
1187711885
"dependency_graph": {
@@ -98107,7 +98115,9 @@
9810798115
"description": "The enablement status of GitHub Advanced Security",
9810898116
"enum": [
9810998117
"enabled",
98110-
"disabled"
98118+
"disabled",
98119+
"code_security",
98120+
"secret_protection"
9811198121
]
9811298122
},
9811398123
"dependency_graph": {

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

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1513,10 +1513,14 @@ paths:
15131513
maxLength: 255
15141514
advanced_security:
15151515
type: string
1516-
description: The enablement status of GitHub Advanced Security
1516+
description: The enablement status of GitHub Advanced Security features.
1517+
`enabled` will enable both Code Security and Secret Protection
1518+
features.
15171519
enum:
15181520
- enabled
15191521
- disabled
1522+
- code_security
1523+
- secret_protection
15201524
default: disabled
15211525
dependency_graph:
15221526
type: string
@@ -1783,11 +1787,14 @@ paths:
17831787
maxLength: 255
17841788
advanced_security:
17851789
type: string
1786-
description: The enablement status of GitHub Advanced Security.
1787-
Must be set to enabled if you want to enable any GHAS settings.
1790+
description: The enablement status of GitHub Advanced Security features.
1791+
`enabled` will enable both Code Security and Secret Protection
1792+
features.
17881793
enum:
17891794
- enabled
17901795
- disabled
1796+
- code_security
1797+
- secret_protection
17911798
dependency_graph:
17921799
type: string
17931800
description: The enablement status of Dependency Graph
@@ -8267,10 +8274,14 @@ paths:
82678274
maxLength: 255
82688275
advanced_security:
82698276
type: string
8270-
description: The enablement status of GitHub Advanced Security
8277+
description: The enablement status of GitHub Advanced Security features.
8278+
`enabled` will enable both Code Security and Secret Protection
8279+
features.
82718280
enum:
82728281
- enabled
82738282
- disabled
8283+
- code_security
8284+
- secret_protection
82748285
default: disabled
82758286
dependency_graph:
82768287
type: string
@@ -8624,10 +8635,14 @@ paths:
86248635
maxLength: 255
86258636
advanced_security:
86268637
type: string
8627-
description: The enablement status of GitHub Advanced Security
8638+
description: The enablement status of GitHub Advanced Security features.
8639+
`enabled` will enable both Code Security and Secret Protection
8640+
features.
86288641
enum:
86298642
- enabled
86308643
- disabled
8644+
- code_security
8645+
- secret_protection
86318646
dependency_graph:
86328647
type: string
86338648
description: The enablement status of Dependency Graph
@@ -71269,6 +71284,8 @@ components:
7126971284
enum:
7127071285
- enabled
7127171286
- disabled
71287+
- code_security
71288+
- secret_protection
7127271289
dependency_graph:
7127371290
type: string
7127471291
description: The enablement status of Dependency Graph

descriptions/api.github.com/api.github.com.json

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2177,10 +2177,12 @@
21772177
},
21782178
"advanced_security": {
21792179
"type": "string",
2180-
"description": "The enablement status of GitHub Advanced Security",
2180+
"description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.",
21812181
"enum": [
21822182
"enabled",
2183-
"disabled"
2183+
"disabled",
2184+
"code_security",
2185+
"secret_protection"
21842186
],
21852187
"default": "disabled"
21862188
},
@@ -2526,10 +2528,12 @@
25262528
},
25272529
"advanced_security": {
25282530
"type": "string",
2529-
"description": "The enablement status of GitHub Advanced Security. Must be set to enabled if you want to enable any GHAS settings.",
2531+
"description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.",
25302532
"enum": [
25312533
"enabled",
2532-
"disabled"
2534+
"disabled",
2535+
"code_security",
2536+
"secret_protection"
25332537
]
25342538
},
25352539
"dependency_graph": {
@@ -11405,10 +11409,12 @@
1140511409
},
1140611410
"advanced_security": {
1140711411
"type": "string",
11408-
"description": "The enablement status of GitHub Advanced Security",
11412+
"description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.",
1140911413
"enum": [
1141011414
"enabled",
11411-
"disabled"
11415+
"disabled",
11416+
"code_security",
11417+
"secret_protection"
1141211418
],
1141311419
"default": "disabled"
1141411420
},
@@ -11868,10 +11874,12 @@
1186811874
},
1186911875
"advanced_security": {
1187011876
"type": "string",
11871-
"description": "The enablement status of GitHub Advanced Security",
11877+
"description": "The enablement status of GitHub Advanced Security features. `enabled` will enable both Code Security and Secret Protection features.",
1187211878
"enum": [
1187311879
"enabled",
11874-
"disabled"
11880+
"disabled",
11881+
"code_security",
11882+
"secret_protection"
1187511883
]
1187611884
},
1187711885
"dependency_graph": {
@@ -98107,7 +98115,9 @@
9810798115
"description": "The enablement status of GitHub Advanced Security",
9810898116
"enum": [
9810998117
"enabled",
98110-
"disabled"
98118+
"disabled",
98119+
"code_security",
98120+
"secret_protection"
9811198121
]
9811298122
},
9811398123
"dependency_graph": {

descriptions/api.github.com/api.github.com.yaml

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1513,10 +1513,14 @@ paths:
15131513
maxLength: 255
15141514
advanced_security:
15151515
type: string
1516-
description: The enablement status of GitHub Advanced Security
1516+
description: The enablement status of GitHub Advanced Security features.
1517+
`enabled` will enable both Code Security and Secret Protection
1518+
features.
15171519
enum:
15181520
- enabled
15191521
- disabled
1522+
- code_security
1523+
- secret_protection
15201524
default: disabled
15211525
dependency_graph:
15221526
type: string
@@ -1783,11 +1787,14 @@ paths:
17831787
maxLength: 255
17841788
advanced_security:
17851789
type: string
1786-
description: The enablement status of GitHub Advanced Security.
1787-
Must be set to enabled if you want to enable any GHAS settings.
1790+
description: The enablement status of GitHub Advanced Security features.
1791+
`enabled` will enable both Code Security and Secret Protection
1792+
features.
17881793
enum:
17891794
- enabled
17901795
- disabled
1796+
- code_security
1797+
- secret_protection
17911798
dependency_graph:
17921799
type: string
17931800
description: The enablement status of Dependency Graph
@@ -8267,10 +8274,14 @@ paths:
82678274
maxLength: 255
82688275
advanced_security:
82698276
type: string
8270-
description: The enablement status of GitHub Advanced Security
8277+
description: The enablement status of GitHub Advanced Security features.
8278+
`enabled` will enable both Code Security and Secret Protection
8279+
features.
82718280
enum:
82728281
- enabled
82738282
- disabled
8283+
- code_security
8284+
- secret_protection
82748285
default: disabled
82758286
dependency_graph:
82768287
type: string
@@ -8624,10 +8635,14 @@ paths:
86248635
maxLength: 255
86258636
advanced_security:
86268637
type: string
8627-
description: The enablement status of GitHub Advanced Security
8638+
description: The enablement status of GitHub Advanced Security features.
8639+
`enabled` will enable both Code Security and Secret Protection
8640+
features.
86288641
enum:
86298642
- enabled
86308643
- disabled
8644+
- code_security
8645+
- secret_protection
86318646
dependency_graph:
86328647
type: string
86338648
description: The enablement status of Dependency Graph
@@ -71269,6 +71284,8 @@ components:
7126971284
enum:
7127071285
- enabled
7127171286
- disabled
71287+
- code_security
71288+
- secret_protection
7127271289
dependency_graph:
7127371290
type: string
7127471291
description: The enablement status of Dependency Graph

0 commit comments

Comments
 (0)