Skip to content

Commit 1e19764

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.1 Descriptions
1 parent dd7e0ca commit 1e19764

16 files changed

+3544
-96
lines changed

‎descriptions-next/api.github.com/api.github.com.2022-11-28.json‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73052,6 +73052,99 @@
7305273052
}
7305373053
}
7305473054
},
73055+
"custom-property-promoted-to-enterprise": {
73056+
"post": {
73057+
"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.",
73058+
"description": "A custom property was promoted to an enterprise.",
73059+
"operationId": "custom-property/promote-to-enterprise",
73060+
"externalDocs": {
73061+
"url": "https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property"
73062+
},
73063+
"parameters": [
73064+
{
73065+
"name": "User-Agent",
73066+
"in": "header",
73067+
"example": "GitHub-Hookshot/123abc",
73068+
"schema": {
73069+
"type": "string"
73070+
}
73071+
},
73072+
{
73073+
"name": "X-Github-Hook-Id",
73074+
"in": "header",
73075+
"example": 12312312,
73076+
"schema": {
73077+
"type": "string"
73078+
}
73079+
},
73080+
{
73081+
"name": "X-Github-Event",
73082+
"in": "header",
73083+
"example": "issues",
73084+
"schema": {
73085+
"type": "string"
73086+
}
73087+
},
73088+
{
73089+
"name": "X-Github-Hook-Installation-Target-Id",
73090+
"in": "header",
73091+
"example": 123123,
73092+
"schema": {
73093+
"type": "string"
73094+
}
73095+
},
73096+
{
73097+
"name": "X-Github-Hook-Installation-Target-Type",
73098+
"in": "header",
73099+
"example": "repository",
73100+
"schema": {
73101+
"type": "string"
73102+
}
73103+
},
73104+
{
73105+
"name": "X-GitHub-Delivery",
73106+
"in": "header",
73107+
"example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
73108+
"schema": {
73109+
"type": "string"
73110+
}
73111+
},
73112+
{
73113+
"name": "X-Hub-Signature-256",
73114+
"in": "header",
73115+
"example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
73116+
"schema": {
73117+
"type": "string"
73118+
}
73119+
}
73120+
],
73121+
"requestBody": {
73122+
"required": true,
73123+
"content": {
73124+
"application/json": {
73125+
"schema": {
73126+
"$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise"
73127+
}
73128+
}
73129+
}
73130+
},
73131+
"responses": {
73132+
"200": {
73133+
"description": "Return a 200 status to indicate that the data was received successfully"
73134+
}
73135+
},
73136+
"x-github": {
73137+
"githubCloudOnly": false,
73138+
"category": "webhooks",
73139+
"subcategory": "custom_property",
73140+
"supported-webhook-types": [
73141+
"business",
73142+
"organization",
73143+
"app"
73144+
]
73145+
}
73146+
}
73147+
},
7305573148
"custom-property-updated": {
7305673149
"post": {
7305773150
"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.",
@@ -150612,6 +150705,37 @@
150612150705
"definition"
150613150706
]
150614150707
},
150708+
"webhook-custom-property-promoted-to-enterprise": {
150709+
"title": "custom property promoted to business event",
150710+
"type": "object",
150711+
"properties": {
150712+
"action": {
150713+
"type": "string",
150714+
"enum": [
150715+
"promote_to_enterprise"
150716+
]
150717+
},
150718+
"definition": {
150719+
"$ref": "#/components/schemas/custom-property"
150720+
},
150721+
"enterprise": {
150722+
"$ref": "#/components/schemas/enterprise-webhooks"
150723+
},
150724+
"installation": {
150725+
"$ref": "#/components/schemas/simple-installation"
150726+
},
150727+
"organization": {
150728+
"$ref": "#/components/schemas/organization-simple-webhooks"
150729+
},
150730+
"sender": {
150731+
"$ref": "#/components/schemas/simple-user"
150732+
}
150733+
},
150734+
"required": [
150735+
"action",
150736+
"definition"
150737+
]
150738+
},
150615150739
"webhook-custom-property-updated": {
150616150740
"title": "custom property updated event",
150617150741
"type": "object",

‎descriptions-next/api.github.com/api.github.com.2022-11-28.yaml‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52954,6 +52954,72 @@ webhooks:
5295452954
- business
5295552955
- organization
5295652956
- app
52957+
custom-property-promoted-to-enterprise:
52958+
post:
52959+
summary: |-
52960+
This event occurs when there is activity relating to a custom property.
52961+
52962+
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.
52963+
52964+
To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission.
52965+
description: A custom property was promoted to an enterprise.
52966+
operationId: custom-property/promote-to-enterprise
52967+
externalDocs:
52968+
url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property
52969+
parameters:
52970+
- name: User-Agent
52971+
in: header
52972+
example: GitHub-Hookshot/123abc
52973+
schema:
52974+
type: string
52975+
- name: X-Github-Hook-Id
52976+
in: header
52977+
example: 12312312
52978+
schema:
52979+
type: string
52980+
- name: X-Github-Event
52981+
in: header
52982+
example: issues
52983+
schema:
52984+
type: string
52985+
- name: X-Github-Hook-Installation-Target-Id
52986+
in: header
52987+
example: 123123
52988+
schema:
52989+
type: string
52990+
- name: X-Github-Hook-Installation-Target-Type
52991+
in: header
52992+
example: repository
52993+
schema:
52994+
type: string
52995+
- name: X-GitHub-Delivery
52996+
in: header
52997+
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
52998+
schema:
52999+
type: string
53000+
- name: X-Hub-Signature-256
53001+
in: header
53002+
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
53003+
schema:
53004+
type: string
53005+
requestBody:
53006+
required: true
53007+
content:
53008+
application/json:
53009+
schema:
53010+
"$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise"
53011+
responses:
53012+
'200':
53013+
description: Return a 200 status to indicate that the data was received
53014+
successfully
53015+
x-github:
53016+
githubCloudOnly: false
53017+
category: webhooks
53018+
subcategory: custom_property
53019+
supported-webhook-types:
53020+
- business
53021+
- organization
53022+
- app
5295753023
custom-property-updated:
5295853024
post:
5295953025
summary: |-
@@ -109598,6 +109664,27 @@ components:
109598109664
required:
109599109665
- action
109600109666
- definition
109667+
webhook-custom-property-promoted-to-enterprise:
109668+
title: custom property promoted to business event
109669+
type: object
109670+
properties:
109671+
action:
109672+
type: string
109673+
enum:
109674+
- promote_to_enterprise
109675+
definition:
109676+
"$ref": "#/components/schemas/custom-property"
109677+
enterprise:
109678+
"$ref": "#/components/schemas/enterprise-webhooks"
109679+
installation:
109680+
"$ref": "#/components/schemas/simple-installation"
109681+
organization:
109682+
"$ref": "#/components/schemas/organization-simple-webhooks"
109683+
sender:
109684+
"$ref": "#/components/schemas/simple-user"
109685+
required:
109686+
- action
109687+
- definition
109601109688
webhook-custom-property-updated:
109602109689
title: custom property updated event
109603109690
type: object

‎descriptions-next/api.github.com/api.github.com.json‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73052,6 +73052,99 @@
7305273052
}
7305373053
}
7305473054
},
73055+
"custom-property-promoted-to-enterprise": {
73056+
"post": {
73057+
"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.",
73058+
"description": "A custom property was promoted to an enterprise.",
73059+
"operationId": "custom-property/promote-to-enterprise",
73060+
"externalDocs": {
73061+
"url": "https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property"
73062+
},
73063+
"parameters": [
73064+
{
73065+
"name": "User-Agent",
73066+
"in": "header",
73067+
"example": "GitHub-Hookshot/123abc",
73068+
"schema": {
73069+
"type": "string"
73070+
}
73071+
},
73072+
{
73073+
"name": "X-Github-Hook-Id",
73074+
"in": "header",
73075+
"example": 12312312,
73076+
"schema": {
73077+
"type": "string"
73078+
}
73079+
},
73080+
{
73081+
"name": "X-Github-Event",
73082+
"in": "header",
73083+
"example": "issues",
73084+
"schema": {
73085+
"type": "string"
73086+
}
73087+
},
73088+
{
73089+
"name": "X-Github-Hook-Installation-Target-Id",
73090+
"in": "header",
73091+
"example": 123123,
73092+
"schema": {
73093+
"type": "string"
73094+
}
73095+
},
73096+
{
73097+
"name": "X-Github-Hook-Installation-Target-Type",
73098+
"in": "header",
73099+
"example": "repository",
73100+
"schema": {
73101+
"type": "string"
73102+
}
73103+
},
73104+
{
73105+
"name": "X-GitHub-Delivery",
73106+
"in": "header",
73107+
"example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
73108+
"schema": {
73109+
"type": "string"
73110+
}
73111+
},
73112+
{
73113+
"name": "X-Hub-Signature-256",
73114+
"in": "header",
73115+
"example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
73116+
"schema": {
73117+
"type": "string"
73118+
}
73119+
}
73120+
],
73121+
"requestBody": {
73122+
"required": true,
73123+
"content": {
73124+
"application/json": {
73125+
"schema": {
73126+
"$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise"
73127+
}
73128+
}
73129+
}
73130+
},
73131+
"responses": {
73132+
"200": {
73133+
"description": "Return a 200 status to indicate that the data was received successfully"
73134+
}
73135+
},
73136+
"x-github": {
73137+
"githubCloudOnly": false,
73138+
"category": "webhooks",
73139+
"subcategory": "custom_property",
73140+
"supported-webhook-types": [
73141+
"business",
73142+
"organization",
73143+
"app"
73144+
]
73145+
}
73146+
}
73147+
},
7305573148
"custom-property-updated": {
7305673149
"post": {
7305773150
"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.",
@@ -150612,6 +150705,37 @@
150612150705
"definition"
150613150706
]
150614150707
},
150708+
"webhook-custom-property-promoted-to-enterprise": {
150709+
"title": "custom property promoted to business event",
150710+
"type": "object",
150711+
"properties": {
150712+
"action": {
150713+
"type": "string",
150714+
"enum": [
150715+
"promote_to_enterprise"
150716+
]
150717+
},
150718+
"definition": {
150719+
"$ref": "#/components/schemas/custom-property"
150720+
},
150721+
"enterprise": {
150722+
"$ref": "#/components/schemas/enterprise-webhooks"
150723+
},
150724+
"installation": {
150725+
"$ref": "#/components/schemas/simple-installation"
150726+
},
150727+
"organization": {
150728+
"$ref": "#/components/schemas/organization-simple-webhooks"
150729+
},
150730+
"sender": {
150731+
"$ref": "#/components/schemas/simple-user"
150732+
}
150733+
},
150734+
"required": [
150735+
"action",
150736+
"definition"
150737+
]
150738+
},
150615150739
"webhook-custom-property-updated": {
150616150740
"title": "custom property updated event",
150617150741
"type": "object",

0 commit comments

Comments
 (0)