Skip to content

Commit

Permalink
fix: description updates, new parameter for `enterprise-admin/license…
Browse files Browse the repository at this point in the history
…-upload`, `default_value` field can now also be `string[]` on custom_property (#411)

WIP
  • Loading branch information
octokitbot committed Apr 9, 2024
1 parent 4b9cfb3 commit cf05067
Show file tree
Hide file tree
Showing 18 changed files with 99 additions and 38 deletions.
30 changes: 25 additions & 5 deletions cache/api.github.com.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "16.0.0",
"version": "16.1.0",
"title": "GitHub's official OpenAPI spec + Octokit extension",
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
"license": {
Expand Down Expand Up @@ -16177,7 +16177,17 @@
"description": "Whether the property is required."
},
"default_value": {
"type": "string",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"nullable": true,
"description": "Default value of the property"
},
Expand Down Expand Up @@ -98011,7 +98021,17 @@
"description": "Whether the property is required."
},
"default_value": {
"type": "string",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"nullable": true,
"description": "Default value of the property"
},
Expand Down Expand Up @@ -100038,7 +100058,7 @@
"properties": {
"alerts_threshold": {
"type": "string",
"description": "The threshold at which code scanning results that introduce alerts block a ref update.",
"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).\"",
"enum": [
"none",
"errors",
Expand All @@ -100048,7 +100068,7 @@
},
"security_alerts_threshold": {
"type": "string",
"description": "The threshold at which code scanning results that introduce security alerts block a ref update.",
"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).\"",
"enum": [
"none",
"critical",
Expand Down
30 changes: 25 additions & 5 deletions cache/ghec.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "16.0.0",
"version": "16.1.0",
"title": "GitHub's official OpenAPI spec + Octokit extension",
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
"license": {
Expand Down Expand Up @@ -20814,7 +20814,17 @@
"description": "Whether the property is required."
},
"default_value": {
"type": "string",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"nullable": true,
"description": "Default value of the property"
},
Expand Down Expand Up @@ -106553,7 +106563,17 @@
"description": "Whether the property is required."
},
"default_value": {
"type": "string",
"oneOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
],
"nullable": true,
"description": "Default value of the property"
},
Expand Down Expand Up @@ -108580,7 +108600,7 @@
"properties": {
"alerts_threshold": {
"type": "string",
"description": "The threshold at which code scanning results that introduce alerts block a ref update.",
"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).\"",
"enum": [
"none",
"errors",
Expand All @@ -108590,7 +108610,7 @@
},
"security_alerts_threshold": {
"type": "string",
"description": "The threshold at which code scanning results that introduce security alerts block a ref update.",
"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).\"",
"enum": [
"none",
"critical",
Expand Down
2 changes: 1 addition & 1 deletion cache/ghes-3.10.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "16.0.0",
"version": "16.1.0",
"title": "GitHub's official OpenAPI spec + Octokit extension",
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
"license": {
Expand Down
6 changes: 3 additions & 3 deletions cache/ghes-3.11.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "16.0.0",
"version": "16.1.0",
"title": "GitHub's official OpenAPI spec + Octokit extension",
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
"license": {
Expand Down Expand Up @@ -102168,7 +102168,7 @@
"properties": {
"alerts_threshold": {
"type": "string",
"description": "The threshold at which code scanning results that introduce alerts block a ref update.",
"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-server@3.11/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
"enum": [
"none",
"errors",
Expand All @@ -102178,7 +102178,7 @@
},
"security_alerts_threshold": {
"type": "string",
"description": "The threshold at which code scanning results that introduce security alerts block a ref update.",
"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-server@3.11/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
"enum": [
"none",
"critical",
Expand Down
20 changes: 17 additions & 3 deletions cache/ghes-3.12.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "16.0.0",
"version": "16.1.0",
"title": "GitHub's official OpenAPI spec + Octokit extension",
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
"license": {
Expand Down Expand Up @@ -10946,6 +10946,11 @@
}
}
],
"parameters": [
{
"$ref": "#/components/parameters/license-apply"
}
],
"requestBody": {
"required": true,
"content": {
Expand Down Expand Up @@ -104099,7 +104104,7 @@
"properties": {
"alerts_threshold": {
"type": "string",
"description": "The threshold at which code scanning results that introduce alerts block a ref update.",
"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-server@3.12/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
"enum": [
"none",
"errors",
Expand All @@ -104109,7 +104114,7 @@
},
"security_alerts_threshold": {
"type": "string",
"description": "The threshold at which code scanning results that introduce security alerts block a ref update.",
"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-server@3.12/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"",
"enum": [
"none",
"critical",
Expand Down Expand Up @@ -301849,6 +301854,15 @@
"type": "string"
}
},
"license-apply": {
"name": "apply",
"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.",
"in": "query",
"required": false,
"schema": {
"type": "boolean"
}
},
"uuid": {
"name": "uuid",
"description": "The UUID which identifies a node.",
Expand Down
2 changes: 1 addition & 1 deletion cache/ghes-3.9.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "16.0.0",
"version": "16.1.0",
"title": "GitHub's official OpenAPI spec + Octokit extension",
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
"license": {
Expand Down
2 changes: 1 addition & 1 deletion cache/github.ae.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"openapi": "3.0.3",
"info": {
"version": "16.0.0",
"version": "16.1.0",
"title": "GitHub's official OpenAPI spec + Octokit extension",
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
"license": {
Expand Down
2 changes: 1 addition & 1 deletion packages/openapi-types-ghec/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@
"author": "Gregor Martynus (https://twitter.com/gr2m)",
"license": "MIT",
"octokit": {
"openapi-version": "16.0.0"
"openapi-version": "16.1.0"
}
}
8 changes: 4 additions & 4 deletions packages/openapi-types-ghec/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16615,7 +16615,7 @@ export interface components {
/** @description Whether the property is required. */
required?: boolean;
/** @description Default value of the property */
default_value?: string | null;
default_value?: string | string[] | null;
/** @description Short description of the property */
description?: string | null;
/**
Expand Down Expand Up @@ -17691,12 +17691,12 @@ export interface components {
*/
"repository-rule-params-code-scanning-tool": {
/**
* @description The threshold at which code scanning results that introduce alerts block a ref update.
* @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)."
* @enum {string}
*/
alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all";
/**
* @description The threshold at which code scanning results that introduce security alerts block a ref update.
* @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)."
* @enum {string}
*/
security_alerts_threshold:
Expand Down Expand Up @@ -100565,7 +100565,7 @@ export interface operations {
/** @description Whether the property is required. */
required?: boolean;
/** @description Default value of the property */
default_value?: string | null;
default_value?: string | string[] | null;
/** @description Short description of the property */
description?: string | null;
/**
Expand Down
2 changes: 1 addition & 1 deletion packages/openapi-types-ghes-3.10/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@
"author": "Gregor Martynus (https://twitter.com/gr2m)",
"license": "MIT",
"octokit": {
"openapi-version": "16.0.0"
"openapi-version": "16.1.0"
}
}
2 changes: 1 addition & 1 deletion packages/openapi-types-ghes-3.11/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@
"author": "Gregor Martynus (https://twitter.com/gr2m)",
"license": "MIT",
"octokit": {
"openapi-version": "16.0.0"
"openapi-version": "16.1.0"
}
}
4 changes: 2 additions & 2 deletions packages/openapi-types-ghes-3.11/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15313,12 +15313,12 @@ export interface components {
*/
"repository-rule-params-code-scanning-tool": {
/**
* @description The threshold at which code scanning results that introduce alerts block a ref update.
* @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-server@3.11/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
* @enum {string}
*/
alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all";
/**
* @description The threshold at which code scanning results that introduce security alerts block a ref update.
* @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-server@3.11/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
* @enum {string}
*/
security_alerts_threshold:
Expand Down
2 changes: 1 addition & 1 deletion packages/openapi-types-ghes-3.12/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@
"author": "Gregor Martynus (https://twitter.com/gr2m)",
"license": "MIT",
"octokit": {
"openapi-version": "16.0.0"
"openapi-version": "16.1.0"
}
}
11 changes: 9 additions & 2 deletions packages/openapi-types-ghes-3.12/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15731,12 +15731,12 @@ export interface components {
*/
"repository-rule-params-code-scanning-tool": {
/**
* @description The threshold at which code scanning results that introduce alerts block a ref update.
* @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-server@3.12/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
* @enum {string}
*/
alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all";
/**
* @description The threshold at which code scanning results that introduce security alerts block a ref update.
* @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-server@3.12/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)."
* @enum {string}
*/
security_alerts_threshold:
Expand Down Expand Up @@ -84295,6 +84295,8 @@ export interface components {
"comment-id": number;
/** @description A list of comma separated label names. Example: `bug,ui,@high` */
labels?: string;
/** @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. */
"license-apply"?: boolean;
/** @description The UUID which identifies a node. */
uuid?: string;
/** @description The cluster roles from the cluster configuration file. */
Expand Down Expand Up @@ -89314,6 +89316,11 @@ export interface operations {
* @description Uploads an enterprise license. This operation does not automatically activate the license.
*/
"enterprise-admin/license-upload": {
parameters: {
query?: {
apply?: components["parameters"]["license-apply"];
};
};
requestBody: {
content: {
"application/octet-stream": string;
Expand Down
2 changes: 1 addition & 1 deletion packages/openapi-types-ghes-3.9/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@
"author": "Gregor Martynus (https://twitter.com/gr2m)",
"license": "MIT",
"octokit": {
"openapi-version": "16.0.0"
"openapi-version": "16.1.0"
}
}
2 changes: 1 addition & 1 deletion packages/openapi-types-github.ae/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@
"author": "Gregor Martynus (https://twitter.com/gr2m)",
"license": "MIT",
"octokit": {
"openapi-version": "16.0.0"
"openapi-version": "16.1.0"
}
}
2 changes: 1 addition & 1 deletion packages/openapi-types/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@
"author": "Gregor Martynus (https://twitter.com/gr2m)",
"license": "MIT",
"octokit": {
"openapi-version": "16.0.0"
"openapi-version": "16.1.0"
}
}
Loading

0 comments on commit cf05067

Please sign in to comment.