Skip to content

Update OpenAPI 3.0 Descriptions #3359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 31, 2024
+18,460 −12,644
Merged

Update OpenAPI 3.0 Descriptions #3359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions descriptions/api.github.com/api.github.com.2022-11-28.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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"
}
]
}
]
},
Expand Down
44 changes: 44 additions & 0 deletions descriptions/api.github.com/api.github.com.2022-11-28.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
64 changes: 64 additions & 0 deletions descriptions/api.github.com/api.github.com.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -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"
}
]
}
]
},
Expand Down
44 changes: 44 additions & 0 deletions descriptions/api.github.com/api.github.com.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
Loading