Skip to content

Commit 2dddd24

Browse files
dinonuggies1dinonuggies1
authored
Merge pull request #3359 from github/openapi-update-5b830ae572f168ce0cf88f4aef6ff5dba00c1cd3d480ee3790297f3d149cb0f3
Update OpenAPI 3.0 Descriptions
2 parents 11e7786 + c696949 commit 2dddd24

16 files changed

+18460
-12644
lines changed

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

+64
Original file line numberDiff line numberDiff line change
@@ -98234,6 +98234,57 @@
9823498234
"repository_id"
9823598235
]
9823698236
},
98237+
"repository-ruleset-conditions-repository-property-spec": {
98238+
"title": "Repository ruleset property targeting definition",
98239+
"type": "object",
98240+
"description": "Parameters for a targeting a repository property",
98241+
"properties": {
98242+
"name": {
98243+
"type": "string",
98244+
"description": "The name of the repository property to target"
98245+
},
98246+
"property_values": {
98247+
"type": "array",
98248+
"description": "The values to match for the repository property",
98249+
"items": {
98250+
"type": "string"
98251+
}
98252+
}
98253+
},
98254+
"required": [
98255+
"name",
98256+
"property_values"
98257+
]
98258+
},
98259+
"repository-ruleset-conditions-repository-property-target": {
98260+
"title": "Repository ruleset conditions for repository properties",
98261+
"type": "object",
98262+
"description": "Parameters for a repository property condition",
98263+
"properties": {
98264+
"repository_property": {
98265+
"type": "object",
98266+
"properties": {
98267+
"include": {
98268+
"type": "array",
98269+
"description": "The repository properties and values to include. All of these properties must match for the condition to pass.",
98270+
"items": {
98271+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
98272+
}
98273+
},
98274+
"exclude": {
98275+
"type": "array",
98276+
"description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.",
98277+
"items": {
98278+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
98279+
}
98280+
}
98281+
}
98282+
}
98283+
},
98284+
"required": [
98285+
"repository_property"
98286+
]
98287+
},
9823798288
"org-ruleset-conditions": {
9823898289
"title": "Organization ruleset conditions",
9823998290
"type": "object",
@@ -98264,6 +98315,19 @@
9826498315
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target"
9826598316
}
9826698317
]
98318+
},
98319+
{
98320+
"type": "object",
98321+
"title": "repository_property_and_ref_name",
98322+
"description": "Conditions to target repositories by property and refs by name",
98323+
"allOf": [
98324+
{
98325+
"$ref": "#/components/schemas/repository-ruleset-conditions"
98326+
},
98327+
{
98328+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target"
98329+
}
98330+
]
9826798331
}
9826898332
]
9826998333
},

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

+44
Original file line numberDiff line numberDiff line change
@@ -71592,6 +71592,44 @@ components:
7159271592
type: integer
7159371593
required:
7159471594
- repository_id
71595+
repository-ruleset-conditions-repository-property-spec:
71596+
title: Repository ruleset property targeting definition
71597+
type: object
71598+
description: Parameters for a targeting a repository property
71599+
properties:
71600+
name:
71601+
type: string
71602+
description: The name of the repository property to target
71603+
property_values:
71604+
type: array
71605+
description: The values to match for the repository property
71606+
items:
71607+
type: string
71608+
required:
71609+
- name
71610+
- property_values
71611+
repository-ruleset-conditions-repository-property-target:
71612+
title: Repository ruleset conditions for repository properties
71613+
type: object
71614+
description: Parameters for a repository property condition
71615+
properties:
71616+
repository_property:
71617+
type: object
71618+
properties:
71619+
include:
71620+
type: array
71621+
description: The repository properties and values to include. All of
71622+
these properties must match for the condition to pass.
71623+
items:
71624+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
71625+
exclude:
71626+
type: array
71627+
description: The repository properties and values to exclude. The condition
71628+
will not pass if any of these properties match.
71629+
items:
71630+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
71631+
required:
71632+
- repository_property
7159571633
org-ruleset-conditions:
7159671634
title: Organization ruleset conditions
7159771635
type: object
@@ -71613,6 +71651,12 @@ components:
7161371651
allOf:
7161471652
- "$ref": "#/components/schemas/repository-ruleset-conditions"
7161571653
- "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target"
71654+
- type: object
71655+
title: repository_property_and_ref_name
71656+
description: Conditions to target repositories by property and refs by name
71657+
allOf:
71658+
- "$ref": "#/components/schemas/repository-ruleset-conditions"
71659+
- "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target"
7161671660
repository-rule-creation:
7161771661
title: creation
7161871662
description: Only allow users with bypass permission to create matching refs.

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

+64
Original file line numberDiff line numberDiff line change
@@ -98234,6 +98234,57 @@
9823498234
"repository_id"
9823598235
]
9823698236
},
98237+
"repository-ruleset-conditions-repository-property-spec": {
98238+
"title": "Repository ruleset property targeting definition",
98239+
"type": "object",
98240+
"description": "Parameters for a targeting a repository property",
98241+
"properties": {
98242+
"name": {
98243+
"type": "string",
98244+
"description": "The name of the repository property to target"
98245+
},
98246+
"property_values": {
98247+
"type": "array",
98248+
"description": "The values to match for the repository property",
98249+
"items": {
98250+
"type": "string"
98251+
}
98252+
}
98253+
},
98254+
"required": [
98255+
"name",
98256+
"property_values"
98257+
]
98258+
},
98259+
"repository-ruleset-conditions-repository-property-target": {
98260+
"title": "Repository ruleset conditions for repository properties",
98261+
"type": "object",
98262+
"description": "Parameters for a repository property condition",
98263+
"properties": {
98264+
"repository_property": {
98265+
"type": "object",
98266+
"properties": {
98267+
"include": {
98268+
"type": "array",
98269+
"description": "The repository properties and values to include. All of these properties must match for the condition to pass.",
98270+
"items": {
98271+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
98272+
}
98273+
},
98274+
"exclude": {
98275+
"type": "array",
98276+
"description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.",
98277+
"items": {
98278+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
98279+
}
98280+
}
98281+
}
98282+
}
98283+
},
98284+
"required": [
98285+
"repository_property"
98286+
]
98287+
},
9823798288
"org-ruleset-conditions": {
9823898289
"title": "Organization ruleset conditions",
9823998290
"type": "object",
@@ -98264,6 +98315,19 @@
9826498315
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target"
9826598316
}
9826698317
]
98318+
},
98319+
{
98320+
"type": "object",
98321+
"title": "repository_property_and_ref_name",
98322+
"description": "Conditions to target repositories by property and refs by name",
98323+
"allOf": [
98324+
{
98325+
"$ref": "#/components/schemas/repository-ruleset-conditions"
98326+
},
98327+
{
98328+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target"
98329+
}
98330+
]
9826798331
}
9826898332
]
9826998333
},

‎descriptions/api.github.com/api.github.com.yaml

+44
Original file line numberDiff line numberDiff line change
@@ -71592,6 +71592,44 @@ components:
7159271592
type: integer
7159371593
required:
7159471594
- repository_id
71595+
repository-ruleset-conditions-repository-property-spec:
71596+
title: Repository ruleset property targeting definition
71597+
type: object
71598+
description: Parameters for a targeting a repository property
71599+
properties:
71600+
name:
71601+
type: string
71602+
description: The name of the repository property to target
71603+
property_values:
71604+
type: array
71605+
description: The values to match for the repository property
71606+
items:
71607+
type: string
71608+
required:
71609+
- name
71610+
- property_values
71611+
repository-ruleset-conditions-repository-property-target:
71612+
title: Repository ruleset conditions for repository properties
71613+
type: object
71614+
description: Parameters for a repository property condition
71615+
properties:
71616+
repository_property:
71617+
type: object
71618+
properties:
71619+
include:
71620+
type: array
71621+
description: The repository properties and values to include. All of
71622+
these properties must match for the condition to pass.
71623+
items:
71624+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
71625+
exclude:
71626+
type: array
71627+
description: The repository properties and values to exclude. The condition
71628+
will not pass if any of these properties match.
71629+
items:
71630+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
71631+
required:
71632+
- repository_property
7159571633
org-ruleset-conditions:
7159671634
title: Organization ruleset conditions
7159771635
type: object
@@ -71613,6 +71651,12 @@ components:
7161371651
allOf:
7161471652
- "$ref": "#/components/schemas/repository-ruleset-conditions"
7161571653
- "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target"
71654+
- type: object
71655+
title: repository_property_and_ref_name
71656+
description: Conditions to target repositories by property and refs by name
71657+
allOf:
71658+
- "$ref": "#/components/schemas/repository-ruleset-conditions"
71659+
- "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target"
7161671660
repository-rule-creation:
7161771661
title: creation
7161871662
description: Only allow users with bypass permission to create matching refs.

0 commit comments

Comments
 (0)