diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json index eb009edac1..c9864f5698 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat-permissions.json @@ -4364,6 +4364,21 @@ } ] }, + "repository_custom_properties": { + "title": "Custom properties", + "displayTitle": "Repository permissions for \"Custom properties\"", + "permissions": [ + { + "category": "repos", + "slug": "create-or-update-custom-property-values-for-a-repository", + "subcategory": "custom-properties", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/properties/values", + "additional-permissions": [], + "access": "write" + } + ] + }, "vulnerability_alerts": { "title": "Dependabot alerts", "displayTitle": "Repository permissions for \"Dependabot alerts\"", diff --git a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json index b2da2986bf..30efa28b96 100644 --- a/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/fpt-2022-11-28/fine-grained-pat.json @@ -4170,6 +4170,12 @@ "verb": "get", "requestPath": "/repos/{owner}/{repo}/properties/values" }, + { + "slug": "create-or-update-custom-property-values-for-a-repository", + "subcategory": "custom-properties", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/properties/values" + }, { "slug": "get-rules-for-a-branch", "subcategory": "rules", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json index 334b5589ad..b32dc34483 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-permissions.json @@ -5393,6 +5393,23 @@ } ] }, + "repository_custom_properties": { + "title": "Custom properties", + "displayTitle": "Repository permissions for \"Custom properties\"", + "permissions": [ + { + "category": "repos", + "slug": "create-or-update-custom-property-values-for-a-repository", + "subcategory": "custom-properties", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/properties/values", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + } + ] + }, "vulnerability_alerts": { "title": "Dependabot alerts", "displayTitle": "Repository permissions for \"Dependabot alerts\"", diff --git a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json index 80026c0239..46a516030c 100644 --- a/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/server-to-server-rest.json @@ -3774,6 +3774,12 @@ "verb": "get", "requestPath": "/repos/{owner}/{repo}/properties/values" }, + { + "slug": "create-or-update-custom-property-values-for-a-repository", + "subcategory": "custom-properties", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/properties/values" + }, { "slug": "get-rules-for-a-branch", "subcategory": "rules", diff --git a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json index f1c8f92abc..db3e9d83bc 100644 --- a/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/fpt-2022-11-28/user-to-server-rest.json @@ -4242,6 +4242,12 @@ "verb": "get", "requestPath": "/repos/{owner}/{repo}/properties/values" }, + { + "slug": "create-or-update-custom-property-values-for-a-repository", + "subcategory": "custom-properties", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/properties/values" + }, { "slug": "get-rules-for-a-branch", "subcategory": "rules", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json index a8031abd4d..dd45adf9ac 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat-permissions.json @@ -5034,6 +5034,21 @@ } ] }, + "repository_custom_properties": { + "title": "Custom properties", + "displayTitle": "Repository permissions for \"Custom properties\"", + "permissions": [ + { + "category": "repos", + "slug": "create-or-update-custom-property-values-for-a-repository", + "subcategory": "custom-properties", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/properties/values", + "additional-permissions": [], + "access": "write" + } + ] + }, "vulnerability_alerts": { "title": "Dependabot alerts", "displayTitle": "Repository permissions for \"Dependabot alerts\"", diff --git a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json index 1aae8ade58..c20cf9ca98 100644 --- a/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json +++ b/src/github-apps/data/ghec-2022-11-28/fine-grained-pat.json @@ -4498,6 +4498,12 @@ "verb": "get", "requestPath": "/repos/{owner}/{repo}/properties/values" }, + { + "slug": "create-or-update-custom-property-values-for-a-repository", + "subcategory": "custom-properties", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/properties/values" + }, { "slug": "get-rules-for-a-branch", "subcategory": "rules", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json index 166eea374d..fcdf90187c 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-permissions.json @@ -6207,6 +6207,23 @@ } ] }, + "repository_custom_properties": { + "title": "Custom properties", + "displayTitle": "Repository permissions for \"Custom properties\"", + "permissions": [ + { + "category": "repos", + "slug": "create-or-update-custom-property-values-for-a-repository", + "subcategory": "custom-properties", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/properties/values", + "access": "write", + "user-to-server": true, + "server-to-server": true, + "additional-permissions": [] + } + ] + }, "vulnerability_alerts": { "title": "Dependabot alerts", "displayTitle": "Repository permissions for \"Dependabot alerts\"", diff --git a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json index ac4be3495c..f19b9cae9b 100644 --- a/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/server-to-server-rest.json @@ -4102,6 +4102,12 @@ "verb": "get", "requestPath": "/repos/{owner}/{repo}/properties/values" }, + { + "slug": "create-or-update-custom-property-values-for-a-repository", + "subcategory": "custom-properties", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/properties/values" + }, { "slug": "get-rules-for-a-branch", "subcategory": "rules", diff --git a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json index a587de1322..a1d3378531 100644 --- a/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json +++ b/src/github-apps/data/ghec-2022-11-28/user-to-server-rest.json @@ -4570,6 +4570,12 @@ "verb": "get", "requestPath": "/repos/{owner}/{repo}/properties/values" }, + { + "slug": "create-or-update-custom-property-values-for-a-repository", + "subcategory": "custom-properties", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/properties/values" + }, { "slug": "get-rules-for-a-branch", "subcategory": "rules", diff --git a/src/github-apps/lib/config.json b/src/github-apps/lib/config.json index d8e59e9ecc..35af5313cb 100644 --- a/src/github-apps/lib/config.json +++ b/src/github-apps/lib/config.json @@ -60,5 +60,5 @@ "2022-11-28" ] }, - "sha": "7ab8592e0e02e3a1f4b89b14078e3ae793b17068" + "sha": "e44bcaa6f0d15e9c8c558b5023595ef39ad0f15a" } \ No newline at end of file diff --git a/src/rest/data/fpt-2022-11-28/schema.json b/src/rest/data/fpt-2022-11-28/schema.json index e60e9ec662..6313af1e13 100644 --- a/src/rest/data/fpt-2022-11-28/schema.json +++ b/src/rest/data/fpt-2022-11-28/schema.json @@ -181605,6 +181605,11 @@ } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -355363,6 +355368,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -355424,6 +355432,21 @@ "type": "string" }, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] } }, "required": [ @@ -355513,6 +355536,16 @@ "type": "array of strings or null", "name": "allowed_values", "description": "

Ordered list of allowed values of the property

" + }, + { + "type": "string or null", + "name": "values_editable_by", + "description": "

Who can edit the values of the property

", + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ] } ] } @@ -355536,6 +355569,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -355567,6 +355603,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -355628,6 +355667,21 @@ "type": "string" }, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] } }, "required": [ @@ -355758,6 +355812,21 @@ "type": "string" }, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] } }, "required": [ @@ -355934,6 +356003,21 @@ "type": "string" }, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] } }, "required": [ @@ -458381,6 +458465,11 @@ } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -464570,6 +464659,11 @@ } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -470992,6 +471086,11 @@ } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -480499,6 +480598,11 @@ } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -489515,6 +489619,11 @@ } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -495009,6 +495118,108 @@ "description": "

Resource not found

" } ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/properties/values", + "title": "Create or update custom property values for a repository", + "category": "repos", + "subcategory": "custom-properties", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of objects", + "name": "properties", + "in": "body", + "description": "

A list of custom property names and associated values to apply to the repositories.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "

The name of the property

", + "isRequired": true + }, + { + "type": "string or null", + "name": "value", + "description": "

The value assigned to the property

", + "isRequired": true + } + ] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "204", + "description": "

No Content when custom property values are successfully created or updated

" + } + } + ], + "previews": [], + "descriptionHTML": "

Create new or update existing custom property values for a repository.\nUsing a value of null for a custom property will remove or 'unset' the property value from the repository.

\n

Repository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.

\n

GitHub Apps must have the repository_custom_properties:write permission to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content when custom property values are successfully created or updated

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] } ], "forks": [ @@ -502136,6 +502347,11 @@ } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -509534,32 +509750,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -509568,6 +509762,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -509581,32 +509789,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -509773,16 +509955,6 @@ "type": "string or number", "name": "insecure_ssl", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - }, - { - "type": "string", - "name": "token", - "description": "" - }, - { - "type": "string", - "name": "digest", - "description": "" } ] }, @@ -509900,32 +510072,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -509934,6 +510084,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -509947,32 +510111,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -510208,32 +510346,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -510242,6 +510358,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -510255,32 +510385,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -510428,13 +510532,12 @@ "type": "object", "name": "config", "in": "body", - "description": "

Key/value pairs to provide settings for this webhook.

", + "description": "

Configuration object of the webhook

", "childParamsGroups": [ { "type": "string", "name": "url", - "description": "

The URL to which the payloads will be delivered.

", - "isRequired": true + "description": "

The URL to which the payloads will be delivered.

" }, { "type": "string", @@ -510450,16 +510553,6 @@ "type": "string or number", "name": "insecure_ssl", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - }, - { - "type": "string", - "name": "address", - "description": "" - }, - { - "type": "string", - "name": "room", - "description": "" } ] }, @@ -510583,32 +510676,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -510617,6 +510688,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -510630,32 +510715,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -548071,6 +548130,11 @@ } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ diff --git a/src/rest/data/ghae/schema.json b/src/rest/data/ghae/schema.json index 4d5150edc6..77f6243da6 100644 --- a/src/rest/data/ghae/schema.json +++ b/src/rest/data/ghae/schema.json @@ -374799,32 +374799,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -374833,6 +374811,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -374846,32 +374838,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -375038,16 +375004,6 @@ "type": "string or number", "name": "insecure_ssl", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - }, - { - "type": "string", - "name": "token", - "description": "" - }, - { - "type": "string", - "name": "digest", - "description": "" } ] }, @@ -375165,32 +375121,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -375199,6 +375133,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -375212,32 +375160,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -375473,32 +375395,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -375507,6 +375407,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -375520,32 +375434,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -375693,13 +375581,12 @@ "type": "object", "name": "config", "in": "body", - "description": "

Key/value pairs to provide settings for this webhook.

", + "description": "

Configuration object of the webhook

", "childParamsGroups": [ { "type": "string", "name": "url", - "description": "

The URL to which the payloads will be delivered.

", - "isRequired": true + "description": "

The URL to which the payloads will be delivered.

" }, { "type": "string", @@ -375715,16 +375602,6 @@ "type": "string or number", "name": "insecure_ssl", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - }, - { - "type": "string", - "name": "address", - "description": "" - }, - { - "type": "string", - "name": "room", - "description": "" } ] }, @@ -375848,32 +375725,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -375882,6 +375737,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -375895,32 +375764,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 467d31dffb..421da9073e 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -193712,6 +193712,11 @@ } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -375407,6 +375412,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -375468,6 +375476,21 @@ "type": "string" }, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] } }, "required": [ @@ -375557,6 +375580,16 @@ "type": "array of strings or null", "name": "allowed_values", "description": "

Ordered list of allowed values of the property

" + }, + { + "type": "string or null", + "name": "values_editable_by", + "description": "

Who can edit the values of the property

", + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ] } ] } @@ -375580,6 +375613,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -375611,6 +375647,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -375672,6 +375711,21 @@ "type": "string" }, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] } }, "required": [ @@ -375802,6 +375856,21 @@ "type": "string" }, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] } }, "required": [ @@ -375978,6 +376047,21 @@ "type": "string" }, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] } }, "required": [ @@ -481497,6 +481581,11 @@ } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -487703,6 +487792,11 @@ } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -494150,6 +494244,11 @@ } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -503681,6 +503780,11 @@ } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -512721,6 +512825,11 @@ } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -518230,6 +518339,108 @@ "description": "

Resource not found

" } ] + }, + { + "serverUrl": "https://api.github.com", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/properties/values", + "title": "Create or update custom property values for a repository", + "category": "repos", + "subcategory": "custom-properties", + "parameters": [ + { + "name": "owner", + "description": "

The account owner of the repository. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "description": "

The name of the repository without the .git extension. The name is not case sensitive.

", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "bodyParameters": [ + { + "type": "array of objects", + "name": "properties", + "in": "body", + "description": "

A list of custom property names and associated values to apply to the repositories.

", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "property_name", + "description": "

The name of the property

", + "isRequired": true + }, + { + "type": "string or null", + "name": "value", + "description": "

The value assigned to the property

", + "isRequired": true + } + ] + } + ], + "enabledForGitHubApps": true, + "codeExamples": [ + { + "key": "default", + "request": { + "contentType": "application/json", + "description": "Example", + "acceptHeader": "application/vnd.github.v3+json", + "bodyParameters": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, + "parameters": { + "owner": "OWNER", + "repo": "REPO" + } + }, + "response": { + "statusCode": "204", + "description": "

No Content when custom property values are successfully created or updated

" + } + } + ], + "previews": [], + "descriptionHTML": "

Create new or update existing custom property values for a repository.\nUsing a value of null for a custom property will remove or 'unset' the property value from the repository.

\n

Repository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.

\n

GitHub Apps must have the repository_custom_properties:write permission to use this endpoint.

", + "statusCodes": [ + { + "httpStatusCode": "204", + "description": "

No Content when custom property values are successfully created or updated

" + }, + { + "httpStatusCode": "403", + "description": "

Forbidden

" + }, + { + "httpStatusCode": "404", + "description": "

Resource not found

" + } + ] } ], "forks": [ @@ -525381,6 +525592,11 @@ } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ @@ -532900,32 +533116,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -532934,6 +533128,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -532947,32 +533155,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -533139,16 +533321,6 @@ "type": "string or number", "name": "insecure_ssl", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - }, - { - "type": "string", - "name": "token", - "description": "" - }, - { - "type": "string", - "name": "digest", - "description": "" } ] }, @@ -533266,32 +533438,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -533300,6 +533450,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -533313,32 +533477,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -533574,32 +533712,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -533608,6 +533724,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -533621,32 +533751,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -533794,13 +533898,12 @@ "type": "object", "name": "config", "in": "body", - "description": "

Key/value pairs to provide settings for this webhook.

", + "description": "

Configuration object of the webhook

", "childParamsGroups": [ { "type": "string", "name": "url", - "description": "

The URL to which the payloads will be delivered.

", - "isRequired": true + "description": "

The URL to which the payloads will be delivered.

" }, { "type": "string", @@ -533816,16 +533919,6 @@ "type": "string or number", "name": "insecure_ssl", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - }, - { - "type": "string", - "name": "address", - "description": "" - }, - { - "type": "string", - "name": "room", - "description": "" } ] }, @@ -533949,32 +534042,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -533983,6 +534054,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -533996,32 +534081,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -573959,6 +574018,11 @@ } } } + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } }, "required": [ diff --git a/src/rest/data/ghes-3.10-2022-11-28/schema.json b/src/rest/data/ghes-3.10-2022-11-28/schema.json index 026d7d8b55..496b4f3fa5 100644 --- a/src/rest/data/ghes-3.10-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.10-2022-11-28/schema.json @@ -473502,32 +473502,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -473536,6 +473514,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -473549,32 +473541,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -473741,16 +473707,6 @@ "type": "string or number", "name": "insecure_ssl", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - }, - { - "type": "string", - "name": "token", - "description": "" - }, - { - "type": "string", - "name": "digest", - "description": "" } ] }, @@ -473868,32 +473824,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -473902,6 +473836,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -473915,32 +473863,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -474176,32 +474098,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -474210,6 +474110,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -474223,32 +474137,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -474396,13 +474284,12 @@ "type": "object", "name": "config", "in": "body", - "description": "

Key/value pairs to provide settings for this webhook.

", + "description": "

Configuration object of the webhook

", "childParamsGroups": [ { "type": "string", "name": "url", - "description": "

The URL to which the payloads will be delivered.

", - "isRequired": true + "description": "

The URL to which the payloads will be delivered.

" }, { "type": "string", @@ -474418,16 +474305,6 @@ "type": "string or number", "name": "insecure_ssl", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - }, - { - "type": "string", - "name": "address", - "description": "" - }, - { - "type": "string", - "name": "room", - "description": "" } ] }, @@ -474551,32 +474428,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -474585,6 +474440,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -474598,32 +474467,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, diff --git a/src/rest/data/ghes-3.11-2022-11-28/schema.json b/src/rest/data/ghes-3.11-2022-11-28/schema.json index 753adb4abf..d1db856416 100644 --- a/src/rest/data/ghes-3.11-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.11-2022-11-28/schema.json @@ -485888,32 +485888,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -485922,6 +485900,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -485935,32 +485927,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -486127,16 +486093,6 @@ "type": "string or number", "name": "insecure_ssl", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - }, - { - "type": "string", - "name": "token", - "description": "" - }, - { - "type": "string", - "name": "digest", - "description": "" } ] }, @@ -486254,32 +486210,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -486288,6 +486222,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -486301,32 +486249,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -486562,32 +486484,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -486596,6 +486496,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -486609,32 +486523,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -486782,13 +486670,12 @@ "type": "object", "name": "config", "in": "body", - "description": "

Key/value pairs to provide settings for this webhook.

", + "description": "

Configuration object of the webhook

", "childParamsGroups": [ { "type": "string", "name": "url", - "description": "

The URL to which the payloads will be delivered.

", - "isRequired": true + "description": "

The URL to which the payloads will be delivered.

" }, { "type": "string", @@ -486804,16 +486691,6 @@ "type": "string or number", "name": "insecure_ssl", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - }, - { - "type": "string", - "name": "address", - "description": "" - }, - { - "type": "string", - "name": "room", - "description": "" } ] }, @@ -486937,32 +486814,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -486971,6 +486826,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -486984,32 +486853,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.11/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, diff --git a/src/rest/data/ghes-3.8/schema.json b/src/rest/data/ghes-3.8/schema.json index 929e2fa596..f02a1b1928 100644 --- a/src/rest/data/ghes-3.8/schema.json +++ b/src/rest/data/ghes-3.8/schema.json @@ -448847,32 +448847,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -448881,6 +448859,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.8/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -448894,32 +448886,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.8/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -449086,16 +449052,6 @@ "type": "string or number", "name": "insecure_ssl", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - }, - { - "type": "string", - "name": "token", - "description": "" - }, - { - "type": "string", - "name": "digest", - "description": "" } ] }, @@ -449213,32 +449169,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -449247,6 +449181,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.8/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -449260,32 +449208,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.8/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -449521,32 +449443,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -449555,6 +449455,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.8/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -449568,32 +449482,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.8/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -449741,13 +449629,12 @@ "type": "object", "name": "config", "in": "body", - "description": "

Key/value pairs to provide settings for this webhook.

", + "description": "

Configuration object of the webhook

", "childParamsGroups": [ { "type": "string", "name": "url", - "description": "

The URL to which the payloads will be delivered.

", - "isRequired": true + "description": "

The URL to which the payloads will be delivered.

" }, { "type": "string", @@ -449763,16 +449650,6 @@ "type": "string or number", "name": "insecure_ssl", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - }, - { - "type": "string", - "name": "address", - "description": "" - }, - { - "type": "string", - "name": "room", - "description": "" } ] }, @@ -449896,32 +449773,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -449930,6 +449785,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.8/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -449943,32 +449812,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.8/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, diff --git a/src/rest/data/ghes-3.9-2022-11-28/schema.json b/src/rest/data/ghes-3.9-2022-11-28/schema.json index 912337996b..d34c410139 100644 --- a/src/rest/data/ghes-3.9-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.9-2022-11-28/schema.json @@ -467117,32 +467117,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -467151,6 +467129,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -467164,32 +467156,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -467356,16 +467322,6 @@ "type": "string or number", "name": "insecure_ssl", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - }, - { - "type": "string", - "name": "token", - "description": "" - }, - { - "type": "string", - "name": "digest", - "description": "" } ] }, @@ -467483,32 +467439,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -467517,6 +467451,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -467530,32 +467478,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -467791,32 +467713,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -467825,6 +467725,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -467838,32 +467752,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, @@ -468011,13 +467899,12 @@ "type": "object", "name": "config", "in": "body", - "description": "

Key/value pairs to provide settings for this webhook.

", + "description": "

Configuration object of the webhook

", "childParamsGroups": [ { "type": "string", "name": "url", - "description": "

The URL to which the payloads will be delivered.

", - "isRequired": true + "description": "

The URL to which the payloads will be delivered.

" }, { "type": "string", @@ -468033,16 +467920,6 @@ "type": "string or number", "name": "insecure_ssl", "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

" - }, - { - "type": "string", - "name": "address", - "description": "" - }, - { - "type": "string", - "name": "room", - "description": "" } ] }, @@ -468166,32 +468043,10 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "examples": [ - "\"foo@bar.com\"" - ] - }, - "password": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, - "room": { - "type": "string", - "examples": [ - "\"roomer\"" - ] - }, - "subdomain": { - "type": "string", - "examples": [ - "\"foo\"" - ] - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", @@ -468200,6 +468055,20 @@ "https://example.com/webhook" ] }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "examples": [ + "\"json\"" + ] + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers).", + "examples": [ + "\"********\"" + ] + }, "insecure_ssl": { "oneOf": [ { @@ -468213,32 +468082,6 @@ "type": "number" } ] - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "examples": [ - "\"json\"" - ] - }, - "digest": { - "type": "string", - "examples": [ - "\"sha256\"" - ] - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers).", - "examples": [ - "\"********\"" - ] - }, - "token": { - "type": "string", - "examples": [ - "\"abc\"" - ] } } }, diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index a799ad4d13..6e6fffc702 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -41,5 +41,5 @@ ] } }, - "sha": "7ab8592e0e02e3a1f4b89b14078e3ae793b17068" + "sha": "e44bcaa6f0d15e9c8c558b5023595ef39ad0f15a" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index 01ccf6550d..d848046de2 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -14934,6 +14934,16 @@ "type": "array of strings or null", "name": "allowed_values", "description": "

Ordered list of allowed values of the property

" + }, + { + "type": "string or null", + "name": "values_editable_by", + "description": "

Who can edit the values of the property

", + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ] } ] }, @@ -15098,6 +15108,16 @@ "type": "array of strings or null", "name": "allowed_values", "description": "

Ordered list of allowed values of the property

" + }, + { + "type": "string or null", + "name": "values_editable_by", + "description": "

Who can edit the values of the property

", + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ] } ] }, diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index debfc3d470..ba9842862f 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -14998,6 +14998,16 @@ "type": "array of strings or null", "name": "allowed_values", "description": "

Ordered list of allowed values of the property

" + }, + { + "type": "string or null", + "name": "values_editable_by", + "description": "

Who can edit the values of the property

", + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ] } ] }, @@ -15162,6 +15172,16 @@ "type": "array of strings or null", "name": "allowed_values", "description": "

Ordered list of allowed values of the property

" + }, + { + "type": "string or null", + "name": "values_editable_by", + "description": "

Who can edit the values of the property

", + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ] } ] }, diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 61b8ae55a6..82ff3502a2 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "7ab8592e0e02e3a1f4b89b14078e3ae793b17068" + "sha": "e44bcaa6f0d15e9c8c558b5023595ef39ad0f15a" } \ No newline at end of file