[Schema Inaccuracy] `create-release` api param `make_latest` default value error

Open
#2,496 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
45/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
openapi
Domain
api

Research direction

Start with the create-release schema described in the issue and check the linked GitHub REST API documentation for the expected make_latest type and default. Review the corresponding update-release schema as well, then verify that both defaults are the quoted string 'true' while the existing enum remains unchanged.

Written by the indexing model from the issue text.

Description

inaccuracy P2

Schema Inaccuracy

Docs: https://docs.github.com/en/rest/releases/releases?apiVersion=2022-11-28#create-a-release
Schema:

make_latest:
  type: string
  enum:
  - 'true'
  - 'false'
  - legacy
  default: true

default value of make_latest is a boolean value (not quoted).

update: the update-release api also has the error default value for make_latest.

Expected

make_latest:
  type: string
  enum:
  - 'true'
  - 'false'
  - legacy
  default: 'true'

Reproduction Steps

pass

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.