diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 3c35cb940..5ca5195bc 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -15091,6 +15091,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -37796,14 +37799,6 @@ }, "insecure_ssl": { "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "token": { - "type": "string", - "example": "\"abc\"" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" } } }, @@ -37967,33 +37962,7 @@ "type": "object", "properties": { "config": { - "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", - "properties": { - "url": { - "$ref": "#/components/schemas/webhook-config-url" - }, - "content_type": { - "$ref": "#/components/schemas/webhook-config-content-type" - }, - "secret": { - "$ref": "#/components/schemas/webhook-config-secret" - }, - "insecure_ssl": { - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "address": { - "type": "string", - "example": "\"bar@example.com\"" - }, - "room": { - "type": "string", - "example": "\"The Serious Room\"" - } - }, - "required": [ - "url" - ] + "$ref": "#/components/schemas/webhook-config" }, "events": { "type": "array", @@ -44376,6 +44345,70 @@ "category": "repos", "subcategory": "custom-properties" } + }, + "patch": { + "summary": "Create or update custom property values for a repository", + "description": "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\nRepository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.\n\nGitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-or-update-custom-properties-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the repositories.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/create-or-update-custom-properties-values" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "custom-properties" + } } }, "/repos/{owner}/{repo}/pulls": { @@ -96288,6 +96321,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -97784,6 +97827,11 @@ }, "security_and_analysis": { "$ref": "#/components/schemas/security-and-analysis" + }, + "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": [ @@ -108461,45 +108509,7 @@ ] }, "config": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, - "url": { - "$ref": "#/components/schemas/webhook-config-url" - }, - "insecure_ssl": { - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "content_type": { - "$ref": "#/components/schemas/webhook-config-content-type" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" - }, - "secret": { - "$ref": "#/components/schemas/webhook-config-secret" - }, - "token": { - "type": "string", - "example": "\"abc\"" - } - } + "$ref": "#/components/schemas/webhook-config" }, "updated_at": { "type": "string", @@ -285531,6 +285541,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -297259,6 +297272,24 @@ } ] }, + "create-or-update-custom-properties-values": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + }, "pull-request": { "value": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index e3fe2a603..a7265c1bd 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -10855,6 +10855,8 @@ paths: allowed_values: - production - development + values_editable_by: + - org_actors - property_name: service value_type: string - property_name: team @@ -27396,12 +27398,6 @@ paths: "$ref": "#/components/schemas/webhook-config-secret" insecure_ssl: "$ref": "#/components/schemas/webhook-config-insecure-ssl" - token: - type: string - example: '"abc"' - digest: - type: string - example: '"sha256"' events: type: array description: Determines what [events](https://docs.github.com/webhooks/event-payloads) @@ -27510,25 +27506,7 @@ paths: type: object properties: config: - type: object - description: Key/value pairs to provide settings for this webhook. - properties: - url: - "$ref": "#/components/schemas/webhook-config-url" - content_type: - "$ref": "#/components/schemas/webhook-config-content-type" - secret: - "$ref": "#/components/schemas/webhook-config-secret" - insecure_ssl: - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - address: - type: string - example: '"bar@example.com"' - room: - type: string - example: '"The Serious Room"' - required: - - url + "$ref": "#/components/schemas/webhook-config" events: type: array description: Determines what [events](https://docs.github.com/webhooks/event-payloads) @@ -31843,6 +31821,55 @@ paths: enabledForGitHubApps: true category: repos subcategory: custom-properties + patch: + summary: Create or update custom property values for a repository + description: |- + Create new or update existing custom property values for a repository. + Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + + Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + + GitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint. + tags: + - repos + operationId: repos/create-or-update-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the repositories. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - properties + examples: + default: + "$ref": "#/components/examples/create-or-update-custom-properties-values" + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: custom-properties "/repos/{owner}/{repo}/pulls": get: summary: List pull requests @@ -69691,6 +69718,14 @@ components: type: string nullable: true description: Ordered list of allowed values of the property + values_editable_by: + type: string + nullable: true + enum: + - org_actors + - org_and_repo_actors + example: org_actors + description: Who can edit the values of the property required: - property_name - value_type @@ -70878,6 +70913,12 @@ components: "$ref": "#/components/schemas/code-of-conduct-simple" security_and_analysis: "$ref": "#/components/schemas/security-and-analysis" + 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: - archive_url - assignees_url @@ -79121,34 +79162,7 @@ components: - push - pull_request config: - type: object - properties: - email: - type: string - example: '"foo@bar.com"' - password: - type: string - example: '"foo"' - room: - type: string - example: '"roomer"' - subdomain: - type: string - example: '"foo"' - url: - "$ref": "#/components/schemas/webhook-config-url" - insecure_ssl: - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - content_type: - "$ref": "#/components/schemas/webhook-config-content-type" - digest: - type: string - example: '"sha256"' - secret: - "$ref": "#/components/schemas/webhook-config-secret" - token: - type: string - example: '"abc"' + "$ref": "#/components/schemas/webhook-config" updated_at: type: string format: date-time @@ -213693,6 +213707,8 @@ components: allowed_values: - production - development + values_editable_by: + - org_actors - property_name: service value_type: string - property_name: team @@ -223709,6 +223725,15 @@ components: value: web - property_name: team value: octocat + create-or-update-custom-properties-values: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat pull-request: value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 3c35cb940..5ca5195bc 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -15091,6 +15091,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -37796,14 +37799,6 @@ }, "insecure_ssl": { "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "token": { - "type": "string", - "example": "\"abc\"" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" } } }, @@ -37967,33 +37962,7 @@ "type": "object", "properties": { "config": { - "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", - "properties": { - "url": { - "$ref": "#/components/schemas/webhook-config-url" - }, - "content_type": { - "$ref": "#/components/schemas/webhook-config-content-type" - }, - "secret": { - "$ref": "#/components/schemas/webhook-config-secret" - }, - "insecure_ssl": { - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "address": { - "type": "string", - "example": "\"bar@example.com\"" - }, - "room": { - "type": "string", - "example": "\"The Serious Room\"" - } - }, - "required": [ - "url" - ] + "$ref": "#/components/schemas/webhook-config" }, "events": { "type": "array", @@ -44376,6 +44345,70 @@ "category": "repos", "subcategory": "custom-properties" } + }, + "patch": { + "summary": "Create or update custom property values for a repository", + "description": "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\nRepository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.\n\nGitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-or-update-custom-properties-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the repositories.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/create-or-update-custom-properties-values" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "custom-properties" + } } }, "/repos/{owner}/{repo}/pulls": { @@ -96288,6 +96321,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -97784,6 +97827,11 @@ }, "security_and_analysis": { "$ref": "#/components/schemas/security-and-analysis" + }, + "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": [ @@ -108461,45 +108509,7 @@ ] }, "config": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, - "url": { - "$ref": "#/components/schemas/webhook-config-url" - }, - "insecure_ssl": { - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "content_type": { - "$ref": "#/components/schemas/webhook-config-content-type" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" - }, - "secret": { - "$ref": "#/components/schemas/webhook-config-secret" - }, - "token": { - "type": "string", - "example": "\"abc\"" - } - } + "$ref": "#/components/schemas/webhook-config" }, "updated_at": { "type": "string", @@ -285531,6 +285541,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -297259,6 +297272,24 @@ } ] }, + "create-or-update-custom-properties-values": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + }, "pull-request": { "value": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index e3fe2a603..a7265c1bd 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -10855,6 +10855,8 @@ paths: allowed_values: - production - development + values_editable_by: + - org_actors - property_name: service value_type: string - property_name: team @@ -27396,12 +27398,6 @@ paths: "$ref": "#/components/schemas/webhook-config-secret" insecure_ssl: "$ref": "#/components/schemas/webhook-config-insecure-ssl" - token: - type: string - example: '"abc"' - digest: - type: string - example: '"sha256"' events: type: array description: Determines what [events](https://docs.github.com/webhooks/event-payloads) @@ -27510,25 +27506,7 @@ paths: type: object properties: config: - type: object - description: Key/value pairs to provide settings for this webhook. - properties: - url: - "$ref": "#/components/schemas/webhook-config-url" - content_type: - "$ref": "#/components/schemas/webhook-config-content-type" - secret: - "$ref": "#/components/schemas/webhook-config-secret" - insecure_ssl: - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - address: - type: string - example: '"bar@example.com"' - room: - type: string - example: '"The Serious Room"' - required: - - url + "$ref": "#/components/schemas/webhook-config" events: type: array description: Determines what [events](https://docs.github.com/webhooks/event-payloads) @@ -31843,6 +31821,55 @@ paths: enabledForGitHubApps: true category: repos subcategory: custom-properties + patch: + summary: Create or update custom property values for a repository + description: |- + Create new or update existing custom property values for a repository. + Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + + Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + + GitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint. + tags: + - repos + operationId: repos/create-or-update-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the repositories. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - properties + examples: + default: + "$ref": "#/components/examples/create-or-update-custom-properties-values" + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: custom-properties "/repos/{owner}/{repo}/pulls": get: summary: List pull requests @@ -69691,6 +69718,14 @@ components: type: string nullable: true description: Ordered list of allowed values of the property + values_editable_by: + type: string + nullable: true + enum: + - org_actors + - org_and_repo_actors + example: org_actors + description: Who can edit the values of the property required: - property_name - value_type @@ -70878,6 +70913,12 @@ components: "$ref": "#/components/schemas/code-of-conduct-simple" security_and_analysis: "$ref": "#/components/schemas/security-and-analysis" + 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: - archive_url - assignees_url @@ -79121,34 +79162,7 @@ components: - push - pull_request config: - type: object - properties: - email: - type: string - example: '"foo@bar.com"' - password: - type: string - example: '"foo"' - room: - type: string - example: '"roomer"' - subdomain: - type: string - example: '"foo"' - url: - "$ref": "#/components/schemas/webhook-config-url" - insecure_ssl: - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - content_type: - "$ref": "#/components/schemas/webhook-config-content-type" - digest: - type: string - example: '"sha256"' - secret: - "$ref": "#/components/schemas/webhook-config-secret" - token: - type: string - example: '"abc"' + "$ref": "#/components/schemas/webhook-config" updated_at: type: string format: date-time @@ -213693,6 +213707,8 @@ components: allowed_values: - production - development + values_editable_by: + - org_actors - property_name: service value_type: string - property_name: team @@ -223709,6 +223725,15 @@ components: value: web - property_name: team value: octocat + create-or-update-custom-properties-values: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat pull-request: value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 018b885d3..86f690312 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -104216,6 +104216,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -104236,6 +104246,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -104384,6 +104397,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -104412,6 +104435,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -104476,6 +104502,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -104496,6 +104532,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -104650,6 +104689,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -104870,6 +104919,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -111275,6 +111334,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": [ @@ -143709,6 +143773,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": [ @@ -149058,6 +149127,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": [ @@ -255252,6 +255326,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": [ @@ -259432,30 +259511,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -259467,24 +259542,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -259709,14 +259766,6 @@ "type": "number" } ] - }, - "token": { - "type": "string", - "example": "\"abc\"" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" } } }, @@ -259798,30 +259847,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -259833,24 +259878,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -260175,30 +260202,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -260210,24 +260233,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -260415,8 +260420,9 @@ "type": "object", "properties": { "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", "properties": { "url": { "type": "string", @@ -260445,19 +260451,8 @@ "type": "number" } ] - }, - "address": { - "type": "string", - "example": "\"bar@example.com\"" - }, - "room": { - "type": "string", - "example": "\"The Serious Room\"" } - }, - "required": [ - "url" - ] + } }, "events": { "type": "array", @@ -260543,30 +260538,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -260578,24 +260569,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -329165,6 +329138,160 @@ "category": "repos", "subcategory": "custom-properties" } + }, + "patch": { + "summary": "Create or update custom property values for a repository", + "description": "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\nRepository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.\n\nGitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-or-update-custom-properties-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository" + }, + "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" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the repositories.", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": "string", + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "custom-properties" + } } }, "/repos/{owner}/{repo}/pulls": { @@ -397482,6 +397609,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": [ @@ -407963,6 +408095,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": [ @@ -445086,6 +445223,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": [ @@ -478423,6 +478565,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": [ @@ -560948,6 +561095,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -561780,6 +561937,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -1042539,6 +1042706,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/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 497443fb1..afc17096a 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -25844,6 +25844,14 @@ paths: type: string nullable: true description: Ordered list of allowed values of the property + values_editable_by: + type: string + nullable: true + enum: + - org_actors + - org_and_repo_actors + example: org_actors + description: Who can edit the values of the property required: - property_name - value_type @@ -25858,6 +25866,8 @@ paths: allowed_values: - production - development + values_editable_by: + - org_actors - property_name: service value_type: string - property_name: team @@ -25915,6 +25925,8 @@ paths: allowed_values: - production - development + values_editable_by: + - org_actors - property_name: service value_type: string - property_name: team @@ -27034,6 +27046,12 @@ paths: - name - html_url security_and_analysis: *189 + 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: - archive_url - assignees_url @@ -58503,31 +58521,7 @@ paths: example: - push - pull_request - config: - type: object - properties: - email: - type: string - example: '"foo@bar.com"' - password: - type: string - example: '"foo"' - room: - type: string - example: '"roomer"' - subdomain: - type: string - example: '"foo"' - url: *8 - insecure_ssl: *11 - content_type: *9 - digest: - type: string - example: '"sha256"' - secret: *10 - token: - type: string - example: '"abc"' + config: *12 updated_at: type: string format: date-time @@ -58648,12 +58642,6 @@ paths: content_type: *9 secret: *10 insecure_ssl: *11 - token: - type: string - example: '"abc"' - digest: - type: string - example: '"sha256"' events: type: array description: Determines what [events](https://docs.github.com/webhooks/event-payloads) @@ -58775,22 +58763,7 @@ paths: schema: type: object properties: - config: - type: object - description: Key/value pairs to provide settings for this webhook. - properties: - url: *8 - content_type: *9 - secret: *10 - insecure_ssl: *11 - address: - type: string - example: '"bar@example.com"' - room: - type: string - example: '"The Serious Room"' - required: - - url + config: *12 events: type: array description: Determines what [events](https://docs.github.com/webhooks/event-payloads) @@ -66718,6 +66691,59 @@ paths: enabledForGitHubApps: true category: repos subcategory: custom-properties + patch: + summary: Create or update custom property values for a repository + description: |- + Create new or update existing custom property values for a repository. + Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + + Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + + GitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint. + tags: + - repos + operationId: repos/create-or-update-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository + parameters: + - *223 + - *224 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the repositories. + items: *186 + required: + - properties + examples: + default: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': *28 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: custom-properties "/repos/{owner}/{repo}/pulls": get: summary: List pull requests diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 018b885d3..86f690312 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -104216,6 +104216,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -104236,6 +104246,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -104384,6 +104397,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -104412,6 +104435,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -104476,6 +104502,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -104496,6 +104532,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -104650,6 +104689,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -104870,6 +104919,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -111275,6 +111334,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": [ @@ -143709,6 +143773,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": [ @@ -149058,6 +149127,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": [ @@ -255252,6 +255326,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": [ @@ -259432,30 +259511,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -259467,24 +259542,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -259709,14 +259766,6 @@ "type": "number" } ] - }, - "token": { - "type": "string", - "example": "\"abc\"" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" } } }, @@ -259798,30 +259847,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -259833,24 +259878,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -260175,30 +260202,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -260210,24 +260233,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -260415,8 +260420,9 @@ "type": "object", "properties": { "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", "properties": { "url": { "type": "string", @@ -260445,19 +260451,8 @@ "type": "number" } ] - }, - "address": { - "type": "string", - "example": "\"bar@example.com\"" - }, - "room": { - "type": "string", - "example": "\"The Serious Room\"" } - }, - "required": [ - "url" - ] + } }, "events": { "type": "array", @@ -260543,30 +260538,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -260578,24 +260569,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -329165,6 +329138,160 @@ "category": "repos", "subcategory": "custom-properties" } + }, + "patch": { + "summary": "Create or update custom property values for a repository", + "description": "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\nRepository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.\n\nGitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-or-update-custom-properties-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository" + }, + "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" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the repositories.", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": "string", + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "custom-properties" + } } }, "/repos/{owner}/{repo}/pulls": { @@ -397482,6 +397609,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": [ @@ -407963,6 +408095,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": [ @@ -445086,6 +445223,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": [ @@ -478423,6 +478565,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": [ @@ -560948,6 +561095,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -561780,6 +561937,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -1042539,6 +1042706,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/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 497443fb1..afc17096a 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -25844,6 +25844,14 @@ paths: type: string nullable: true description: Ordered list of allowed values of the property + values_editable_by: + type: string + nullable: true + enum: + - org_actors + - org_and_repo_actors + example: org_actors + description: Who can edit the values of the property required: - property_name - value_type @@ -25858,6 +25866,8 @@ paths: allowed_values: - production - development + values_editable_by: + - org_actors - property_name: service value_type: string - property_name: team @@ -25915,6 +25925,8 @@ paths: allowed_values: - production - development + values_editable_by: + - org_actors - property_name: service value_type: string - property_name: team @@ -27034,6 +27046,12 @@ paths: - name - html_url security_and_analysis: *189 + 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: - archive_url - assignees_url @@ -58503,31 +58521,7 @@ paths: example: - push - pull_request - config: - type: object - properties: - email: - type: string - example: '"foo@bar.com"' - password: - type: string - example: '"foo"' - room: - type: string - example: '"roomer"' - subdomain: - type: string - example: '"foo"' - url: *8 - insecure_ssl: *11 - content_type: *9 - digest: - type: string - example: '"sha256"' - secret: *10 - token: - type: string - example: '"abc"' + config: *12 updated_at: type: string format: date-time @@ -58648,12 +58642,6 @@ paths: content_type: *9 secret: *10 insecure_ssl: *11 - token: - type: string - example: '"abc"' - digest: - type: string - example: '"sha256"' events: type: array description: Determines what [events](https://docs.github.com/webhooks/event-payloads) @@ -58775,22 +58763,7 @@ paths: schema: type: object properties: - config: - type: object - description: Key/value pairs to provide settings for this webhook. - properties: - url: *8 - content_type: *9 - secret: *10 - insecure_ssl: *11 - address: - type: string - example: '"bar@example.com"' - room: - type: string - example: '"The Serious Room"' - required: - - url + config: *12 events: type: array description: Determines what [events](https://docs.github.com/webhooks/event-payloads) @@ -66718,6 +66691,59 @@ paths: enabledForGitHubApps: true category: repos subcategory: custom-properties + patch: + summary: Create or update custom property values for a repository + description: |- + Create new or update existing custom property values for a repository. + Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + + Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + + GitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint. + tags: + - repos + operationId: repos/create-or-update-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository + parameters: + - *223 + - *224 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the repositories. + items: *186 + required: + - properties + examples: + default: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': *28 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: custom-properties "/repos/{owner}/{repo}/pulls": get: summary: List pull requests diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index 1ed246233..7cc155e99 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -120793,6 +120793,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -120813,6 +120823,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -120961,6 +120974,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -120989,6 +121012,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -121053,6 +121079,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -121073,6 +121109,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -121227,6 +121266,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -121447,6 +121496,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -127879,6 +127938,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": [ @@ -161439,6 +161503,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": [ @@ -166816,6 +166885,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": [ @@ -273252,6 +273326,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": [ @@ -277432,30 +277511,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -277467,24 +277542,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -277709,14 +277766,6 @@ "type": "number" } ] - }, - "token": { - "type": "string", - "example": "\"abc\"" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" } } }, @@ -277798,30 +277847,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -277833,24 +277878,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -278175,30 +278202,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -278210,24 +278233,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -278415,8 +278420,9 @@ "type": "object", "properties": { "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", "properties": { "url": { "type": "string", @@ -278445,19 +278451,8 @@ "type": "number" } ] - }, - "address": { - "type": "string", - "example": "\"bar@example.com\"" - }, - "room": { - "type": "string", - "example": "\"The Serious Room\"" } - }, - "required": [ - "url" - ] + } }, "events": { "type": "array", @@ -278543,30 +278538,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -278578,24 +278569,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -347308,6 +347281,160 @@ "category": "repos", "subcategory": "custom-properties" } + }, + "patch": { + "summary": "Create or update custom property values for a repository", + "description": "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\nRepository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.\n\nGitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-or-update-custom-properties-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository" + }, + "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" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the repositories.", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": "string", + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "custom-properties" + } } }, "/repos/{owner}/{repo}/pulls": { @@ -415661,6 +415788,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": [ @@ -426166,6 +426298,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": [ @@ -473752,6 +473889,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": [ @@ -507176,6 +507318,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": [ @@ -589842,6 +589989,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -590674,6 +590831,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -1071457,6 +1071624,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/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index d73a39c5d..570819fd9 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -30928,6 +30928,14 @@ paths: type: string nullable: true description: Ordered list of allowed values of the property + values_editable_by: + type: string + nullable: true + enum: + - org_actors + - org_and_repo_actors + example: org_actors + description: Who can edit the values of the property required: - property_name - value_type @@ -30942,6 +30950,8 @@ paths: allowed_values: - production - development + values_editable_by: + - org_actors - property_name: service value_type: string - property_name: team @@ -30999,6 +31009,8 @@ paths: allowed_values: - production - development + values_editable_by: + - org_actors - property_name: service value_type: string - property_name: team @@ -32120,6 +32132,12 @@ paths: - name - html_url security_and_analysis: *231 + 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: - archive_url - assignees_url @@ -63857,31 +63875,7 @@ paths: example: - push - pull_request - config: - type: object - properties: - email: - type: string - example: '"foo@bar.com"' - password: - type: string - example: '"foo"' - room: - type: string - example: '"roomer"' - subdomain: - type: string - example: '"foo"' - url: *8 - insecure_ssl: *11 - content_type: *9 - digest: - type: string - example: '"sha256"' - secret: *10 - token: - type: string - example: '"abc"' + config: *12 updated_at: type: string format: date-time @@ -64002,12 +63996,6 @@ paths: content_type: *9 secret: *10 insecure_ssl: *11 - token: - type: string - example: '"abc"' - digest: - type: string - example: '"sha256"' events: type: array description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) @@ -64129,22 +64117,7 @@ paths: schema: type: object properties: - config: - type: object - description: Key/value pairs to provide settings for this webhook. - properties: - url: *8 - content_type: *9 - secret: *10 - insecure_ssl: *11 - address: - type: string - example: '"bar@example.com"' - room: - type: string - example: '"The Serious Room"' - required: - - url + config: *12 events: type: array description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) @@ -72129,6 +72102,59 @@ paths: enabledForGitHubApps: true category: repos subcategory: custom-properties + patch: + summary: Create or update custom property values for a repository + description: |- + Create new or update existing custom property values for a repository. + Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + + Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + + GitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint. + tags: + - repos + operationId: repos/create-or-update-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository + parameters: + - *280 + - *281 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the repositories. + items: *228 + required: + - properties + examples: + default: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': *28 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: custom-properties "/repos/{owner}/{repo}/pulls": get: summary: List pull requests diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index 1ed246233..7cc155e99 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -120793,6 +120793,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -120813,6 +120823,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -120961,6 +120974,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -120989,6 +121012,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -121053,6 +121079,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -121073,6 +121109,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -121227,6 +121266,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -121447,6 +121496,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -127879,6 +127938,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": [ @@ -161439,6 +161503,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": [ @@ -166816,6 +166885,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": [ @@ -273252,6 +273326,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": [ @@ -277432,30 +277511,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -277467,24 +277542,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -277709,14 +277766,6 @@ "type": "number" } ] - }, - "token": { - "type": "string", - "example": "\"abc\"" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" } } }, @@ -277798,30 +277847,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -277833,24 +277878,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -278175,30 +278202,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -278210,24 +278233,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -278415,8 +278420,9 @@ "type": "object", "properties": { "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", "properties": { "url": { "type": "string", @@ -278445,19 +278451,8 @@ "type": "number" } ] - }, - "address": { - "type": "string", - "example": "\"bar@example.com\"" - }, - "room": { - "type": "string", - "example": "\"The Serious Room\"" } - }, - "required": [ - "url" - ] + } }, "events": { "type": "array", @@ -278543,30 +278538,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -278578,24 +278569,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -347308,6 +347281,160 @@ "category": "repos", "subcategory": "custom-properties" } + }, + "patch": { + "summary": "Create or update custom property values for a repository", + "description": "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\nRepository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.\n\nGitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-or-update-custom-properties-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository" + }, + "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" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the repositories.", + "items": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": "string", + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "custom-properties" + } } }, "/repos/{owner}/{repo}/pulls": { @@ -415661,6 +415788,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": [ @@ -426166,6 +426298,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": [ @@ -473752,6 +473889,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": [ @@ -507176,6 +507318,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": [ @@ -589842,6 +589989,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -590674,6 +590831,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -1071457,6 +1071624,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/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index d73a39c5d..570819fd9 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -30928,6 +30928,14 @@ paths: type: string nullable: true description: Ordered list of allowed values of the property + values_editable_by: + type: string + nullable: true + enum: + - org_actors + - org_and_repo_actors + example: org_actors + description: Who can edit the values of the property required: - property_name - value_type @@ -30942,6 +30950,8 @@ paths: allowed_values: - production - development + values_editable_by: + - org_actors - property_name: service value_type: string - property_name: team @@ -30999,6 +31009,8 @@ paths: allowed_values: - production - development + values_editable_by: + - org_actors - property_name: service value_type: string - property_name: team @@ -32120,6 +32132,12 @@ paths: - name - html_url security_and_analysis: *231 + 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: - archive_url - assignees_url @@ -63857,31 +63875,7 @@ paths: example: - push - pull_request - config: - type: object - properties: - email: - type: string - example: '"foo@bar.com"' - password: - type: string - example: '"foo"' - room: - type: string - example: '"roomer"' - subdomain: - type: string - example: '"foo"' - url: *8 - insecure_ssl: *11 - content_type: *9 - digest: - type: string - example: '"sha256"' - secret: *10 - token: - type: string - example: '"abc"' + config: *12 updated_at: type: string format: date-time @@ -64002,12 +63996,6 @@ paths: content_type: *9 secret: *10 insecure_ssl: *11 - token: - type: string - example: '"abc"' - digest: - type: string - example: '"sha256"' events: type: array description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) @@ -64129,22 +64117,7 @@ paths: schema: type: object properties: - config: - type: object - description: Key/value pairs to provide settings for this webhook. - properties: - url: *8 - content_type: *9 - secret: *10 - insecure_ssl: *11 - address: - type: string - example: '"bar@example.com"' - room: - type: string - example: '"The Serious Room"' - required: - - url + config: *12 events: type: array description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) @@ -72129,6 +72102,59 @@ paths: enabledForGitHubApps: true category: repos subcategory: custom-properties + patch: + summary: Create or update custom property values for a repository + description: |- + Create new or update existing custom property values for a repository. + Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + + Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + + GitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint. + tags: + - repos + operationId: repos/create-or-update-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository + parameters: + - *280 + - *281 + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the repositories. + items: *228 + required: + - properties + examples: + default: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': *28 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: custom-properties "/repos/{owner}/{repo}/pulls": get: summary: List pull requests diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 2da08d11a..b17378a64 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -19639,6 +19639,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -42806,14 +42809,6 @@ }, "insecure_ssl": { "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "token": { - "type": "string", - "example": "\"abc\"" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" } } }, @@ -42977,33 +42972,7 @@ "type": "object", "properties": { "config": { - "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", - "properties": { - "url": { - "$ref": "#/components/schemas/webhook-config-url" - }, - "content_type": { - "$ref": "#/components/schemas/webhook-config-content-type" - }, - "secret": { - "$ref": "#/components/schemas/webhook-config-secret" - }, - "insecure_ssl": { - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "address": { - "type": "string", - "example": "\"bar@example.com\"" - }, - "room": { - "type": "string", - "example": "\"The Serious Room\"" - } - }, - "required": [ - "url" - ] + "$ref": "#/components/schemas/webhook-config" }, "events": { "type": "array", @@ -49457,6 +49426,70 @@ "category": "repos", "subcategory": "custom-properties" } + }, + "patch": { + "summary": "Create or update custom property values for a repository", + "description": "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\nRepository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.\n\nGitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-or-update-custom-properties-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the repositories.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/create-or-update-custom-properties-values" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "custom-properties" + } } }, "/repos/{owner}/{repo}/pulls": { @@ -104843,6 +104876,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -106339,6 +106382,11 @@ }, "security_and_analysis": { "$ref": "#/components/schemas/security-and-analysis" + }, + "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": [ @@ -116944,45 +116992,7 @@ ] }, "config": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, - "url": { - "$ref": "#/components/schemas/webhook-config-url" - }, - "insecure_ssl": { - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "content_type": { - "$ref": "#/components/schemas/webhook-config-content-type" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" - }, - "secret": { - "$ref": "#/components/schemas/webhook-config-secret" - }, - "token": { - "type": "string", - "example": "\"abc\"" - } - } + "$ref": "#/components/schemas/webhook-config" }, "updated_at": { "type": "string", @@ -296086,6 +296096,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -307825,6 +307838,24 @@ } ] }, + "create-or-update-custom-properties-values": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + }, "pull-request": { "value": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index 3d4628895..9fbe83650 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -14152,6 +14152,8 @@ paths: allowed_values: - production - development + values_editable_by: + - org_actors - property_name: service value_type: string - property_name: team @@ -31033,12 +31035,6 @@ paths: "$ref": "#/components/schemas/webhook-config-secret" insecure_ssl: "$ref": "#/components/schemas/webhook-config-insecure-ssl" - token: - type: string - example: '"abc"' - digest: - type: string - example: '"sha256"' events: type: array description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) @@ -31147,25 +31143,7 @@ paths: type: object properties: config: - type: object - description: Key/value pairs to provide settings for this webhook. - properties: - url: - "$ref": "#/components/schemas/webhook-config-url" - content_type: - "$ref": "#/components/schemas/webhook-config-content-type" - secret: - "$ref": "#/components/schemas/webhook-config-secret" - insecure_ssl: - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - address: - type: string - example: '"bar@example.com"' - room: - type: string - example: '"The Serious Room"' - required: - - url + "$ref": "#/components/schemas/webhook-config" events: type: array description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) @@ -35538,6 +35516,55 @@ paths: enabledForGitHubApps: true category: repos subcategory: custom-properties + patch: + summary: Create or update custom property values for a repository + description: |- + Create new or update existing custom property values for a repository. + Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + + Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + + GitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint. + tags: + - repos + operationId: repos/create-or-update-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the repositories. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - properties + examples: + default: + "$ref": "#/components/examples/create-or-update-custom-properties-values" + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: custom-properties "/repos/{owner}/{repo}/pulls": get: summary: List pull requests @@ -75961,6 +75988,14 @@ components: type: string nullable: true description: Ordered list of allowed values of the property + values_editable_by: + type: string + nullable: true + enum: + - org_actors + - org_and_repo_actors + example: org_actors + description: Who can edit the values of the property required: - property_name - value_type @@ -77148,6 +77183,12 @@ components: "$ref": "#/components/schemas/code-of-conduct-simple" security_and_analysis: "$ref": "#/components/schemas/security-and-analysis" + 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: - archive_url - assignees_url @@ -85338,34 +85379,7 @@ components: - push - pull_request config: - type: object - properties: - email: - type: string - example: '"foo@bar.com"' - password: - type: string - example: '"foo"' - room: - type: string - example: '"roomer"' - subdomain: - type: string - example: '"foo"' - url: - "$ref": "#/components/schemas/webhook-config-url" - insecure_ssl: - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - content_type: - "$ref": "#/components/schemas/webhook-config-content-type" - digest: - type: string - example: '"sha256"' - secret: - "$ref": "#/components/schemas/webhook-config-secret" - token: - type: string - example: '"abc"' + "$ref": "#/components/schemas/webhook-config" updated_at: type: string format: date-time @@ -221475,6 +221489,8 @@ components: allowed_values: - production - development + values_editable_by: + - org_actors - property_name: service value_type: string - property_name: team @@ -231494,6 +231510,15 @@ components: value: web - property_name: team value: octocat + create-or-update-custom-properties-values: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat pull-request: value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index 2da08d11a..b17378a64 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -19639,6 +19639,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -42806,14 +42809,6 @@ }, "insecure_ssl": { "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "token": { - "type": "string", - "example": "\"abc\"" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" } } }, @@ -42977,33 +42972,7 @@ "type": "object", "properties": { "config": { - "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", - "properties": { - "url": { - "$ref": "#/components/schemas/webhook-config-url" - }, - "content_type": { - "$ref": "#/components/schemas/webhook-config-content-type" - }, - "secret": { - "$ref": "#/components/schemas/webhook-config-secret" - }, - "insecure_ssl": { - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "address": { - "type": "string", - "example": "\"bar@example.com\"" - }, - "room": { - "type": "string", - "example": "\"The Serious Room\"" - } - }, - "required": [ - "url" - ] + "$ref": "#/components/schemas/webhook-config" }, "events": { "type": "array", @@ -49457,6 +49426,70 @@ "category": "repos", "subcategory": "custom-properties" } + }, + "patch": { + "summary": "Create or update custom property values for a repository", + "description": "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\nRepository admins and other users with the repository-level \"edit custom property values\" fine-grained permission can use this endpoint.\n\nGitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-or-update-custom-properties-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "A list of custom property names and associated values to apply to the repositories.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/create-or-update-custom-properties-values" + } + } + } + } + }, + "responses": { + "204": { + "description": "No Content when custom property values are successfully created or updated" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "custom-properties" + } } }, "/repos/{owner}/{repo}/pulls": { @@ -104843,6 +104876,16 @@ }, "nullable": true, "description": "Ordered list of allowed values of the property" + }, + "values_editable_by": { + "type": "string", + "nullable": true, + "enum": [ + "org_actors", + "org_and_repo_actors" + ], + "example": "org_actors", + "description": "Who can edit the values of the property" } }, "required": [ @@ -106339,6 +106382,11 @@ }, "security_and_analysis": { "$ref": "#/components/schemas/security-and-analysis" + }, + "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": [ @@ -116944,45 +116992,7 @@ ] }, "config": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, - "url": { - "$ref": "#/components/schemas/webhook-config-url" - }, - "insecure_ssl": { - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "content_type": { - "$ref": "#/components/schemas/webhook-config-content-type" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" - }, - "secret": { - "$ref": "#/components/schemas/webhook-config-secret" - }, - "token": { - "type": "string", - "example": "\"abc\"" - } - } + "$ref": "#/components/schemas/webhook-config" }, "updated_at": { "type": "string", @@ -296086,6 +296096,9 @@ "allowed_values": [ "production", "development" + ], + "values_editable_by": [ + "org_actors" ] }, { @@ -307825,6 +307838,24 @@ } ] }, + "create-or-update-custom-properties-values": { + "value": { + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + }, "pull-request": { "value": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index 3d4628895..9fbe83650 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -14152,6 +14152,8 @@ paths: allowed_values: - production - development + values_editable_by: + - org_actors - property_name: service value_type: string - property_name: team @@ -31033,12 +31035,6 @@ paths: "$ref": "#/components/schemas/webhook-config-secret" insecure_ssl: "$ref": "#/components/schemas/webhook-config-insecure-ssl" - token: - type: string - example: '"abc"' - digest: - type: string - example: '"sha256"' events: type: array description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) @@ -31147,25 +31143,7 @@ paths: type: object properties: config: - type: object - description: Key/value pairs to provide settings for this webhook. - properties: - url: - "$ref": "#/components/schemas/webhook-config-url" - content_type: - "$ref": "#/components/schemas/webhook-config-content-type" - secret: - "$ref": "#/components/schemas/webhook-config-secret" - insecure_ssl: - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - address: - type: string - example: '"bar@example.com"' - room: - type: string - example: '"The Serious Room"' - required: - - url + "$ref": "#/components/schemas/webhook-config" events: type: array description: Determines what [events](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads) @@ -35538,6 +35516,55 @@ paths: enabledForGitHubApps: true category: repos subcategory: custom-properties + patch: + summary: Create or update custom property values for a repository + description: |- + Create new or update existing custom property values for a repository. + Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + + Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + + GitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint. + tags: + - repos + operationId: repos/create-or-update-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the repositories. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - properties + examples: + default: + "$ref": "#/components/examples/create-or-update-custom-properties-values" + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: custom-properties "/repos/{owner}/{repo}/pulls": get: summary: List pull requests @@ -75961,6 +75988,14 @@ components: type: string nullable: true description: Ordered list of allowed values of the property + values_editable_by: + type: string + nullable: true + enum: + - org_actors + - org_and_repo_actors + example: org_actors + description: Who can edit the values of the property required: - property_name - value_type @@ -77148,6 +77183,12 @@ components: "$ref": "#/components/schemas/code-of-conduct-simple" security_and_analysis: "$ref": "#/components/schemas/security-and-analysis" + 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: - archive_url - assignees_url @@ -85338,34 +85379,7 @@ components: - push - pull_request config: - type: object - properties: - email: - type: string - example: '"foo@bar.com"' - password: - type: string - example: '"foo"' - room: - type: string - example: '"roomer"' - subdomain: - type: string - example: '"foo"' - url: - "$ref": "#/components/schemas/webhook-config-url" - insecure_ssl: - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - content_type: - "$ref": "#/components/schemas/webhook-config-content-type" - digest: - type: string - example: '"sha256"' - secret: - "$ref": "#/components/schemas/webhook-config-secret" - token: - type: string - example: '"abc"' + "$ref": "#/components/schemas/webhook-config" updated_at: type: string format: date-time @@ -221475,6 +221489,8 @@ components: allowed_values: - production - development + values_editable_by: + - org_actors - property_name: service value_type: string - property_name: team @@ -231494,6 +231510,15 @@ components: value: web - property_name: team value: octocat + create-or-update-custom-properties-values: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat pull-request: value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 diff --git a/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json b/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json index 1cec51385..2bc930955 100644 --- a/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json +++ b/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json @@ -250605,30 +250605,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -250640,24 +250636,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -250882,14 +250860,6 @@ "type": "number" } ] - }, - "token": { - "type": "string", - "example": "\"abc\"" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" } } }, @@ -250971,30 +250941,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -251006,24 +250972,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -251348,30 +251296,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -251383,24 +251327,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -251588,8 +251514,9 @@ "type": "object", "properties": { "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", "properties": { "url": { "type": "string", @@ -251618,19 +251545,8 @@ "type": "number" } ] - }, - "address": { - "type": "string", - "example": "\"bar@example.com\"" - }, - "room": { - "type": "string", - "example": "\"The Serious Room\"" } - }, - "required": [ - "url" - ] + } }, "events": { "type": "array", @@ -251716,30 +251632,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -251751,24 +251663,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, diff --git a/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml b/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml index 7243fede7..e6753c08e 100644 --- a/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml +++ b/descriptions/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml @@ -56523,31 +56523,7 @@ paths: example: - push - pull_request - config: - type: object - properties: - email: - type: string - example: '"foo@bar.com"' - password: - type: string - example: '"foo"' - room: - type: string - example: '"roomer"' - subdomain: - type: string - example: '"foo"' - url: *23 - insecure_ssl: *26 - content_type: *24 - digest: - type: string - example: '"sha256"' - secret: *25 - token: - type: string - example: '"abc"' + config: *27 updated_at: type: string format: date-time @@ -56668,12 +56644,6 @@ paths: content_type: *24 secret: *25 insecure_ssl: *26 - token: - type: string - example: '"abc"' - digest: - type: string - example: '"sha256"' events: type: array description: Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) @@ -56795,22 +56765,7 @@ paths: schema: type: object properties: - config: - type: object - description: Key/value pairs to provide settings for this webhook. - properties: - url: *23 - content_type: *24 - secret: *25 - insecure_ssl: *26 - address: - type: string - example: '"bar@example.com"' - room: - type: string - example: '"The Serious Room"' - required: - - url + config: *27 events: type: array description: Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) diff --git a/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.json b/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.json index 1cec51385..2bc930955 100644 --- a/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.json +++ b/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.json @@ -250605,30 +250605,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -250640,24 +250636,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -250882,14 +250860,6 @@ "type": "number" } ] - }, - "token": { - "type": "string", - "example": "\"abc\"" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" } } }, @@ -250971,30 +250941,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -251006,24 +250972,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -251348,30 +251296,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -251383,24 +251327,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, @@ -251588,8 +251514,9 @@ "type": "object", "properties": { "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", "properties": { "url": { "type": "string", @@ -251618,19 +251545,8 @@ "type": "number" } ] - }, - "address": { - "type": "string", - "example": "\"bar@example.com\"" - }, - "room": { - "type": "string", - "example": "\"The Serious Room\"" } - }, - "required": [ - "url" - ] + } }, "events": { "type": "array", @@ -251716,30 +251632,26 @@ ] }, "config": { + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, "url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "example": "https://example.com/webhook", "format": "uri" }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"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).", + "example": "\"********\"" + }, "insecure_ssl": { "oneOf": [ { @@ -251751,24 +251663,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`.", - "example": "\"json\"" - }, - "digest": { - "type": "string", - "example": "\"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).", - "example": "\"********\"" - }, - "token": { - "type": "string", - "example": "\"abc\"" } } }, diff --git a/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.yaml b/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.yaml index 7243fede7..e6753c08e 100644 --- a/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.yaml +++ b/descriptions/ghes-3.10/dereferenced/ghes-3.10.deref.yaml @@ -56523,31 +56523,7 @@ paths: example: - push - pull_request - config: - type: object - properties: - email: - type: string - example: '"foo@bar.com"' - password: - type: string - example: '"foo"' - room: - type: string - example: '"roomer"' - subdomain: - type: string - example: '"foo"' - url: *23 - insecure_ssl: *26 - content_type: *24 - digest: - type: string - example: '"sha256"' - secret: *25 - token: - type: string - example: '"abc"' + config: *27 updated_at: type: string format: date-time @@ -56668,12 +56644,6 @@ paths: content_type: *24 secret: *25 insecure_ssl: *26 - token: - type: string - example: '"abc"' - digest: - type: string - example: '"sha256"' events: type: array description: Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) @@ -56795,22 +56765,7 @@ paths: schema: type: object properties: - config: - type: object - description: Key/value pairs to provide settings for this webhook. - properties: - url: *23 - content_type: *24 - secret: *25 - insecure_ssl: *26 - address: - type: string - example: '"bar@example.com"' - room: - type: string - example: '"The Serious Room"' - required: - - url + config: *27 events: type: array description: Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) diff --git a/descriptions/ghes-3.10/ghes-3.10.2022-11-28.json b/descriptions/ghes-3.10/ghes-3.10.2022-11-28.json index c7a434047..22f6e30e0 100644 --- a/descriptions/ghes-3.10/ghes-3.10.2022-11-28.json +++ b/descriptions/ghes-3.10/ghes-3.10.2022-11-28.json @@ -39148,14 +39148,6 @@ }, "insecure_ssl": { "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "token": { - "type": "string", - "example": "\"abc\"" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" } } }, @@ -39319,33 +39311,7 @@ "type": "object", "properties": { "config": { - "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", - "properties": { - "url": { - "$ref": "#/components/schemas/webhook-config-url" - }, - "content_type": { - "$ref": "#/components/schemas/webhook-config-content-type" - }, - "secret": { - "$ref": "#/components/schemas/webhook-config-secret" - }, - "insecure_ssl": { - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "address": { - "type": "string", - "example": "\"bar@example.com\"" - }, - "room": { - "type": "string", - "example": "\"The Serious Room\"" - } - }, - "required": [ - "url" - ] + "$ref": "#/components/schemas/webhook-config" }, "events": { "type": "array", @@ -106863,45 +106829,7 @@ ] }, "config": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, - "url": { - "$ref": "#/components/schemas/webhook-config-url" - }, - "insecure_ssl": { - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "content_type": { - "$ref": "#/components/schemas/webhook-config-content-type" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" - }, - "secret": { - "$ref": "#/components/schemas/webhook-config-secret" - }, - "token": { - "type": "string", - "example": "\"abc\"" - } - } + "$ref": "#/components/schemas/webhook-config" }, "updated_at": { "type": "string", diff --git a/descriptions/ghes-3.10/ghes-3.10.2022-11-28.yaml b/descriptions/ghes-3.10/ghes-3.10.2022-11-28.yaml index ea75d8728..779f78ed9 100644 --- a/descriptions/ghes-3.10/ghes-3.10.2022-11-28.yaml +++ b/descriptions/ghes-3.10/ghes-3.10.2022-11-28.yaml @@ -28222,12 +28222,6 @@ paths: "$ref": "#/components/schemas/webhook-config-secret" insecure_ssl: "$ref": "#/components/schemas/webhook-config-insecure-ssl" - token: - type: string - example: '"abc"' - digest: - type: string - example: '"sha256"' events: type: array description: Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) @@ -28336,25 +28330,7 @@ paths: type: object properties: config: - type: object - description: Key/value pairs to provide settings for this webhook. - properties: - url: - "$ref": "#/components/schemas/webhook-config-url" - content_type: - "$ref": "#/components/schemas/webhook-config-content-type" - secret: - "$ref": "#/components/schemas/webhook-config-secret" - insecure_ssl: - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - address: - type: string - example: '"bar@example.com"' - room: - type: string - example: '"The Serious Room"' - required: - - url + "$ref": "#/components/schemas/webhook-config" events: type: array description: Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) @@ -77244,34 +77220,7 @@ components: - push - pull_request config: - type: object - properties: - email: - type: string - example: '"foo@bar.com"' - password: - type: string - example: '"foo"' - room: - type: string - example: '"roomer"' - subdomain: - type: string - example: '"foo"' - url: - "$ref": "#/components/schemas/webhook-config-url" - insecure_ssl: - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - content_type: - "$ref": "#/components/schemas/webhook-config-content-type" - digest: - type: string - example: '"sha256"' - secret: - "$ref": "#/components/schemas/webhook-config-secret" - token: - type: string - example: '"abc"' + "$ref": "#/components/schemas/webhook-config" updated_at: type: string format: date-time diff --git a/descriptions/ghes-3.10/ghes-3.10.json b/descriptions/ghes-3.10/ghes-3.10.json index c7a434047..22f6e30e0 100644 --- a/descriptions/ghes-3.10/ghes-3.10.json +++ b/descriptions/ghes-3.10/ghes-3.10.json @@ -39148,14 +39148,6 @@ }, "insecure_ssl": { "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "token": { - "type": "string", - "example": "\"abc\"" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" } } }, @@ -39319,33 +39311,7 @@ "type": "object", "properties": { "config": { - "type": "object", - "description": "Key/value pairs to provide settings for this webhook.", - "properties": { - "url": { - "$ref": "#/components/schemas/webhook-config-url" - }, - "content_type": { - "$ref": "#/components/schemas/webhook-config-content-type" - }, - "secret": { - "$ref": "#/components/schemas/webhook-config-secret" - }, - "insecure_ssl": { - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "address": { - "type": "string", - "example": "\"bar@example.com\"" - }, - "room": { - "type": "string", - "example": "\"The Serious Room\"" - } - }, - "required": [ - "url" - ] + "$ref": "#/components/schemas/webhook-config" }, "events": { "type": "array", @@ -106863,45 +106829,7 @@ ] }, "config": { - "type": "object", - "properties": { - "email": { - "type": "string", - "example": "\"foo@bar.com\"" - }, - "password": { - "type": "string", - "example": "\"foo\"" - }, - "room": { - "type": "string", - "example": "\"roomer\"" - }, - "subdomain": { - "type": "string", - "example": "\"foo\"" - }, - "url": { - "$ref": "#/components/schemas/webhook-config-url" - }, - "insecure_ssl": { - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - }, - "content_type": { - "$ref": "#/components/schemas/webhook-config-content-type" - }, - "digest": { - "type": "string", - "example": "\"sha256\"" - }, - "secret": { - "$ref": "#/components/schemas/webhook-config-secret" - }, - "token": { - "type": "string", - "example": "\"abc\"" - } - } + "$ref": "#/components/schemas/webhook-config" }, "updated_at": { "type": "string", diff --git a/descriptions/ghes-3.10/ghes-3.10.yaml b/descriptions/ghes-3.10/ghes-3.10.yaml index ea75d8728..779f78ed9 100644 --- a/descriptions/ghes-3.10/ghes-3.10.yaml +++ b/descriptions/ghes-3.10/ghes-3.10.yaml @@ -28222,12 +28222,6 @@ paths: "$ref": "#/components/schemas/webhook-config-secret" insecure_ssl: "$ref": "#/components/schemas/webhook-config-insecure-ssl" - token: - type: string - example: '"abc"' - digest: - type: string - example: '"sha256"' events: type: array description: Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) @@ -28336,25 +28330,7 @@ paths: type: object properties: config: - type: object - description: Key/value pairs to provide settings for this webhook. - properties: - url: - "$ref": "#/components/schemas/webhook-config-url" - content_type: - "$ref": "#/components/schemas/webhook-config-content-type" - secret: - "$ref": "#/components/schemas/webhook-config-secret" - insecure_ssl: - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - address: - type: string - example: '"bar@example.com"' - room: - type: string - example: '"The Serious Room"' - required: - - url + "$ref": "#/components/schemas/webhook-config" events: type: array description: Determines what [events](https://docs.github.com/enterprise-server@3.10/webhooks/event-payloads) @@ -77244,34 +77220,7 @@ components: {"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}