Skip to content

Commit cf05067

Browse files
authored
fix: description updates, new parameter for enterprise-admin/license-upload, default_value field can now also be string[] on custom_property (#411)
WIP
1 parent 4b9cfb3 commit cf05067

File tree

18 files changed

+99
-38
lines changed

18 files changed

+99
-38
lines changed

cache/api.github.com.json

+25-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "16.0.0",
4+
"version": "16.1.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -16177,7 +16177,17 @@
1617716177
"description": "Whether the property is required."
1617816178
},
1617916179
"default_value": {
16180-
"type": "string",
16180+
"oneOf": [
16181+
{
16182+
"type": "string"
16183+
},
16184+
{
16185+
"type": "array",
16186+
"items": {
16187+
"type": "string"
16188+
}
16189+
}
16190+
],
1618116191
"nullable": true,
1618216192
"description": "Default value of the property"
1618316193
},
@@ -98011,7 +98021,17 @@
9801198021
"description": "Whether the property is required."
9801298022
},
9801398023
"default_value": {
98014-
"type": "string",
98024+
"oneOf": [
98025+
{
98026+
"type": "string"
98027+
},
98028+
{
98029+
"type": "array",
98030+
"items": {
98031+
"type": "string"
98032+
}
98033+
}
98034+
],
9801598035
"nullable": true,
9801698036
"description": "Default value of the property"
9801798037
},
@@ -100038,7 +100058,7 @@
100038100058
"properties": {
100039100059
"alerts_threshold": {
100040100060
"type": "string",
100041-
"description": "The threshold at which code scanning results that introduce alerts block a ref update.",
100061+
"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).\"",
100042100062
"enum": [
100043100063
"none",
100044100064
"errors",
@@ -100048,7 +100068,7 @@
100048100068
},
100049100069
"security_alerts_threshold": {
100050100070
"type": "string",
100051-
"description": "The threshold at which code scanning results that introduce security alerts block a ref update.",
100071+
"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).\"",
100052100072
"enum": [
100053100073
"none",
100054100074
"critical",

cache/ghec.json

+25-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "16.0.0",
4+
"version": "16.1.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -20814,7 +20814,17 @@
2081420814
"description": "Whether the property is required."
2081520815
},
2081620816
"default_value": {
20817-
"type": "string",
20817+
"oneOf": [
20818+
{
20819+
"type": "string"
20820+
},
20821+
{
20822+
"type": "array",
20823+
"items": {
20824+
"type": "string"
20825+
}
20826+
}
20827+
],
2081820828
"nullable": true,
2081920829
"description": "Default value of the property"
2082020830
},
@@ -106553,7 +106563,17 @@
106553106563
"description": "Whether the property is required."
106554106564
},
106555106565
"default_value": {
106556-
"type": "string",
106566+
"oneOf": [
106567+
{
106568+
"type": "string"
106569+
},
106570+
{
106571+
"type": "array",
106572+
"items": {
106573+
"type": "string"
106574+
}
106575+
}
106576+
],
106557106577
"nullable": true,
106558106578
"description": "Default value of the property"
106559106579
},
@@ -108580,7 +108600,7 @@
108580108600
"properties": {
108581108601
"alerts_threshold": {
108582108602
"type": "string",
108583-
"description": "The threshold at which code scanning results that introduce alerts block a ref update.",
108603+
"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/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
108584108604
"enum": [
108585108605
"none",
108586108606
"errors",
@@ -108590,7 +108610,7 @@
108590108610
},
108591108611
"security_alerts_threshold": {
108592108612
"type": "string",
108593-
"description": "The threshold at which code scanning results that introduce security alerts block a ref update.",
108613+
"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/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
108594108614
"enum": [
108595108615
"none",
108596108616
"critical",

cache/ghes-3.10.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "16.0.0",
4+
"version": "16.1.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {

cache/ghes-3.11.json

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "16.0.0",
4+
"version": "16.1.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -102168,7 +102168,7 @@
102168102168
"properties": {
102169102169
"alerts_threshold": {
102170102170
"type": "string",
102171-
"description": "The threshold at which code scanning results that introduce alerts block a ref update.",
102171+
"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/[email protected]/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
102172102172
"enum": [
102173102173
"none",
102174102174
"errors",
@@ -102178,7 +102178,7 @@
102178102178
},
102179102179
"security_alerts_threshold": {
102180102180
"type": "string",
102181-
"description": "The threshold at which code scanning results that introduce security alerts block a ref update.",
102181+
"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/[email protected]/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
102182102182
"enum": [
102183102183
"none",
102184102184
"critical",

cache/ghes-3.12.json

+17-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "16.0.0",
4+
"version": "16.1.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {
@@ -10946,6 +10946,11 @@
1094610946
}
1094710947
}
1094810948
],
10949+
"parameters": [
10950+
{
10951+
"$ref": "#/components/parameters/license-apply"
10952+
}
10953+
],
1094910954
"requestBody": {
1095010955
"required": true,
1095110956
"content": {
@@ -104099,7 +104104,7 @@
104099104104
"properties": {
104100104105
"alerts_threshold": {
104101104106
"type": "string",
104102-
"description": "The threshold at which code scanning results that introduce alerts block a ref update.",
104107+
"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/[email protected]/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
104103104108
"enum": [
104104104109
"none",
104105104110
"errors",
@@ -104109,7 +104114,7 @@
104109104114
},
104110104115
"security_alerts_threshold": {
104111104116
"type": "string",
104112-
"description": "The threshold at which code scanning results that introduce security alerts block a ref update.",
104117+
"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/[email protected]/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
104113104118
"enum": [
104114104119
"none",
104115104120
"critical",
@@ -301849,6 +301854,15 @@
301849301854
"type": "string"
301850301855
}
301851301856
},
301857+
"license-apply": {
301858+
"name": "apply",
301859+
"description": "Whether to apply changes from the license. Uploading a license does not automatically apply changes. To make the changes effective, you can specify to apply the license too.",
301860+
"in": "query",
301861+
"required": false,
301862+
"schema": {
301863+
"type": "boolean"
301864+
}
301865+
},
301852301866
"uuid": {
301853301867
"name": "uuid",
301854301868
"description": "The UUID which identifies a node.",

cache/ghes-3.9.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "16.0.0",
4+
"version": "16.1.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {

cache/github.ae.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "16.0.0",
4+
"version": "16.1.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": {

packages/openapi-types-ghec/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@
1616
"author": "Gregor Martynus (https://twitter.com/gr2m)",
1717
"license": "MIT",
1818
"octokit": {
19-
"openapi-version": "16.0.0"
19+
"openapi-version": "16.1.0"
2020
}
2121
}

packages/openapi-types-ghec/types.d.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -16615,7 +16615,7 @@ export interface components {
1661516615
/** @description Whether the property is required. */
1661616616
required?: boolean;
1661716617
/** @description Default value of the property */
16618-
default_value?: string | null;
16618+
default_value?: string | string[] | null;
1661916619
/** @description Short description of the property */
1662016620
description?: string | null;
1662116621
/**
@@ -17691,12 +17691,12 @@ export interface components {
1769117691
*/
1769217692
"repository-rule-params-code-scanning-tool": {
1769317693
/**
17694-
* @description The threshold at which code scanning results that introduce alerts block a ref update.
17694+
* @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/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
1769517695
* @enum {string}
1769617696
*/
1769717697
alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all";
1769817698
/**
17699-
* @description The threshold at which code scanning results that introduce security alerts block a ref update.
17699+
* @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/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
1770017700
* @enum {string}
1770117701
*/
1770217702
security_alerts_threshold:
@@ -100565,7 +100565,7 @@ export interface operations {
100565100565
/** @description Whether the property is required. */
100566100566
required?: boolean;
100567100567
/** @description Default value of the property */
100568-
default_value?: string | null;
100568+
default_value?: string | string[] | null;
100569100569
/** @description Short description of the property */
100570100570
description?: string | null;
100571100571
/**

packages/openapi-types-ghes-3.10/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@
1616
"author": "Gregor Martynus (https://twitter.com/gr2m)",
1717
"license": "MIT",
1818
"octokit": {
19-
"openapi-version": "16.0.0"
19+
"openapi-version": "16.1.0"
2020
}
2121
}

packages/openapi-types-ghes-3.11/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@
1616
"author": "Gregor Martynus (https://twitter.com/gr2m)",
1717
"license": "MIT",
1818
"octokit": {
19-
"openapi-version": "16.0.0"
19+
"openapi-version": "16.1.0"
2020
}
2121
}

packages/openapi-types-ghes-3.11/types.d.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -15313,12 +15313,12 @@ export interface components {
1531315313
*/
1531415314
"repository-rule-params-code-scanning-tool": {
1531515315
/**
15316-
* @description The threshold at which code scanning results that introduce alerts block a ref update.
15316+
* @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/[email protected]/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
1531715317
* @enum {string}
1531815318
*/
1531915319
alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all";
1532015320
/**
15321-
* @description The threshold at which code scanning results that introduce security alerts block a ref update.
15321+
* @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/[email protected]/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
1532215322
* @enum {string}
1532315323
*/
1532415324
security_alerts_threshold:

packages/openapi-types-ghes-3.12/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@
1616
"author": "Gregor Martynus (https://twitter.com/gr2m)",
1717
"license": "MIT",
1818
"octokit": {
19-
"openapi-version": "16.0.0"
19+
"openapi-version": "16.1.0"
2020
}
2121
}

packages/openapi-types-ghes-3.12/types.d.ts

+9-2
Original file line numberDiff line numberDiff line change
@@ -15731,12 +15731,12 @@ export interface components {
1573115731
*/
1573215732
"repository-rule-params-code-scanning-tool": {
1573315733
/**
15734-
* @description The threshold at which code scanning results that introduce alerts block a ref update.
15734+
* @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/[email protected]/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
1573515735
* @enum {string}
1573615736
*/
1573715737
alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all";
1573815738
/**
15739-
* @description The threshold at which code scanning results that introduce security alerts block a ref update.
15739+
* @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/[email protected]/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
1574015740
* @enum {string}
1574115741
*/
1574215742
security_alerts_threshold:
@@ -84295,6 +84295,8 @@ export interface components {
8429584295
"comment-id": number;
8429684296
/** @description A list of comma separated label names. Example: `bug,ui,@high` */
8429784297
labels?: string;
84298+
/** @description Whether to apply changes from the license. Uploading a license does not automatically apply changes. To make the changes effective, you can specify to apply the license too. */
84299+
"license-apply"?: boolean;
8429884300
/** @description The UUID which identifies a node. */
8429984301
uuid?: string;
8430084302
/** @description The cluster roles from the cluster configuration file. */
@@ -89314,6 +89316,11 @@ export interface operations {
8931489316
* @description Uploads an enterprise license. This operation does not automatically activate the license.
8931589317
*/
8931689318
"enterprise-admin/license-upload": {
89319+
parameters: {
89320+
query?: {
89321+
apply?: components["parameters"]["license-apply"];
89322+
};
89323+
};
8931789324
requestBody: {
8931889325
content: {
8931989326
"application/octet-stream": string;

packages/openapi-types-ghes-3.9/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@
1616
"author": "Gregor Martynus (https://twitter.com/gr2m)",
1717
"license": "MIT",
1818
"octokit": {
19-
"openapi-version": "16.0.0"
19+
"openapi-version": "16.1.0"
2020
}
2121
}

packages/openapi-types-github.ae/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@
1616
"author": "Gregor Martynus (https://twitter.com/gr2m)",
1717
"license": "MIT",
1818
"octokit": {
19-
"openapi-version": "16.0.0"
19+
"openapi-version": "16.1.0"
2020
}
2121
}

packages/openapi-types/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@
1616
"author": "Gregor Martynus (https://twitter.com/gr2m)",
1717
"license": "MIT",
1818
"octokit": {
19-
"openapi-version": "16.0.0"
19+
"openapi-version": "16.1.0"
2020
}
2121
}

0 commit comments

Comments
 (0)