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

Discrepancy in GitHub API Documentation: Mismatch Between Example Response and Response Schema for Hosted Runners #36416

Open
1 task done
atilsensalduz opened this issue Feb 21, 2025 · 1 comment
Labels
content This issue or pull request belongs to the Docs Content team triage Do not begin working on this issue until triaged by the team

Comments

@atilsensalduz
Copy link

Code of Conduct

What article on docs.github.com is affected?

Description:
I noticed a discrepancy in the GitHub REST API documentation for hosted runners. The example response provided does not match the defined response schema.

Steps to Reproduce:

Visit the hosted runners REST API documentation.
Compare the example response with the response schema for image_details of runner object.
Observe the differences in field names.

Expected Behavior:
The example response should align with the response schema to avoid confusion and ensure accurate integration.

Actual Behavior:

Example Response:
Image

Response Schema:
Image

What changes are you suggesting?

Suggested Fix:
Update either the example response or the response schema to ensure consistency.

Additional information

No response

@atilsensalduz atilsensalduz added the content This issue or pull request belongs to the Docs Content team label Feb 21, 2025
Copy link

welcome bot commented Feb 21, 2025

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Feb 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team triage Do not begin working on this issue until triaged by the team
Projects
None yet
Development

No branches or pull requests

1 participant