Skip to content

Update OpenAPI 3.0 Descriptions #4666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update OpenAPI 3.0 Descriptions #4666

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 124 additions & 0 deletions descriptions/api.github.com/api.github.com.2022-11-28.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
Expand Down Expand Up @@ -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",
Expand Down
87 changes: 87 additions & 0 deletions descriptions/api.github.com/api.github.com.2022-11-28.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: |-
Expand Down Expand Up @@ -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
Expand Down
124 changes: 124 additions & 0 deletions descriptions/api.github.com/api.github.com.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
Expand Down Expand Up @@ -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",
Expand Down
Loading