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 48a1f24cef..7d757a7151 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 @@ -72695,6 +72695,99 @@ } } }, + "custom-property-promoted-to-enterprise": { + "post": { + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was promoted to an enterprise.", + "operationId": "custom-property/promote-to-enterprise", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "custom_property", + "supported-webhook-types": [ + "business", + "organization", + "app" + ] + } + } + }, "custom-property-updated": { "post": { "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", @@ -146403,6 +146496,37 @@ "definition" ] }, + "webhook-custom-property-promoted-to-enterprise": { + "title": "custom property promoted to business event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "promote_to_enterprise" + ] + }, + "definition": { + "$ref": "#/components/schemas/custom-property" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "definition" + ] + }, "webhook-custom-property-updated": { "title": "custom property updated event", "type": "object", 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 485f791fb5..a5b135be34 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 @@ -52776,6 +52776,72 @@ x-webhooks: - business - organization - app + custom-property-promoted-to-enterprise: + post: + summary: |- + This event occurs when there is activity relating to a custom property. + + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/rest/orgs/custom-properties)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. + description: A custom property was promoted to an enterprise. + operationId: custom-property/promote-to-enterprise + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: custom_property + supported-webhook-types: + - business + - organization + - app custom-property-updated: post: summary: |- @@ -108595,6 +108661,27 @@ components: required: - action - definition + webhook-custom-property-promoted-to-enterprise: + title: custom property promoted to business event + type: object + properties: + action: + type: string + enum: + - promote_to_enterprise + definition: + "$ref": "#/components/schemas/custom-property" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - definition webhook-custom-property-updated: title: custom property updated event type: object diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 48a1f24cef..7d757a7151 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -72695,6 +72695,99 @@ } } }, + "custom-property-promoted-to-enterprise": { + "post": { + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was promoted to an enterprise.", + "operationId": "custom-property/promote-to-enterprise", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "custom_property", + "supported-webhook-types": [ + "business", + "organization", + "app" + ] + } + } + }, "custom-property-updated": { "post": { "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", @@ -146403,6 +146496,37 @@ "definition" ] }, + "webhook-custom-property-promoted-to-enterprise": { + "title": "custom property promoted to business event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "promote_to_enterprise" + ] + }, + "definition": { + "$ref": "#/components/schemas/custom-property" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "definition" + ] + }, "webhook-custom-property-updated": { "title": "custom property updated event", "type": "object", diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 485f791fb5..a5b135be34 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -52776,6 +52776,72 @@ x-webhooks: - business - organization - app + custom-property-promoted-to-enterprise: + post: + summary: |- + This event occurs when there is activity relating to a custom property. + + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/rest/orgs/custom-properties)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. + description: A custom property was promoted to an enterprise. + operationId: custom-property/promote-to-enterprise + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: custom_property + supported-webhook-types: + - business + - organization + - app custom-property-updated: post: summary: |- @@ -108595,6 +108661,27 @@ components: required: - action - definition + webhook-custom-property-promoted-to-enterprise: + title: custom property promoted to business event + type: object + properties: + action: + type: string + enum: + - promote_to_enterprise + definition: + "$ref": "#/components/schemas/custom-property" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - definition webhook-custom-property-updated: title: custom property updated event type: object 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 b0763d6781..9dfafaf5cc 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 @@ -590505,6 +590505,482 @@ } } }, + "custom-property-promoted-to-enterprise": { + "post": { + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was promoted to an enterprise.", + "operationId": "custom-property/promote-to-enterprise", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "custom property promoted to business event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "promote_to_enterprise" + ] + }, + "definition": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "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" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "definition" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "custom_property", + "supported-webhook-types": [ + "business", + "organization", + "app" + ] + } + } + }, "custom-property-updated": { "post": { "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", 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 ccedac46fd..f5ae07b9fa 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 @@ -107204,6 +107204,86 @@ x-webhooks: - business - organization - app + custom-property-promoted-to-enterprise: + post: + summary: |- + This event occurs when there is activity relating to a custom property. + + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/rest/orgs/custom-properties)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. + description: A custom property was promoted to an enterprise. + operationId: custom-property/promote-to-enterprise + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: custom property promoted to business event + type: object + properties: + action: + type: string + enum: + - promote_to_enterprise + definition: *227 + enterprise: *650 + installation: *651 + organization: *652 + sender: *4 + required: + - action + - definition + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: custom_property + supported-webhook-types: + - business + - organization + - app custom-property-updated: post: summary: |- 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 b0763d6781..9dfafaf5cc 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -590505,6 +590505,482 @@ } } }, + "custom-property-promoted-to-enterprise": { + "post": { + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was promoted to an enterprise.", + "operationId": "custom-property/promote-to-enterprise", + "externalDocs": { + "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "custom property promoted to business event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "promote_to_enterprise" + ] + }, + "definition": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "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" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "definition" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "custom_property", + "supported-webhook-types": [ + "business", + "organization", + "app" + ] + } + } + }, "custom-property-updated": { "post": { "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", 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 ccedac46fd..f5ae07b9fa 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -107204,6 +107204,86 @@ x-webhooks: - business - organization - app + custom-property-promoted-to-enterprise: + post: + summary: |- + This event occurs when there is activity relating to a custom property. + + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/rest/orgs/custom-properties)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. + description: A custom property was promoted to an enterprise. + operationId: custom-property/promote-to-enterprise + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: custom property promoted to business event + type: object + properties: + action: + type: string + enum: + - promote_to_enterprise + definition: *227 + enterprise: *650 + installation: *651 + organization: *652 + sender: *4 + required: + - action + - definition + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: custom_property + supported-webhook-types: + - business + - organization + - app custom-property-updated: post: summary: |- diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index 89beba3190..b57712bc87 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -36485,7 +36485,7 @@ "/enterprises/{enterprise}/properties/schema": { "get": { "summary": "Get custom properties for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all custom properties defined for an enterprise.\nEnterprise members can read these properties.", + "description": "Gets all custom properties defined for an enterprise.\nEnterprise members can read these properties.", "tags": [ "enterprise-admin" ], @@ -36695,7 +36695,7 @@ }, "patch": { "summary": "Create or update custom properties for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates new or updates existing custom properties defined for an enterprise in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "description": "Creates new or updates existing custom properties defined for an enterprise in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ "enterprise-admin" ], @@ -37041,7 +37041,7 @@ "/enterprises/{enterprise}/properties/schema/organizations/{org}/{custom_property_name}/promote": { "put": { "summary": "Promote a custom property to an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPromotes an existing organization custom property to an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "description": "Promotes an existing organization custom property to an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ "enterprise-admin" ], @@ -37252,7 +37252,7 @@ "/enterprises/{enterprise}/properties/schema/{custom_property_name}": { "get": { "summary": "Get a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.", + "description": "Gets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.", "tags": [ "enterprise-admin" ], @@ -37452,7 +37452,7 @@ }, "put": { "summary": "Create or update a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new or updates an existing custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "description": "Creates a new or updates an existing custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ "enterprise-admin" ], @@ -37738,7 +37738,7 @@ }, "delete": { "summary": "Remove a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemove a custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "description": "Remove a custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ "enterprise-admin" ], @@ -656868,6 +656868,482 @@ } } }, + "custom-property-promoted-to-enterprise": { + "post": { + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was promoted to an enterprise.", + "operationId": "custom-property/promote-to-enterprise", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "custom property promoted to business event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "promote_to_enterprise" + ] + }, + "definition": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "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" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "definition" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "custom_property", + "supported-webhook-types": [ + "business", + "organization", + "app" + ] + } + } + }, "custom-property-updated": { "post": { "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index af4261c3ee..aee526e6ae 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -15780,9 +15780,6 @@ paths: get: summary: Get custom properties for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Gets all custom properties defined for an enterprise. Enterprise members can read these properties. tags: @@ -15898,9 +15895,6 @@ paths: patch: summary: Create or update custom properties for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Creates new or updates existing custom properties defined for an enterprise in a batch. If the property already exists, the existing property will be replaced with the new values. @@ -15970,9 +15964,6 @@ paths: put: summary: Promote a custom property to an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Promotes an existing organization custom property to an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise. @@ -16028,9 +16019,6 @@ paths: get: summary: Get a custom property for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Gets a custom property that is defined for an enterprise. Enterprise members can read these properties. tags: @@ -16060,9 +16048,6 @@ paths: put: summary: Create or update a custom property for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Creates a new or updates an existing custom property that is defined for an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise. @@ -16156,9 +16141,6 @@ paths: delete: summary: Remove a custom property for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Remove a custom property that is defined for an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise. @@ -118639,6 +118621,86 @@ x-webhooks: - business - organization - app + custom-property-promoted-to-enterprise: + post: + summary: |- + This event occurs when there is activity relating to a custom property. + + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. + description: A custom property was promoted to an enterprise. + operationId: custom-property/promote-to-enterprise + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: custom property promoted to business event + type: object + properties: + action: + type: string + enum: + - promote_to_enterprise + definition: *114 + enterprise: *754 + installation: *755 + organization: *756 + sender: *4 + required: + - action + - definition + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: custom_property + supported-webhook-types: + - business + - organization + - app custom-property-updated: post: summary: |- diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index 89beba3190..b57712bc87 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -36485,7 +36485,7 @@ "/enterprises/{enterprise}/properties/schema": { "get": { "summary": "Get custom properties for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all custom properties defined for an enterprise.\nEnterprise members can read these properties.", + "description": "Gets all custom properties defined for an enterprise.\nEnterprise members can read these properties.", "tags": [ "enterprise-admin" ], @@ -36695,7 +36695,7 @@ }, "patch": { "summary": "Create or update custom properties for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates new or updates existing custom properties defined for an enterprise in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "description": "Creates new or updates existing custom properties defined for an enterprise in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ "enterprise-admin" ], @@ -37041,7 +37041,7 @@ "/enterprises/{enterprise}/properties/schema/organizations/{org}/{custom_property_name}/promote": { "put": { "summary": "Promote a custom property to an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPromotes an existing organization custom property to an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "description": "Promotes an existing organization custom property to an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ "enterprise-admin" ], @@ -37252,7 +37252,7 @@ "/enterprises/{enterprise}/properties/schema/{custom_property_name}": { "get": { "summary": "Get a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.", + "description": "Gets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.", "tags": [ "enterprise-admin" ], @@ -37452,7 +37452,7 @@ }, "put": { "summary": "Create or update a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new or updates an existing custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "description": "Creates a new or updates an existing custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ "enterprise-admin" ], @@ -37738,7 +37738,7 @@ }, "delete": { "summary": "Remove a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemove a custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "description": "Remove a custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ "enterprise-admin" ], @@ -656868,6 +656868,482 @@ } } }, + "custom-property-promoted-to-enterprise": { + "post": { + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was promoted to an enterprise.", + "operationId": "custom-property/promote-to-enterprise", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "custom property promoted to business event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "promote_to_enterprise" + ] + }, + "definition": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "example": "organization" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "nullable": true, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "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" + ] + }, + "enterprise": { + "title": "Enterprise", + "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest//admin/overview/about-enterprise-accounts).\"", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + }, + "installation": { + "title": "Simple Installation", + "description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest//apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).\"", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "node_id": { + "description": "The global node ID of the installation.", + "type": "string", + "example": "MDQ6VXNlcjU4MzIzMQ==" + } + }, + "required": [ + "id", + "node_id" + ] + }, + "organization": { + "title": "Organization Simple", + "description": "A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an\norganization, or when the event occurs from activity in a repository owned by an organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "sender": { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "nullable": true, + "type": "string" + }, + "email": { + "nullable": true, + "type": "string" + }, + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "format": "int64", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + }, + "user_view_type": { + "type": "string", + "example": "public" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + }, + "required": [ + "action", + "definition" + ] + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "custom_property", + "supported-webhook-types": [ + "business", + "organization", + "app" + ] + } + } + }, "custom-property-updated": { "post": { "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index af4261c3ee..aee526e6ae 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -15780,9 +15780,6 @@ paths: get: summary: Get custom properties for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Gets all custom properties defined for an enterprise. Enterprise members can read these properties. tags: @@ -15898,9 +15895,6 @@ paths: patch: summary: Create or update custom properties for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Creates new or updates existing custom properties defined for an enterprise in a batch. If the property already exists, the existing property will be replaced with the new values. @@ -15970,9 +15964,6 @@ paths: put: summary: Promote a custom property to an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Promotes an existing organization custom property to an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise. @@ -16028,9 +16019,6 @@ paths: get: summary: Get a custom property for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Gets a custom property that is defined for an enterprise. Enterprise members can read these properties. tags: @@ -16060,9 +16048,6 @@ paths: put: summary: Create or update a custom property for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Creates a new or updates an existing custom property that is defined for an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise. @@ -16156,9 +16141,6 @@ paths: delete: summary: Remove a custom property for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Remove a custom property that is defined for an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise. @@ -118639,6 +118621,86 @@ x-webhooks: - business - organization - app + custom-property-promoted-to-enterprise: + post: + summary: |- + This event occurs when there is activity relating to a custom property. + + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. + description: A custom property was promoted to an enterprise. + operationId: custom-property/promote-to-enterprise + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + title: custom property promoted to business event + type: object + properties: + action: + type: string + enum: + - promote_to_enterprise + definition: *114 + enterprise: *754 + installation: *755 + organization: *756 + sender: *4 + required: + - action + - definition + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: custom_property + supported-webhook-types: + - business + - organization + - app custom-property-updated: post: summary: |- diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 9fb8cc3bdd..5d7b47e9aa 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -7415,7 +7415,7 @@ "/enterprises/{enterprise}/properties/schema": { "get": { "summary": "Get custom properties for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all custom properties defined for an enterprise.\nEnterprise members can read these properties.", + "description": "Gets all custom properties defined for an enterprise.\nEnterprise members can read these properties.", "tags": [ "enterprise-admin" ], @@ -7464,7 +7464,7 @@ }, "patch": { "summary": "Create or update custom properties for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates new or updates existing custom properties defined for an enterprise in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "description": "Creates new or updates existing custom properties defined for an enterprise in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ "enterprise-admin" ], @@ -7568,7 +7568,7 @@ "/enterprises/{enterprise}/properties/schema/organizations/{org}/{custom_property_name}/promote": { "put": { "summary": "Promote a custom property to an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPromotes an existing organization custom property to an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "description": "Promotes an existing organization custom property to an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ "enterprise-admin" ], @@ -7622,7 +7622,7 @@ "/enterprises/{enterprise}/properties/schema/{custom_property_name}": { "get": { "summary": "Get a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.", + "description": "Gets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.", "tags": [ "enterprise-admin" ], @@ -7671,7 +7671,7 @@ }, "put": { "summary": "Create or update a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new or updates an existing custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "description": "Creates a new or updates an existing custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ "enterprise-admin" ], @@ -7744,7 +7744,7 @@ }, "delete": { "summary": "Remove a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemove a custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "description": "Remove a custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ "enterprise-admin" ], @@ -83716,6 +83716,99 @@ } } }, + "custom-property-promoted-to-enterprise": { + "post": { + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was promoted to an enterprise.", + "operationId": "custom-property/promote-to-enterprise", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "custom_property", + "supported-webhook-types": [ + "business", + "organization", + "app" + ] + } + } + }, "custom-property-updated": { "post": { "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", @@ -161806,6 +161899,37 @@ "definition" ] }, + "webhook-custom-property-promoted-to-enterprise": { + "title": "custom property promoted to business event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "promote_to_enterprise" + ] + }, + "definition": { + "$ref": "#/components/schemas/custom-property" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "definition" + ] + }, "webhook-custom-property-updated": { "title": "custom property updated event", "type": "object", diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index e180fb3acf..1fe413745a 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -5290,9 +5290,6 @@ paths: get: summary: Get custom properties for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Gets all custom properties defined for an enterprise. Enterprise members can read these properties. tags: @@ -5327,9 +5324,6 @@ paths: patch: summary: Create or update custom properties for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Creates new or updates existing custom properties defined for an enterprise in a batch. If the property already exists, the existing property will be replaced with the new values. @@ -5404,9 +5398,6 @@ paths: put: summary: Promote a custom property to an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Promotes an existing organization custom property to an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise. @@ -5443,9 +5434,6 @@ paths: get: summary: Get a custom property for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Gets a custom property that is defined for an enterprise. Enterprise members can read these properties. tags: @@ -5479,9 +5467,6 @@ paths: put: summary: Create or update a custom property for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Creates a new or updates an existing custom property that is defined for an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise. @@ -5532,9 +5517,6 @@ paths: delete: summary: Remove a custom property for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Remove a custom property that is defined for an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise. @@ -60712,6 +60694,72 @@ x-webhooks: - business - organization - app + custom-property-promoted-to-enterprise: + post: + summary: |- + This event occurs when there is activity relating to a custom property. + + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. + description: A custom property was promoted to an enterprise. + operationId: custom-property/promote-to-enterprise + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: custom_property + supported-webhook-types: + - business + - organization + - app custom-property-updated: post: summary: |- @@ -119804,6 +119852,27 @@ components: required: - action - definition + webhook-custom-property-promoted-to-enterprise: + title: custom property promoted to business event + type: object + properties: + action: + type: string + enum: + - promote_to_enterprise + definition: + "$ref": "#/components/schemas/custom-property" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - definition webhook-custom-property-updated: title: custom property updated event type: object diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index 9fb8cc3bdd..5d7b47e9aa 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -7415,7 +7415,7 @@ "/enterprises/{enterprise}/properties/schema": { "get": { "summary": "Get custom properties for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets all custom properties defined for an enterprise.\nEnterprise members can read these properties.", + "description": "Gets all custom properties defined for an enterprise.\nEnterprise members can read these properties.", "tags": [ "enterprise-admin" ], @@ -7464,7 +7464,7 @@ }, "patch": { "summary": "Create or update custom properties for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates new or updates existing custom properties defined for an enterprise in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "description": "Creates new or updates existing custom properties defined for an enterprise in a batch.\n\nIf the property already exists, the existing property will be replaced with the new values.\nMissing optional values will fall back to default values, previous values will be overwritten.\nE.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ "enterprise-admin" ], @@ -7568,7 +7568,7 @@ "/enterprises/{enterprise}/properties/schema/organizations/{org}/{custom_property_name}/promote": { "put": { "summary": "Promote a custom property to an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nPromotes an existing organization custom property to an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "description": "Promotes an existing organization custom property to an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ "enterprise-admin" ], @@ -7622,7 +7622,7 @@ "/enterprises/{enterprise}/properties/schema/{custom_property_name}": { "get": { "summary": "Get a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.", + "description": "Gets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.", "tags": [ "enterprise-admin" ], @@ -7671,7 +7671,7 @@ }, "put": { "summary": "Create or update a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new or updates an existing custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "description": "Creates a new or updates an existing custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ "enterprise-admin" ], @@ -7744,7 +7744,7 @@ }, "delete": { "summary": "Remove a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemove a custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "description": "Remove a custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", "tags": [ "enterprise-admin" ], @@ -83716,6 +83716,99 @@ } } }, + "custom-property-promoted-to-enterprise": { + "post": { + "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", + "description": "A custom property was promoted to an enterprise.", + "operationId": "custom-property/promote-to-enterprise", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "custom_property", + "supported-webhook-types": [ + "business", + "organization", + "app" + ] + } + } + }, "custom-property-updated": { "post": { "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", @@ -161806,6 +161899,37 @@ "definition" ] }, + "webhook-custom-property-promoted-to-enterprise": { + "title": "custom property promoted to business event", + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "promote_to_enterprise" + ] + }, + "definition": { + "$ref": "#/components/schemas/custom-property" + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user" + } + }, + "required": [ + "action", + "definition" + ] + }, "webhook-custom-property-updated": { "title": "custom property updated event", "type": "object", diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index e180fb3acf..1fe413745a 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -5290,9 +5290,6 @@ paths: get: summary: Get custom properties for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Gets all custom properties defined for an enterprise. Enterprise members can read these properties. tags: @@ -5327,9 +5324,6 @@ paths: patch: summary: Create or update custom properties for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Creates new or updates existing custom properties defined for an enterprise in a batch. If the property already exists, the existing property will be replaced with the new values. @@ -5404,9 +5398,6 @@ paths: put: summary: Promote a custom property to an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Promotes an existing organization custom property to an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise. @@ -5443,9 +5434,6 @@ paths: get: summary: Get a custom property for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Gets a custom property that is defined for an enterprise. Enterprise members can read these properties. tags: @@ -5479,9 +5467,6 @@ paths: put: summary: Create or update a custom property for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Creates a new or updates an existing custom property that is defined for an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise. @@ -5532,9 +5517,6 @@ paths: delete: summary: Remove a custom property for an enterprise description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - Remove a custom property that is defined for an enterprise. To use this endpoint, the authenticated user must be an administrator for the enterprise. @@ -60712,6 +60694,72 @@ x-webhooks: - business - organization - app + custom-property-promoted-to-enterprise: + post: + summary: |- + This event occurs when there is activity relating to a custom property. + + For more information, see "[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)". For information about the APIs to manage custom properties, see "[Custom properties](https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties)" in the REST API documentation. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission. + description: A custom property was promoted to an enterprise. + operationId: custom-property/promote-to-enterprise + externalDocs: + url: https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#custom_property + parameters: + - name: User-Agent + in: header + example: GitHub-Hookshot/123abc + schema: + type: string + - name: X-Github-Hook-Id + in: header + example: 12312312 + schema: + type: string + - name: X-Github-Event + in: header + example: issues + schema: + type: string + - name: X-Github-Hook-Installation-Target-Id + in: header + example: 123123 + schema: + type: string + - name: X-Github-Hook-Installation-Target-Type + in: header + example: repository + schema: + type: string + - name: X-GitHub-Delivery + in: header + example: 0b989ba4-242f-11e5-81e1-c7b6966d2516 + schema: + type: string + - name: X-Hub-Signature-256 + in: header + example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: custom_property + supported-webhook-types: + - business + - organization + - app custom-property-updated: post: summary: |- @@ -119804,6 +119852,27 @@ components: required: - action - definition + webhook-custom-property-promoted-to-enterprise: + title: custom property promoted to business event + type: object + properties: + action: + type: string + enum: + - promote_to_enterprise + definition: + "$ref": "#/components/schemas/custom-property" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + sender: + "$ref": "#/components/schemas/simple-user" + required: + - action + - definition webhook-custom-property-updated: title: custom property updated event type: object