Skip to content

Commit 164eec2

Browse files
Update OpenAPI 3.1 Descriptions
1 parent 11e7786 commit 164eec2

16 files changed

+18316
-12500
lines changed

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

+64
Original file line numberDiff line numberDiff line change
@@ -99003,6 +99003,57 @@
9900399003
"repository_id"
9900499004
]
9900599005
},
99006+
"repository-ruleset-conditions-repository-property-spec": {
99007+
"title": "Repository ruleset property targeting definition",
99008+
"type": "object",
99009+
"description": "Parameters for a targeting a repository property",
99010+
"properties": {
99011+
"name": {
99012+
"type": "string",
99013+
"description": "The name of the repository property to target"
99014+
},
99015+
"property_values": {
99016+
"type": "array",
99017+
"description": "The values to match for the repository property",
99018+
"items": {
99019+
"type": "string"
99020+
}
99021+
}
99022+
},
99023+
"required": [
99024+
"name",
99025+
"property_values"
99026+
]
99027+
},
99028+
"repository-ruleset-conditions-repository-property-target": {
99029+
"title": "Repository ruleset conditions for repository properties",
99030+
"type": "object",
99031+
"description": "Parameters for a repository property condition",
99032+
"properties": {
99033+
"repository_property": {
99034+
"type": "object",
99035+
"properties": {
99036+
"include": {
99037+
"type": "array",
99038+
"description": "The repository properties and values to include. All of these properties must match for the condition to pass.",
99039+
"items": {
99040+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
99041+
}
99042+
},
99043+
"exclude": {
99044+
"type": "array",
99045+
"description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.",
99046+
"items": {
99047+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
99048+
}
99049+
}
99050+
}
99051+
}
99052+
},
99053+
"required": [
99054+
"repository_property"
99055+
]
99056+
},
9900699057
"org-ruleset-conditions": {
9900799058
"title": "Organization ruleset conditions",
9900899059
"type": "object",
@@ -99033,6 +99084,19 @@
9903399084
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target"
9903499085
}
9903599086
]
99087+
},
99088+
{
99089+
"type": "object",
99090+
"title": "repository_property_and_ref_name",
99091+
"description": "Conditions to target repositories by property and refs by name",
99092+
"allOf": [
99093+
{
99094+
"$ref": "#/components/schemas/repository-ruleset-conditions"
99095+
},
99096+
{
99097+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target"
99098+
}
99099+
]
9903699100
}
9903799101
]
9903899102
},

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

+44
Original file line numberDiff line numberDiff line change
@@ -71447,6 +71447,44 @@ components:
7144771447
type: integer
7144871448
required:
7144971449
- repository_id
71450+
repository-ruleset-conditions-repository-property-spec:
71451+
title: Repository ruleset property targeting definition
71452+
type: object
71453+
description: Parameters for a targeting a repository property
71454+
properties:
71455+
name:
71456+
type: string
71457+
description: The name of the repository property to target
71458+
property_values:
71459+
type: array
71460+
description: The values to match for the repository property
71461+
items:
71462+
type: string
71463+
required:
71464+
- name
71465+
- property_values
71466+
repository-ruleset-conditions-repository-property-target:
71467+
title: Repository ruleset conditions for repository properties
71468+
type: object
71469+
description: Parameters for a repository property condition
71470+
properties:
71471+
repository_property:
71472+
type: object
71473+
properties:
71474+
include:
71475+
type: array
71476+
description: The repository properties and values to include. All of
71477+
these properties must match for the condition to pass.
71478+
items:
71479+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
71480+
exclude:
71481+
type: array
71482+
description: The repository properties and values to exclude. The condition
71483+
will not pass if any of these properties match.
71484+
items:
71485+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
71486+
required:
71487+
- repository_property
7145071488
org-ruleset-conditions:
7145171489
title: Organization ruleset conditions
7145271490
type: object
@@ -71468,6 +71506,12 @@ components:
7146871506
allOf:
7146971507
- "$ref": "#/components/schemas/repository-ruleset-conditions"
7147071508
- "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target"
71509+
- type: object
71510+
title: repository_property_and_ref_name
71511+
description: Conditions to target repositories by property and refs by name
71512+
allOf:
71513+
- "$ref": "#/components/schemas/repository-ruleset-conditions"
71514+
- "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target"
7147171515
repository-rule-creation:
7147271516
title: creation
7147371517
description: Only allow users with bypass permission to create matching refs.

descriptions-next/api.github.com/api.github.com.json

+64
Original file line numberDiff line numberDiff line change
@@ -99003,6 +99003,57 @@
9900399003
"repository_id"
9900499004
]
9900599005
},
99006+
"repository-ruleset-conditions-repository-property-spec": {
99007+
"title": "Repository ruleset property targeting definition",
99008+
"type": "object",
99009+
"description": "Parameters for a targeting a repository property",
99010+
"properties": {
99011+
"name": {
99012+
"type": "string",
99013+
"description": "The name of the repository property to target"
99014+
},
99015+
"property_values": {
99016+
"type": "array",
99017+
"description": "The values to match for the repository property",
99018+
"items": {
99019+
"type": "string"
99020+
}
99021+
}
99022+
},
99023+
"required": [
99024+
"name",
99025+
"property_values"
99026+
]
99027+
},
99028+
"repository-ruleset-conditions-repository-property-target": {
99029+
"title": "Repository ruleset conditions for repository properties",
99030+
"type": "object",
99031+
"description": "Parameters for a repository property condition",
99032+
"properties": {
99033+
"repository_property": {
99034+
"type": "object",
99035+
"properties": {
99036+
"include": {
99037+
"type": "array",
99038+
"description": "The repository properties and values to include. All of these properties must match for the condition to pass.",
99039+
"items": {
99040+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
99041+
}
99042+
},
99043+
"exclude": {
99044+
"type": "array",
99045+
"description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.",
99046+
"items": {
99047+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
99048+
}
99049+
}
99050+
}
99051+
}
99052+
},
99053+
"required": [
99054+
"repository_property"
99055+
]
99056+
},
9900699057
"org-ruleset-conditions": {
9900799058
"title": "Organization ruleset conditions",
9900899059
"type": "object",
@@ -99033,6 +99084,19 @@
9903399084
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target"
9903499085
}
9903599086
]
99087+
},
99088+
{
99089+
"type": "object",
99090+
"title": "repository_property_and_ref_name",
99091+
"description": "Conditions to target repositories by property and refs by name",
99092+
"allOf": [
99093+
{
99094+
"$ref": "#/components/schemas/repository-ruleset-conditions"
99095+
},
99096+
{
99097+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target"
99098+
}
99099+
]
9903699100
}
9903799101
]
9903899102
},

descriptions-next/api.github.com/api.github.com.yaml

+44
Original file line numberDiff line numberDiff line change
@@ -71447,6 +71447,44 @@ components:
7144771447
type: integer
7144871448
required:
7144971449
- repository_id
71450+
repository-ruleset-conditions-repository-property-spec:
71451+
title: Repository ruleset property targeting definition
71452+
type: object
71453+
description: Parameters for a targeting a repository property
71454+
properties:
71455+
name:
71456+
type: string
71457+
description: The name of the repository property to target
71458+
property_values:
71459+
type: array
71460+
description: The values to match for the repository property
71461+
items:
71462+
type: string
71463+
required:
71464+
- name
71465+
- property_values
71466+
repository-ruleset-conditions-repository-property-target:
71467+
title: Repository ruleset conditions for repository properties
71468+
type: object
71469+
description: Parameters for a repository property condition
71470+
properties:
71471+
repository_property:
71472+
type: object
71473+
properties:
71474+
include:
71475+
type: array
71476+
description: The repository properties and values to include. All of
71477+
these properties must match for the condition to pass.
71478+
items:
71479+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
71480+
exclude:
71481+
type: array
71482+
description: The repository properties and values to exclude. The condition
71483+
will not pass if any of these properties match.
71484+
items:
71485+
"$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec"
71486+
required:
71487+
- repository_property
7145071488
org-ruleset-conditions:
7145171489
title: Organization ruleset conditions
7145271490
type: object
@@ -71468,6 +71506,12 @@ components:
7146871506
allOf:
7146971507
- "$ref": "#/components/schemas/repository-ruleset-conditions"
7147071508
- "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target"
71509+
- type: object
71510+
title: repository_property_and_ref_name
71511+
description: Conditions to target repositories by property and refs by name
71512+
allOf:
71513+
- "$ref": "#/components/schemas/repository-ruleset-conditions"
71514+
- "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target"
7147171515
repository-rule-creation:
7147271516
title: creation
7147371517
description: Only allow users with bypass permission to create matching refs.

0 commit comments

Comments
 (0)