Skip to content

Commit

Permalink
FEAT: updates docs, updates workflow-run-requested[hub_url is no long…
Browse files Browse the repository at this point in the history 
…er required], adds values to job.status enum [waiting, requested, pending] (#427)
  • Loading branch information
@octokitbot
octokitbot committed Mar 15, 2024
1 parent 400dfd9 commit 643d324
Show file tree
Hide file tree
Showing 28 changed files with 1,211 additions and 462 deletions.
93 changes: 68 additions & 25 deletions cache/api.github.com.deref.json
View file

Large diffs are not rendered by default.

37 changes: 26 additions & 11 deletions cache/api.github.com.json
View file
Expand Up @@ -2297,7 +2297,7 @@
"/feeds": {
"get": {
"summary": "Get feeds",
"description": "GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
"description": "Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs.\n\n* **Timeline**: The GitHub global public timeline\n* **User**: The public timeline for any user, using `uri_template`. For more information, see \"[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia).\"\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\nBy default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
"tags": [
"activity"
],
Expand Down Expand Up @@ -28747,11 +28747,14 @@
},
"status": {
"type": "string",
"description": "The current status.",
"description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
"enum": [
"queued",
"in_progress",
"completed"
"completed",
"waiting",
"requested",
"pending"
],
"default": "queued"
},
Expand Down Expand Up @@ -29141,11 +29144,14 @@
},
"status": {
"type": "string",
"description": "The current status.",
"description": "The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
"enum": [
"queued",
"in_progress",
"completed"
"completed",
"waiting",
"requested",
"pending"
]
},
"conclusion": {
Expand Down Expand Up @@ -61875,7 +61881,7 @@
"/users/{username}/hovercard": {
"get": {
"summary": "Get contextual information for a user",
"description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\nThe `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:\n\n```shell\n curl -u username:token\n https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192\n```\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
"description": "Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\n The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository).\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.",
"tags": [
"users"
],
Expand Down Expand Up @@ -100817,7 +100823,9 @@
"queued",
"in_progress",
"completed",
"waiting"
"waiting",
"requested",
"pending"
]
},
"conclusion": {
Expand Down Expand Up @@ -103505,13 +103513,16 @@
"nullable": true
},
"status": {
"description": "The phase of the lifecycle that the check is currently in.",
"description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.",
"example": "queued",
"type": "string",
"enum": [
"queued",
"in_progress",
"completed"
"completed",
"waiting",
"requested",
"pending"
]
},
"conclusion": {
Expand Down Expand Up @@ -103789,11 +103800,15 @@
},
"status": {
"type": "string",
"description": "The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.",
"example": "completed",
"enum": [
"queued",
"in_progress",
"completed"
"completed",
"waiting",
"requested",
"pending"
],
"nullable": true
},
Expand Down Expand Up @@ -307398,7 +307413,7 @@
},
"workflow-run-status": {
"name": "status",
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.",
"description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.",
"in": "query",
"required": false,
"schema": {
Expand Down

0 comments on commit 643d324

Please sign in to comment.