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.

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

Fix example responses for job object queries in rest/actions/workflow-jobs #3036

Closed
1 task done
ClaytonHughes opened this issue Oct 4, 2023 · 5 comments
Closed
1 task done

Comments

@ClaytonHughes
Copy link

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/rest/actions/workflow-jobs

What part(s) of the article would you like to see updated?

In the example response for "Get a job for a workflow run", "List jobs for a workflow run attempt", and "List jobs for a workflow run", the job's html_url value is incorrect.

It is"html_url": "https://github.com/octo-org/octo-repo/runs/399444496",
but should be "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496",

Additional information

verified for one endpoint with the following:

curl -sL \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer $GITHUB_TOKEN" \
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/repos/$GITHUB_OWNER/$GITHUB_REPO/actions/runs/$GITHUB_RUN_ID/jobs \
| jq '.jobs[0].html_url'

I tried to fix it myself but am unfamiliar with how the examples are being generated.

@welcome
Copy link

welcome bot commented Oct 4, 2023

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@cmwilson21
Copy link

@ClaytonHughes Thanks for opening an issue and bringing this to our attention!

The schema files are indeed updated from a separate repository, so I'll have to transfer this issue over. 👍

Thank you for your interest in improving GitHub Docs! 💖

@docs-bot
Copy link
Collaborator

docs-bot commented Oct 4, 2023

Thank you for opening this issue! Changes to the REST API schema can be requested in github/rest-api-description. I will transfer your issue over to that open source repo.

@docs-bot docs-bot transferred this issue from github/docs Oct 4, 2023
@shiftkey
Copy link
Member

shiftkey commented Oct 4, 2023

@ClaytonHughes thanks for reporting this. I've queued up a fix for this, and will let you know when it's live.

@shiftkey shiftkey self-assigned this Oct 4, 2023
@shiftkey
Copy link
Member

Closing this out as fixed - thanks for the report @ClaytonHughes!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants