forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update OpenAPI Descriptions (github#22219)
* Update OpenAPI Descriptions
- Loading branch information
1 parent
3b03643
commit 1f71206
Showing
12 changed files
with
18 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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" | ||
], | ||
|
@@ -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", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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" | ||
], | ||
|
@@ -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", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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" | ||
], | ||
|
@@ -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", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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" | ||
], | ||
|
@@ -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", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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" | ||
], | ||
|
Oops, something went wrong.