Merge pull request #3359 from github/openapi-update-5b830ae572f168ce0…

…cf88f4aef6ff5dba00c1cd3d480ee3790297f3d149cb0f3 Update OpenAPI 3.0 Descriptions
github · Jan 31, 2024 · 2dddd24 · 2dddd24
2 parents 11e7786 + c696949
commit 2dddd24
Show file tree

Hide file tree

Showing 16 changed files with 18,460 additions and 12,644 deletions.
diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json
@@ -98234,6 +98234,57 @@
           "repository_id"
         ]
       },
+      "repository-ruleset-conditions-repository-property-spec": {
+        "title": "Repository ruleset property targeting definition",
+        "type": "object",
+        "description": "Parameters for a targeting a repository property",
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "The name of the repository property to target"
+          },
+          "property_values": {
+            "type": "array",
+            "description": "The values to match for the repository property",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "required": [
+          "name",
+          "property_values"
+        ]
+      },
+      "repository-ruleset-conditions-repository-property-target": {
+        "title": "Repository ruleset conditions for repository properties",
+        "type": "object",
+        "description": "Parameters for a repository property condition",
+        "properties": {
+          "repository_property": {
+            "type": "object",
+            "properties": {
+              "include": {
+                "type": "array",
+                "description": "The repository properties and values to include. All of these properties must match for the condition to pass.",
+                "items": {
+                  "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
+                }
+              },
+              "exclude": {
+                "type": "array",
+                "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.",
+                "items": {
+                  "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
+                }
+              }
+            }
+          }
+        },
+        "required": [
+          "repository_property"
+        ]
+      },
       "org-ruleset-conditions": {
         "title": "Organization ruleset conditions",
         "type": "object",
@@ -98264,6 +98315,19 @@
                 "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target"
               }
             ]
+          },
+          {
+            "type": "object",
+            "title": "repository_property_and_ref_name",
+            "description": "Conditions to target repositories by property and refs by name",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/repository-ruleset-conditions"
+              },
+              {
+                "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target"
+              }
+            ]
           }
         ]
       },

diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml
@@ -71592,6 +71592,44 @@ components:
                 type: integer
       required:
       - repository_id
+    repository-ruleset-conditions-repository-property-spec:
+      title: Repository ruleset property targeting definition
+      type: object
+      description: Parameters for a targeting a repository property
+      properties:
+        name:
+          type: string
+          description: The name of the repository property to target
+        property_values:
+          type: array
+          description: The values to match for the repository property
+          items:
+            type: string
+      required:
+      - name
+      - property_values
+    repository-ruleset-conditions-repository-property-target:
+      title: Repository ruleset conditions for repository properties
+      type: object
+      description: Parameters for a repository property condition
+      properties:
+        repository_property:
+          type: object
+          properties:
+            include:
+              type: array
+              description: The repository properties and values to include. All of
+                these properties must match for the condition to pass.
+              items:
+                "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
+            exclude:
+              type: array
+              description: The repository properties and values to exclude. The condition
+                will not pass if any of these properties match.
+              items:
+                "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
+      required:
+      - repository_property
     org-ruleset-conditions:
       title: Organization ruleset conditions
       type: object
@@ -71613,6 +71651,12 @@ components:
         allOf:
         - "$ref": "#/components/schemas/repository-ruleset-conditions"
         - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target"
+      - type: object
+        title: repository_property_and_ref_name
+        description: Conditions to target repositories by property and refs by name
+        allOf:
+        - "$ref": "#/components/schemas/repository-ruleset-conditions"
+        - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target"
     repository-rule-creation:
       title: creation
       description: Only allow users with bypass permission to create matching refs.

diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json
@@ -98234,6 +98234,57 @@
           "repository_id"
         ]
       },
+      "repository-ruleset-conditions-repository-property-spec": {
+        "title": "Repository ruleset property targeting definition",
+        "type": "object",
+        "description": "Parameters for a targeting a repository property",
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "The name of the repository property to target"
+          },
+          "property_values": {
+            "type": "array",
+            "description": "The values to match for the repository property",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "required": [
+          "name",
+          "property_values"
+        ]
+      },
+      "repository-ruleset-conditions-repository-property-target": {
+        "title": "Repository ruleset conditions for repository properties",
+        "type": "object",
+        "description": "Parameters for a repository property condition",
+        "properties": {
+          "repository_property": {
+            "type": "object",
+            "properties": {
+              "include": {
+                "type": "array",
+                "description": "The repository properties and values to include. All of these properties must match for the condition to pass.",
+                "items": {
+                  "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
+                }
+              },
+              "exclude": {
+                "type": "array",
+                "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.",
+                "items": {
+                  "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
+                }
+              }
+            }
+          }
+        },
+        "required": [
+          "repository_property"
+        ]
+      },
       "org-ruleset-conditions": {
         "title": "Organization ruleset conditions",
         "type": "object",
@@ -98264,6 +98315,19 @@
                 "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target"
               }
             ]
+          },
+          {
+            "type": "object",
+            "title": "repository_property_and_ref_name",
+            "description": "Conditions to target repositories by property and refs by name",
+            "allOf": [
+              {
+                "$ref": "#/components/schemas/repository-ruleset-conditions"
+              },
+              {
+                "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target"
+              }
+            ]
           }
         ]
       },

diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml
@@ -71592,6 +71592,44 @@ components:
                 type: integer
       required:
       - repository_id
+    repository-ruleset-conditions-repository-property-spec:
+      title: Repository ruleset property targeting definition
+      type: object
+      description: Parameters for a targeting a repository property
+      properties:
+        name:
+          type: string
+          description: The name of the repository property to target
+        property_values:
+          type: array
+          description: The values to match for the repository property
+          items:
+            type: string
+      required:
+      - name
+      - property_values
+    repository-ruleset-conditions-repository-property-target:
+      title: Repository ruleset conditions for repository properties
+      type: object
+      description: Parameters for a repository property condition
+      properties:
+        repository_property:
+          type: object
+          properties:
+            include:
+              type: array
+              description: The repository properties and values to include. All of
+                these properties must match for the condition to pass.
+              items:
+                "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
+            exclude:
+              type: array
+              description: The repository properties and values to exclude. The condition
+                will not pass if any of these properties match.
+              items:
+                "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
+      required:
+      - repository_property
     org-ruleset-conditions:
       title: Organization ruleset conditions
       type: object
@@ -71613,6 +71651,12 @@ components:
         allOf:
         - "$ref": "#/components/schemas/repository-ruleset-conditions"
         - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target"
+      - type: object
+        title: repository_property_and_ref_name
+        description: Conditions to target repositories by property and refs by name
+        allOf:
+        - "$ref": "#/components/schemas/repository-ruleset-conditions"
+        - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target"
     repository-rule-creation:
       title: creation
       description: Only allow users with bypass permission to create matching refs.