Skip to content

Commit

Permalink
Update OpenAPI Descriptions (github#22219)
Browse files Browse the repository at this point in the history
* Update OpenAPI Descriptions
  • Loading branch information
github-openapi-bot authored Oct 18, 2021
1 parent 3b03643 commit 1f71206
Show file tree
Hide file tree
Showing 12 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions lib/rest/static/decorated/api.github.com.json
Original file line number Diff line number Diff line change
Expand Up @@ -51237,7 +51237,7 @@
}
],
"summary": "Get the combined status for a specific reference",
"description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
"description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
"tags": [
"repos"
],
Expand All @@ -51259,7 +51259,7 @@
"subcategoryLabel": "Statuses",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.</p>\n<p>The most recent status for each context is returned, up to 100. This field <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination\">paginates</a> if there are over 100 contexts.</p>\n<p>Additionally, a combined <code>state</code> is returned. The <code>state</code> is one of:</p>\n<ul>\n<li><strong>failure</strong> if any of the contexts report as <code>error</code> or <code>failure</code></li>\n<li><strong>pending</strong> if there are no statuses or a context is <code>pending</code></li>\n<li><strong>success</strong> if the latest status for all contexts is <code>success</code></li>\n</ul>",
"descriptionHTML": "<p>Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.</p>\n<p>Additionally, a combined <code>state</code> is returned. The <code>state</code> is one of:</p>\n<ul>\n<li><strong>failure</strong> if any of the contexts report as <code>error</code> or <code>failure</code></li>\n<li><strong>pending</strong> if there are no statuses or a context is <code>pending</code></li>\n<li><strong>success</strong> if the latest status for all contexts is <code>success</code></li>\n</ul>",
"responses": [
{
"httpStatusCode": "200",
Expand Down
4 changes: 2 additions & 2 deletions lib/rest/static/decorated/ghes-2.22.json
Original file line number Diff line number Diff line change
Expand Up @@ -44316,7 +44316,7 @@
}
],
"summary": "Get the combined status for a specific reference",
"description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
"description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
"tags": [
"repos"
],
Expand All @@ -44338,7 +44338,7 @@
"subcategoryLabel": "Statuses",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.</p>\n<p>The most recent status for each context is returned, up to 100. This field <a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#pagination\">paginates</a> if there are over 100 contexts.</p>\n<p>Additionally, a combined <code>state</code> is returned. The <code>state</code> is one of:</p>\n<ul>\n<li><strong>failure</strong> if any of the contexts report as <code>error</code> or <code>failure</code></li>\n<li><strong>pending</strong> if there are no statuses or a context is <code>pending</code></li>\n<li><strong>success</strong> if the latest status for all contexts is <code>success</code></li>\n</ul>",
"descriptionHTML": "<p>Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.</p>\n<p>Additionally, a combined <code>state</code> is returned. The <code>state</code> is one of:</p>\n<ul>\n<li><strong>failure</strong> if any of the contexts report as <code>error</code> or <code>failure</code></li>\n<li><strong>pending</strong> if there are no statuses or a context is <code>pending</code></li>\n<li><strong>success</strong> if the latest status for all contexts is <code>success</code></li>\n</ul>",
"responses": [
{
"httpStatusCode": "200",
Expand Down
4 changes: 2 additions & 2 deletions lib/rest/static/decorated/ghes-3.0.json
Original file line number Diff line number Diff line change
Expand Up @@ -48808,7 +48808,7 @@
}
],
"summary": "Get the combined status for a specific reference",
"description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
"description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
"tags": [
"repos"
],
Expand All @@ -48830,7 +48830,7 @@
"subcategoryLabel": "Statuses",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.</p>\n<p>The most recent status for each context is returned, up to 100. This field <a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#pagination\">paginates</a> if there are over 100 contexts.</p>\n<p>Additionally, a combined <code>state</code> is returned. The <code>state</code> is one of:</p>\n<ul>\n<li><strong>failure</strong> if any of the contexts report as <code>error</code> or <code>failure</code></li>\n<li><strong>pending</strong> if there are no statuses or a context is <code>pending</code></li>\n<li><strong>success</strong> if the latest status for all contexts is <code>success</code></li>\n</ul>",
"descriptionHTML": "<p>Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.</p>\n<p>Additionally, a combined <code>state</code> is returned. The <code>state</code> is one of:</p>\n<ul>\n<li><strong>failure</strong> if any of the contexts report as <code>error</code> or <code>failure</code></li>\n<li><strong>pending</strong> if there are no statuses or a context is <code>pending</code></li>\n<li><strong>success</strong> if the latest status for all contexts is <code>success</code></li>\n</ul>",
"responses": [
{
"httpStatusCode": "200",
Expand Down
4 changes: 2 additions & 2 deletions lib/rest/static/decorated/ghes-3.1.json
Original file line number Diff line number Diff line change
Expand Up @@ -49493,7 +49493,7 @@
}
],
"summary": "Get the combined status for a specific reference",
"description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
"description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
"tags": [
"repos"
],
Expand All @@ -49515,7 +49515,7 @@
"subcategoryLabel": "Statuses",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.</p>\n<p>The most recent status for each context is returned, up to 100. This field <a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#pagination\">paginates</a> if there are over 100 contexts.</p>\n<p>Additionally, a combined <code>state</code> is returned. The <code>state</code> is one of:</p>\n<ul>\n<li><strong>failure</strong> if any of the contexts report as <code>error</code> or <code>failure</code></li>\n<li><strong>pending</strong> if there are no statuses or a context is <code>pending</code></li>\n<li><strong>success</strong> if the latest status for all contexts is <code>success</code></li>\n</ul>",
"descriptionHTML": "<p>Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.</p>\n<p>Additionally, a combined <code>state</code> is returned. The <code>state</code> is one of:</p>\n<ul>\n<li><strong>failure</strong> if any of the contexts report as <code>error</code> or <code>failure</code></li>\n<li><strong>pending</strong> if there are no statuses or a context is <code>pending</code></li>\n<li><strong>success</strong> if the latest status for all contexts is <code>success</code></li>\n</ul>",
"responses": [
{
"httpStatusCode": "200",
Expand Down
4 changes: 2 additions & 2 deletions lib/rest/static/decorated/ghes-3.2.json
Original file line number Diff line number Diff line change
Expand Up @@ -50739,7 +50739,7 @@
}
],
"summary": "Get the combined status for a specific reference",
"description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
"description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
"tags": [
"repos"
],
Expand All @@ -50761,7 +50761,7 @@
"subcategoryLabel": "Statuses",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.</p>\n<p>The most recent status for each context is returned, up to 100. This field <a href=\"https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#pagination\">paginates</a> if there are over 100 contexts.</p>\n<p>Additionally, a combined <code>state</code> is returned. The <code>state</code> is one of:</p>\n<ul>\n<li><strong>failure</strong> if any of the contexts report as <code>error</code> or <code>failure</code></li>\n<li><strong>pending</strong> if there are no statuses or a context is <code>pending</code></li>\n<li><strong>success</strong> if the latest status for all contexts is <code>success</code></li>\n</ul>",
"descriptionHTML": "<p>Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.</p>\n<p>Additionally, a combined <code>state</code> is returned. The <code>state</code> is one of:</p>\n<ul>\n<li><strong>failure</strong> if any of the contexts report as <code>error</code> or <code>failure</code></li>\n<li><strong>pending</strong> if there are no statuses or a context is <code>pending</code></li>\n<li><strong>success</strong> if the latest status for all contexts is <code>success</code></li>\n</ul>",
"responses": [
{
"httpStatusCode": "200",
Expand Down
4 changes: 2 additions & 2 deletions lib/rest/static/decorated/github.ae.json
Original file line number Diff line number Diff line change
Expand Up @@ -42630,7 +42630,7 @@
}
],
"summary": "Get the combined status for a specific reference",
"description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
"description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
"tags": [
"repos"
],
Expand All @@ -42652,7 +42652,7 @@
"subcategoryLabel": "Statuses",
"notes": [],
"bodyParameters": [],
"descriptionHTML": "<p>Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.</p>\n<p>The most recent status for each context is returned, up to 100. This field <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination\">paginates</a> if there are over 100 contexts.</p>\n<p>Additionally, a combined <code>state</code> is returned. The <code>state</code> is one of:</p>\n<ul>\n<li><strong>failure</strong> if any of the contexts report as <code>error</code> or <code>failure</code></li>\n<li><strong>pending</strong> if there are no statuses or a context is <code>pending</code></li>\n<li><strong>success</strong> if the latest status for all contexts is <code>success</code></li>\n</ul>",
"descriptionHTML": "<p>Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.</p>\n<p>Additionally, a combined <code>state</code> is returned. The <code>state</code> is one of:</p>\n<ul>\n<li><strong>failure</strong> if any of the contexts report as <code>error</code> or <code>failure</code></li>\n<li><strong>pending</strong> if there are no statuses or a context is <code>pending</code></li>\n<li><strong>success</strong> if the latest status for all contexts is <code>success</code></li>\n</ul>",
"responses": [
{
"httpStatusCode": "200",
Expand Down
2 changes: 1 addition & 1 deletion lib/rest/static/dereferenced/api.github.com.deref.json
Original file line number Diff line number Diff line change
Expand Up @@ -196722,7 +196722,7 @@
"/repos/{owner}/{repo}/commits/{ref}/status": {
"get": {
"summary": "Get the combined status for a specific reference",
"description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
"description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
"tags": [
"repos"
],
Expand Down
2 changes: 1 addition & 1 deletion lib/rest/static/dereferenced/ghes-2.22.deref.json
Original file line number Diff line number Diff line change
Expand Up @@ -166223,7 +166223,7 @@
"/repos/{owner}/{repo}/commits/{ref}/status": {
"get": {
"summary": "Get the combined status for a specific reference",
"description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://docs.github.com/[email protected]/rest/overview/resources-in-the-rest-api#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
"description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
"tags": [
"repos"
],
Expand Down
Loading

0 comments on commit 1f71206

Please sign in to comment.