Skip to content
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

Update OpenAPI 3.0 Descriptions #3056

Closed
wants to merge 1 commit into from
Closed

Update OpenAPI 3.0 Descriptions #3056

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
71 changes: 71 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 @@ -94877,6 +94877,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",
Expand Down Expand Up @@ -94923,6 +94981,9 @@
},
{
"$ref": "#/components/schemas/repository-rule-tag-name-pattern"
},
{
"$ref": "#/components/schemas/repository-rule-workflows"
}
]
},
Expand Down Expand Up @@ -111919,6 +111980,16 @@
"$ref": "#/components/schemas/repository-rule-ruleset-info"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/repository-rule-workflows"
},
{
"$ref": "#/components/schemas/repository-rule-ruleset-info"
}
]
}
]
},
Expand Down
46 changes: 46 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 @@ -68504,6 +68504,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
Expand All @@ -68523,6 +68565,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
Expand Down Expand Up @@ -81524,6 +81567,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:
Expand Down
71 changes: 71 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 @@ -94877,6 +94877,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",
Expand Down Expand Up @@ -94923,6 +94981,9 @@
},
{
"$ref": "#/components/schemas/repository-rule-tag-name-pattern"
},
{
"$ref": "#/components/schemas/repository-rule-workflows"
}
]
},
Expand Down Expand Up @@ -111919,6 +111980,16 @@
"$ref": "#/components/schemas/repository-rule-ruleset-info"
}
]
},
{
"allOf": [
{
"$ref": "#/components/schemas/repository-rule-workflows"
},
{
"$ref": "#/components/schemas/repository-rule-ruleset-info"
}
]
}
]
},
Expand Down
46 changes: 46 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 @@ -68504,6 +68504,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
Expand All @@ -68523,6 +68565,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
Expand Down Expand Up @@ -81524,6 +81567,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:
Expand Down
Loading