Skip to content

Commit

Permalink
Update OpenAPI Descriptions (github#23243)
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-openapi-bot
github-openapi-bot authored Dec 1, 2021
1 parent 3c6f09d commit 0cc679b
Show file tree
Hide file tree
Showing 12 changed files with 787 additions and 811 deletions.
258 changes: 199 additions & 59 deletions lib/rest/static/decorated/api.github.com.json
View file

Large diffs are not rendered by default.

120 changes: 81 additions & 39 deletions lib/rest/static/decorated/ghes-3.0.json
View file

Large diffs are not rendered by default.

120 changes: 81 additions & 39 deletions lib/rest/static/decorated/ghes-3.1.json
View file

Large diffs are not rendered by default.

120 changes: 81 additions & 39 deletions lib/rest/static/decorated/ghes-3.2.json
View file

Large diffs are not rendered by default.

120 changes: 81 additions & 39 deletions lib/rest/static/decorated/ghes-3.3.json
View file

Large diffs are not rendered by default.

120 changes: 81 additions & 39 deletions lib/rest/static/decorated/github.ae.json
View file

Large diffs are not rendered by default.

80 changes: 66 additions & 14 deletions lib/rest/static/dereferenced/api.github.com.deref.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153145,6 +153145,8 @@
"type": "boolean"
},
"required_status_checks": {
"title": "Protected Branch Required Status Check",
"description": "Protected Branch Required Status Check",
"type": "object",
"properties": {
"url": {
Expand Down Expand Up @@ -153186,7 +153188,8 @@
}
},
"required": [
"contexts"
"contexts",
"checks"
]
},
"enforce_admins": {
Expand Down Expand Up @@ -154564,6 +154567,8 @@
"type": "boolean"
},
"required_status_checks": {
"title": "Protected Branch Required Status Check",
"description": "Protected Branch Required Status Check",
"type": "object",
"properties": {
"url": {
Expand Down Expand Up @@ -154605,7 +154610,8 @@
}
},
"required": [
"contexts"
"contexts",
"checks"
]
},
"enforce_admins": {
Expand Down Expand Up @@ -155474,6 +155480,8 @@
"type": "boolean"
},
"required_status_checks": {
"title": "Protected Branch Required Status Check",
"description": "Protected Branch Required Status Check",
"type": "object",
"properties": {
"url": {
Expand Down Expand Up @@ -155515,7 +155523,8 @@
}
},
"required": [
"contexts"
"contexts",
"checks"
]
},
"enforce_admins": {
Expand Down Expand Up @@ -156474,7 +156483,8 @@
},
"contexts": {
"type": "array",
"description": "The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.",
"deprecated": true,
"description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n",
"items": {
"type": "string"
}
Expand All @@ -156484,14 +156494,17 @@
"description": "The list of status checks to require in order to merge into this branch.",
"items": {
"type": "object",
"required": [
"context"
],
"properties": {
"context": {
"type": "string",
"description": "The name of the required check"
},
"app_id": {
"type": "integer",
"description": "The ID of the GitHub App that must provide this check. Set to `null` to accept the check from any source."
"description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App."
}
}
}
Expand Down Expand Up @@ -156693,7 +156706,11 @@
"type": "integer",
"nullable": true
}
}
},
"required": [
"context",
"app_id"
]
}
},
"contexts_url": {
Expand All @@ -156706,7 +156723,8 @@
"url",
"contexts_url",
"strict",
"contexts"
"contexts",
"checks"
]
},
"required_pull_request_reviews": {
Expand Down Expand Up @@ -159302,7 +159320,11 @@
"type": "integer",
"nullable": true
}
}
},
"required": [
"context",
"app_id"
]
}
},
"contexts_url": {
Expand All @@ -159315,7 +159337,8 @@
"url",
"contexts_url",
"strict",
"contexts"
"contexts",
"checks"
]
},
"examples": {
Expand Down Expand Up @@ -159376,7 +159399,7 @@
"operationId": "repos/update-status-check-protection",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/reference/repos#update-status-check-potection"
"url": "https://docs.github.com/rest/reference/repos#update-status-check-protection"
},
"parameters": [
{
Expand Down Expand Up @@ -159419,10 +159442,31 @@
},
"contexts": {
"type": "array",
"description": "The list of status checks to require in order to merge into this branch",
"deprecated": true,
"description": "**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.\n",
"items": {
"type": "string"
}
},
"checks": {
"type": "array",
"description": "The list of status checks to require in order to merge into this branch.",
"items": {
"type": "object",
"required": [
"context"
],
"properties": {
"context": {
"type": "string",
"description": "The name of the required check"
},
"app_id": {
"type": "integer",
"description": "The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App."
}
}
}
}
}
},
Expand Down Expand Up @@ -159476,7 +159520,11 @@
"type": "integer",
"nullable": true
}
}
},
"required": [
"context",
"app_id"
]
}
},
"contexts_url": {
Expand All @@ -159489,7 +159537,8 @@
"url",
"contexts_url",
"strict",
"contexts"
"contexts",
"checks"
]
},
"examples": {
Expand Down Expand Up @@ -165717,6 +165766,8 @@
"type": "boolean"
},
"required_status_checks": {
"title": "Protected Branch Required Status Check",
"description": "Protected Branch Required Status Check",
"type": "object",
"properties": {
"url": {
Expand Down Expand Up @@ -165758,7 +165809,8 @@
}
},
"required": [
"contexts"
"contexts",
"checks"
]
},
"enforce_admins": {
Expand Down
Loading

0 comments on commit 0cc679b

Please sign in to comment.