Skip to content

Commit 4d63920

Browse files
Update OpenAPI 3.0 Descriptions
1 parent 28c94f8 commit 4d63920

28 files changed

+674
-104
lines changed

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

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15223,7 +15223,17 @@
1522315223
"description": "Whether the property is required."
1522415224
},
1522515225
"default_value": {
15226-
"type": "string",
15226+
"oneOf": [
15227+
{
15228+
"type": "string"
15229+
},
15230+
{
15231+
"type": "array",
15232+
"items": {
15233+
"type": "string"
15234+
}
15235+
}
15236+
],
1522715237
"nullable": true,
1522815238
"description": "Default value of the property"
1522915239
},
@@ -96265,7 +96275,17 @@
9626596275
"description": "Whether the property is required."
9626696276
},
9626796277
"default_value": {
96268-
"type": "string",
96278+
"oneOf": [
96279+
{
96280+
"type": "string"
96281+
},
96282+
{
96283+
"type": "array",
96284+
"items": {
96285+
"type": "string"
96286+
}
96287+
}
96288+
],
9626996289
"nullable": true,
9627096290
"description": "Default value of the property"
9627196291
},
@@ -98292,7 +98312,7 @@
9829298312
"properties": {
9829398313
"alerts_threshold": {
9829498314
"type": "string",
98295-
"description": "The threshold at which code scanning results that introduce alerts block a ref update.",
98315+
"description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
9829698316
"enum": [
9829798317
"none",
9829898318
"errors",
@@ -98302,7 +98322,7 @@
9830298322
},
9830398323
"security_alerts_threshold": {
9830498324
"type": "string",
98305-
"description": "The threshold at which code scanning results that introduce security alerts block a ref update.",
98325+
"description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
9830698326
"enum": [
9830798327
"none",
9830898328
"critical",

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

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11052,7 +11052,11 @@ paths:
1105211052
type: boolean
1105311053
description: Whether the property is required.
1105411054
default_value:
11055-
type: string
11055+
oneOf:
11056+
- type: string
11057+
- type: array
11058+
items:
11059+
type: string
1105611060
nullable: true
1105711061
description: Default value of the property
1105811062
description:
@@ -70076,7 +70080,11 @@ components:
7007670080
type: boolean
7007770081
description: Whether the property is required.
7007870082
default_value:
70079-
type: string
70083+
oneOf:
70084+
- type: string
70085+
- type: array
70086+
items:
70087+
type: string
7008070088
nullable: true
7008170089
description: Default value of the property
7008270090
description:
@@ -71685,17 +71693,19 @@ components:
7168571693
properties:
7168671694
alerts_threshold:
7168771695
type: string
71688-
description: The threshold at which code scanning results that introduce
71689-
alerts block a ref update.
71696+
description: The severity level at which code scanning results that raise
71697+
alerts block a reference update. For more information on alert severity
71698+
levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
7169071699
enum:
7169171700
- none
7169271701
- errors
7169371702
- errors_and_warnings
7169471703
- all
7169571704
security_alerts_threshold:
7169671705
type: string
71697-
description: The threshold at which code scanning results that introduce
71698-
security alerts block a ref update.
71706+
description: The severity level at which code scanning results that raise
71707+
security alerts block a reference update. For more information on security
71708+
severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
7169971709
enum:
7170071710
- none
7170171711
- critical

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

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15223,7 +15223,17 @@
1522315223
"description": "Whether the property is required."
1522415224
},
1522515225
"default_value": {
15226-
"type": "string",
15226+
"oneOf": [
15227+
{
15228+
"type": "string"
15229+
},
15230+
{
15231+
"type": "array",
15232+
"items": {
15233+
"type": "string"
15234+
}
15235+
}
15236+
],
1522715237
"nullable": true,
1522815238
"description": "Default value of the property"
1522915239
},
@@ -96265,7 +96275,17 @@
9626596275
"description": "Whether the property is required."
9626696276
},
9626796277
"default_value": {
96268-
"type": "string",
96278+
"oneOf": [
96279+
{
96280+
"type": "string"
96281+
},
96282+
{
96283+
"type": "array",
96284+
"items": {
96285+
"type": "string"
96286+
}
96287+
}
96288+
],
9626996289
"nullable": true,
9627096290
"description": "Default value of the property"
9627196291
},
@@ -98292,7 +98312,7 @@
9829298312
"properties": {
9829398313
"alerts_threshold": {
9829498314
"type": "string",
98295-
"description": "The threshold at which code scanning results that introduce alerts block a ref update.",
98315+
"description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
9829698316
"enum": [
9829798317
"none",
9829898318
"errors",
@@ -98302,7 +98322,7 @@
9830298322
},
9830398323
"security_alerts_threshold": {
9830498324
"type": "string",
98305-
"description": "The threshold at which code scanning results that introduce security alerts block a ref update.",
98325+
"description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
9830698326
"enum": [
9830798327
"none",
9830898328
"critical",

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

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11052,7 +11052,11 @@ paths:
1105211052
type: boolean
1105311053
description: Whether the property is required.
1105411054
default_value:
11055-
type: string
11055+
oneOf:
11056+
- type: string
11057+
- type: array
11058+
items:
11059+
type: string
1105611060
nullable: true
1105711061
description: Default value of the property
1105811062
description:
@@ -70076,7 +70080,11 @@ components:
7007670080
type: boolean
7007770081
description: Whether the property is required.
7007870082
default_value:
70079-
type: string
70083+
oneOf:
70084+
- type: string
70085+
- type: array
70086+
items:
70087+
type: string
7008070088
nullable: true
7008170089
description: Default value of the property
7008270090
description:
@@ -71685,17 +71693,19 @@ components:
7168571693
properties:
7168671694
alerts_threshold:
7168771695
type: string
71688-
description: The threshold at which code scanning results that introduce
71689-
alerts block a ref update.
71696+
description: The severity level at which code scanning results that raise
71697+
alerts block a reference update. For more information on alert severity
71698+
levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
7169071699
enum:
7169171700
- none
7169271701
- errors
7169371702
- errors_and_warnings
7169471703
- all
7169571704
security_alerts_threshold:
7169671705
type: string
71697-
description: The threshold at which code scanning results that introduce
71698-
security alerts block a ref update.
71706+
description: The severity level at which code scanning results that raise
71707+
security alerts block a reference update. For more information on security
71708+
severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
7169971709
enum:
7170071710
- none
7170171711
- critical

0 commit comments

Comments
 (0)