Update OpenAPI 3.1 Descriptions

github · Oct 10, 2023 · a740a77 · a740a77
1 parent 545a6ad
commit a740a77
Show file tree

Hide file tree

Showing 16 changed files with 10,984 additions and 6,040 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
@@ -96348,6 +96348,64 @@
           }
         }
       },
+      "repository-rule-params-workflow-file-reference": {
+        "title": "WorkflowFileReference",
+        "description": "A workflow that must run for this rule to pass",
+        "type": "object",
+        "properties": {
+          "path": {
+            "type": "string",
+            "description": "The path to the workflow file"
+          },
+          "ref": {
+            "type": "string",
+            "description": "The ref (branch or tag) of the workflow file to use"
+          },
+          "repository_id": {
+            "type": "integer",
+            "description": "The ID of the repository where the workflow is defined"
+          },
+          "sha": {
+            "type": "string",
+            "description": "The commit SHA of the workflow file to use"
+          }
+        },
+        "required": [
+          "path",
+          "repository_id"
+        ]
+      },
+      "repository-rule-workflows": {
+        "title": "workflows",
+        "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.",
+        "type": "object",
+        "required": [
+          "type"
+        ],
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "workflows"
+            ]
+          },
+          "parameters": {
+            "type": "object",
+            "properties": {
+              "workflows": {
+                "type": "array",
+                "description": "Workflows that must pass for this rule to pass.",
+                "items": {
+                  "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference"
+                }
+              }
+            },
+            "required": [
+              "workflows"
+            ]
+          }
+        }
+      },
       "repository-rule": {
         "title": "Repository Rule",
         "type": "object",
@@ -96394,6 +96452,9 @@
           },
           {
             "$ref": "#/components/schemas/repository-rule-tag-name-pattern"
+          },
+          {
+            "$ref": "#/components/schemas/repository-rule-workflows"
           }
         ]
       },
@@ -114699,6 +114760,16 @@
                 "$ref": "#/components/schemas/repository-rule-ruleset-info"
               }
             ]
+          },
+          {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/repository-rule-workflows"
+              },
+              {
+                "$ref": "#/components/schemas/repository-rule-ruleset-info"
+              }
+            ]
           }
         ]
       },

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
@@ -68990,6 +68990,48 @@ components:
           required:
           - operator
           - pattern
+    repository-rule-params-workflow-file-reference:
+      title: WorkflowFileReference
+      description: A workflow that must run for this rule to pass
+      type: object
+      properties:
+        path:
+          type: string
+          description: The path to the workflow file
+        ref:
+          type: string
+          description: The ref (branch or tag) of the workflow file to use
+        repository_id:
+          type: integer
+          description: The ID of the repository where the workflow is defined
+        sha:
+          type: string
+          description: The commit SHA of the workflow file to use
+      required:
+      - path
+      - repository_id
+    repository-rule-workflows:
+      title: workflows
+      description: Require all changes made to a targeted branch to pass the specified
+        workflows before they can be merged.
+      type: object
+      required:
+      - type
+      properties:
+        type:
+          type: string
+          enum:
+          - workflows
+        parameters:
+          type: object
+          properties:
+            workflows:
+              type: array
+              description: Workflows that must pass for this rule to pass.
+              items:
+                "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference"
+          required:
+          - workflows
     repository-rule:
       title: Repository Rule
       type: object
@@ -69009,6 +69051,7 @@ components:
       - "$ref": "#/components/schemas/repository-rule-committer-email-pattern"
       - "$ref": "#/components/schemas/repository-rule-branch-name-pattern"
       - "$ref": "#/components/schemas/repository-rule-tag-name-pattern"
+      - "$ref": "#/components/schemas/repository-rule-workflows"
     repository-ruleset:
       title: Repository ruleset
       type: object
@@ -82055,6 +82098,9 @@ components:
       - allOf:
         - "$ref": "#/components/schemas/repository-rule-tag-name-pattern"
         - "$ref": "#/components/schemas/repository-rule-ruleset-info"
+      - allOf:
+        - "$ref": "#/components/schemas/repository-rule-workflows"
+        - "$ref": "#/components/schemas/repository-rule-ruleset-info"
     secret-scanning-alert:
       type: object
       properties:

diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json
@@ -96348,6 +96348,64 @@
           }
         }
       },
+      "repository-rule-params-workflow-file-reference": {
+        "title": "WorkflowFileReference",
+        "description": "A workflow that must run for this rule to pass",
+        "type": "object",
+        "properties": {
+          "path": {
+            "type": "string",
+            "description": "The path to the workflow file"
+          },
+          "ref": {
+            "type": "string",
+            "description": "The ref (branch or tag) of the workflow file to use"
+          },
+          "repository_id": {
+            "type": "integer",
+            "description": "The ID of the repository where the workflow is defined"
+          },
+          "sha": {
+            "type": "string",
+            "description": "The commit SHA of the workflow file to use"
+          }
+        },
+        "required": [
+          "path",
+          "repository_id"
+        ]
+      },
+      "repository-rule-workflows": {
+        "title": "workflows",
+        "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.",
+        "type": "object",
+        "required": [
+          "type"
+        ],
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": [
+              "workflows"
+            ]
+          },
+          "parameters": {
+            "type": "object",
+            "properties": {
+              "workflows": {
+                "type": "array",
+                "description": "Workflows that must pass for this rule to pass.",
+                "items": {
+                  "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference"
+                }
+              }
+            },
+            "required": [
+              "workflows"
+            ]
+          }
+        }
+      },
       "repository-rule": {
         "title": "Repository Rule",
         "type": "object",
@@ -96394,6 +96452,9 @@
           },
           {
             "$ref": "#/components/schemas/repository-rule-tag-name-pattern"
+          },
+          {
+            "$ref": "#/components/schemas/repository-rule-workflows"
           }
         ]
       },
@@ -114699,6 +114760,16 @@
                 "$ref": "#/components/schemas/repository-rule-ruleset-info"
               }
             ]
+          },
+          {
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/repository-rule-workflows"
+              },
+              {
+                "$ref": "#/components/schemas/repository-rule-ruleset-info"
+              }
+            ]
           }
         ]
       },

diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml
@@ -68990,6 +68990,48 @@ components:
           required:
           - operator
           - pattern
+    repository-rule-params-workflow-file-reference:
+      title: WorkflowFileReference
+      description: A workflow that must run for this rule to pass
+      type: object
+      properties:
+        path:
+          type: string
+          description: The path to the workflow file
+        ref:
+          type: string
+          description: The ref (branch or tag) of the workflow file to use
+        repository_id:
+          type: integer
+          description: The ID of the repository where the workflow is defined
+        sha:
+          type: string
+          description: The commit SHA of the workflow file to use
+      required:
+      - path
+      - repository_id
+    repository-rule-workflows:
+      title: workflows
+      description: Require all changes made to a targeted branch to pass the specified
+        workflows before they can be merged.
+      type: object
+      required:
+      - type
+      properties:
+        type:
+          type: string
+          enum:
+          - workflows
+        parameters:
+          type: object
+          properties:
+            workflows:
+              type: array
+              description: Workflows that must pass for this rule to pass.
+              items:
+                "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference"
+          required:
+          - workflows
     repository-rule:
       title: Repository Rule
       type: object
@@ -69009,6 +69051,7 @@ components:
       - "$ref": "#/components/schemas/repository-rule-committer-email-pattern"
       - "$ref": "#/components/schemas/repository-rule-branch-name-pattern"
       - "$ref": "#/components/schemas/repository-rule-tag-name-pattern"
+      - "$ref": "#/components/schemas/repository-rule-workflows"
     repository-ruleset:
       title: Repository ruleset
       type: object
@@ -82055,6 +82098,9 @@ components:
       - allOf:
         - "$ref": "#/components/schemas/repository-rule-tag-name-pattern"
         - "$ref": "#/components/schemas/repository-rule-ruleset-info"
+      - allOf:
+        - "$ref": "#/components/schemas/repository-rule-workflows"
+        - "$ref": "#/components/schemas/repository-rule-ruleset-info"
     secret-scanning-alert:
       type: object
       properties: