[Schema Inaccuracy] Example and schema mismatch for `#/paths/~1orgs~1{org}~1actions~1hosted-runners/get`

Open
#5,550 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
48/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
openapi
Domain
api

Research direction

Search the OpenAPI description for the two examples named in the issue: actions-hosted-runner-paginated/value and actions-hosted-runner/value, then compare their image fields with the schema for the hosted-runners GET response. Done means the examples and schema use the same field name and the schema validation no longer reports this mismatch.

Written by the indexing model from the issue text.

Description

feature

Schema Inaccuracy

This is the json ref for the example

#/components/examples/actions-hosted-runner-paginated/value

The field image doesn't exist in the schema, but exists in the example. It appears to be image_details in the schema.

Here's a snippet

    3:     "id" : 5,
    4:     "name" : "My hosted ubuntu runner",
    5:     "runner_group_id" : 2,
    6:     "platform" : "linux-x64",
>   7:     "image" : {
    8:       "id" : "ubuntu-20.04",
    9:       "size" : 86
   10:     },
   11:     "machine_size_details" : {

Same also happens on

#/components/examples/actions-hosted-runner/value

Expected

The schema and example are in sync

Reproduction Steps

I could reproduce this in

  • fpt
Dominant language
No language data
Stars
1.6k
Forks
342
Avg merge
3h 33m
Merged PRs (30d)
51

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/rest-api-description

All issues in github/rest-api-description

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.