Merge pull request #3146 from github/openapi-update-b8fbb5dd543ec9a2a…

…afde890e33b61ad1a398a894be4f71797460c77af7bf3cd Update OpenAPI 3.1 Descriptions
github · Oct 31, 2023 · 745b866 · 745b866
2 parents 6c17641 + 29ed26d
commit 745b866
Show file tree

Hide file tree

Showing 16 changed files with 19,180 additions and 0 deletions.
diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json
diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml
@@ -45892,6 +45892,267 @@ webhooks:
         - repository
         - organization
         - app
+  custom-property-created:
+    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/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 new custom property was created.
+      operationId: custom-property/created
+      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-created"
+      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:
+        - organization
+        - app
+  custom-property-deleted:
+    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/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 deleted.
+      operationId: custom-property/deleted
+      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-deleted"
+      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:
+        - organization
+        - app
+  custom-property-updated:
+    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/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 updated.
+      operationId: custom-property/updated
+      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-updated"
+      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:
+        - organization
+        - app
+  custom-property-values-updated:
+    post:
+      summary: |-
+        This event occurs when there is activity relating to custom property values for a repository.
+
+        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 for a repository, see "[Custom properties](https://docs.github.com/rest/repos/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: The custom property values of a repository were updated.
+      operationId: custom-property-values/updated
+      externalDocs:
+        url: https://docs.github.com/webhooks/webhook-events-and-payloads#custom-property-values
+      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-values-updated"
+      responses:
+        '200':
+          description: Return a 200 status to indicate that the data was received
+            successfully
+      x-github:
+        githubCloudOnly: false
+        category: webhooks
+        subcategory: custom-property-values
+        supported-webhook-types:
+        - repository
+        - organization
+        - app
   delete:
     post:
       summary: |-
@@ -91523,6 +91784,112 @@ components:
       - pusher_type
       - repository
       - sender
+    webhook-custom-property-created:
+      title: custom property created event
+      type: object
+      properties:
+        action:
+          type: string
+          enum:
+          - created
+        definition:
+          "$ref": "#/components/schemas/org-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-webhooks"
+      required:
+      - action
+      - definition
+      - organization
+    webhook-custom-property-deleted:
+      title: custom property deleted event
+      type: object
+      properties:
+        action:
+          type: string
+          enum:
+          - deleted
+        definition:
+          type: object
+          properties:
+            property_name:
+              type: string
+              description: The name of the property that was deleted.
+          required:
+          - property_name
+        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-webhooks"
+      required:
+      - action
+      - definition
+      - organization
+    webhook-custom-property-updated:
+      title: custom property updated event
+      type: object
+      properties:
+        action:
+          type: string
+          enum:
+          - updated
+        definition:
+          "$ref": "#/components/schemas/org-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-webhooks"
+      required:
+      - action
+      - definition
+      - organization
+    webhook-custom-property-values-updated:
+      title: Custom property values updated event
+      type: object
+      properties:
+        action:
+          type: string
+          enum:
+          - updated
+        enterprise:
+          "$ref": "#/components/schemas/enterprise-webhooks"
+        installation:
+          "$ref": "#/components/schemas/simple-installation"
+        repository:
+          "$ref": "#/components/schemas/repository-webhooks"
+        organization:
+          "$ref": "#/components/schemas/organization-simple-webhooks"
+        sender:
+          "$ref": "#/components/schemas/simple-user-webhooks"
+        new_property_values:
+          type: array
+          description: The new custom property values for the repository.
+          items:
+            "$ref": "#/components/schemas/custom-property-value"
+        old_property_values:
+          type: array
+          description: The old custom property values for the repository.
+          items:
+            "$ref": "#/components/schemas/custom-property-value"
+      required:
+      - action
+      - repository
+      - organization
+      - new_property_values
+      - old_property_values
     webhook-delete:
       title: delete event
       type: object