Skip to content

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

@atilsensalduz

Description

@atilsensalduz

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamfix-internallyTriggers a workflow to copy the issue internally and close the current issue

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions