Skip to content

Commit 2cbb3d0

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.0 Descriptions
1 parent dd7e0ca commit 2cbb3d0

16 files changed

+3092
-96
lines changed

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

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72695,6 +72695,99 @@
7269572695
}
7269672696
}
7269772697
},
72698+
"custom-property-promoted-to-enterprise": {
72699+
"post": {
72700+
"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.",
72701+
"description": "A custom property was promoted to an enterprise.",
72702+
"operationId": "custom-property/promote-to-enterprise",
72703+
"externalDocs": {
72704+
"url": "https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property"
72705+
},
72706+
"parameters": [
72707+
{
72708+
"name": "User-Agent",
72709+
"in": "header",
72710+
"example": "GitHub-Hookshot/123abc",
72711+
"schema": {
72712+
"type": "string"
72713+
}
72714+
},
72715+
{
72716+
"name": "X-Github-Hook-Id",
72717+
"in": "header",
72718+
"example": 12312312,
72719+
"schema": {
72720+
"type": "string"
72721+
}
72722+
},
72723+
{
72724+
"name": "X-Github-Event",
72725+
"in": "header",
72726+
"example": "issues",
72727+
"schema": {
72728+
"type": "string"
72729+
}
72730+
},
72731+
{
72732+
"name": "X-Github-Hook-Installation-Target-Id",
72733+
"in": "header",
72734+
"example": 123123,
72735+
"schema": {
72736+
"type": "string"
72737+
}
72738+
},
72739+
{
72740+
"name": "X-Github-Hook-Installation-Target-Type",
72741+
"in": "header",
72742+
"example": "repository",
72743+
"schema": {
72744+
"type": "string"
72745+
}
72746+
},
72747+
{
72748+
"name": "X-GitHub-Delivery",
72749+
"in": "header",
72750+
"example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
72751+
"schema": {
72752+
"type": "string"
72753+
}
72754+
},
72755+
{
72756+
"name": "X-Hub-Signature-256",
72757+
"in": "header",
72758+
"example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
72759+
"schema": {
72760+
"type": "string"
72761+
}
72762+
}
72763+
],
72764+
"requestBody": {
72765+
"required": true,
72766+
"content": {
72767+
"application/json": {
72768+
"schema": {
72769+
"$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise"
72770+
}
72771+
}
72772+
}
72773+
},
72774+
"responses": {
72775+
"200": {
72776+
"description": "Return a 200 status to indicate that the data was received successfully"
72777+
}
72778+
},
72779+
"x-github": {
72780+
"githubCloudOnly": false,
72781+
"category": "webhooks",
72782+
"subcategory": "custom_property",
72783+
"supported-webhook-types": [
72784+
"business",
72785+
"organization",
72786+
"app"
72787+
]
72788+
}
72789+
}
72790+
},
7269872791
"custom-property-updated": {
7269972792
"post": {
7270072793
"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 @@
146403146496
"definition"
146404146497
]
146405146498
},
146499+
"webhook-custom-property-promoted-to-enterprise": {
146500+
"title": "custom property promoted to business event",
146501+
"type": "object",
146502+
"properties": {
146503+
"action": {
146504+
"type": "string",
146505+
"enum": [
146506+
"promote_to_enterprise"
146507+
]
146508+
},
146509+
"definition": {
146510+
"$ref": "#/components/schemas/custom-property"
146511+
},
146512+
"enterprise": {
146513+
"$ref": "#/components/schemas/enterprise-webhooks"
146514+
},
146515+
"installation": {
146516+
"$ref": "#/components/schemas/simple-installation"
146517+
},
146518+
"organization": {
146519+
"$ref": "#/components/schemas/organization-simple-webhooks"
146520+
},
146521+
"sender": {
146522+
"$ref": "#/components/schemas/simple-user"
146523+
}
146524+
},
146525+
"required": [
146526+
"action",
146527+
"definition"
146528+
]
146529+
},
146406146530
"webhook-custom-property-updated": {
146407146531
"title": "custom property updated event",
146408146532
"type": "object",

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

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52776,6 +52776,72 @@ x-webhooks:
5277652776
- business
5277752777
- organization
5277852778
- app
52779+
custom-property-promoted-to-enterprise:
52780+
post:
52781+
summary: |-
52782+
This event occurs when there is activity relating to a custom property.
52783+
52784+
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.
52785+
52786+
To subscribe to this event, a GitHub App must have at least read-level access for the "Custom properties" organization permission.
52787+
description: A custom property was promoted to an enterprise.
52788+
operationId: custom-property/promote-to-enterprise
52789+
externalDocs:
52790+
url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom_property
52791+
parameters:
52792+
- name: User-Agent
52793+
in: header
52794+
example: GitHub-Hookshot/123abc
52795+
schema:
52796+
type: string
52797+
- name: X-Github-Hook-Id
52798+
in: header
52799+
example: 12312312
52800+
schema:
52801+
type: string
52802+
- name: X-Github-Event
52803+
in: header
52804+
example: issues
52805+
schema:
52806+
type: string
52807+
- name: X-Github-Hook-Installation-Target-Id
52808+
in: header
52809+
example: 123123
52810+
schema:
52811+
type: string
52812+
- name: X-Github-Hook-Installation-Target-Type
52813+
in: header
52814+
example: repository
52815+
schema:
52816+
type: string
52817+
- name: X-GitHub-Delivery
52818+
in: header
52819+
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
52820+
schema:
52821+
type: string
52822+
- name: X-Hub-Signature-256
52823+
in: header
52824+
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
52825+
schema:
52826+
type: string
52827+
requestBody:
52828+
required: true
52829+
content:
52830+
application/json:
52831+
schema:
52832+
"$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise"
52833+
responses:
52834+
'200':
52835+
description: Return a 200 status to indicate that the data was received
52836+
successfully
52837+
x-github:
52838+
githubCloudOnly: false
52839+
category: webhooks
52840+
subcategory: custom_property
52841+
supported-webhook-types:
52842+
- business
52843+
- organization
52844+
- app
5277952845
custom-property-updated:
5278052846
post:
5278152847
summary: |-
@@ -108595,6 +108661,27 @@ components:
108595108661
required:
108596108662
- action
108597108663
- definition
108664+
webhook-custom-property-promoted-to-enterprise:
108665+
title: custom property promoted to business event
108666+
type: object
108667+
properties:
108668+
action:
108669+
type: string
108670+
enum:
108671+
- promote_to_enterprise
108672+
definition:
108673+
"$ref": "#/components/schemas/custom-property"
108674+
enterprise:
108675+
"$ref": "#/components/schemas/enterprise-webhooks"
108676+
installation:
108677+
"$ref": "#/components/schemas/simple-installation"
108678+
organization:
108679+
"$ref": "#/components/schemas/organization-simple-webhooks"
108680+
sender:
108681+
"$ref": "#/components/schemas/simple-user"
108682+
required:
108683+
- action
108684+
- definition
108598108685
webhook-custom-property-updated:
108599108686
title: custom property updated event
108600108687
type: object

0 commit comments

Comments
 (0)