[Schema Inaccuracy] Pull Request Simple labels.items.properties.description may be null

Open
#5,560 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start with the Pull Request Simple schema and compare its labels.items.properties.description definition with the Pull Request schema shown in the issue. Reproduce the response using the listed curl request, then update the schema so the nullable description and expected repository field representation match the API response.

Written by the indexing model from the issue text.

Description

feature

Schema Inaccuracy
The Pull Request Simple object field labels.items.properties.description may be null, as the Pull Request object.

schemas:

incorrect

pull-request-simple:
type: object
title: Pull Request Simple
properties:
labels:
type: array
items:
properties:
description:
type: string

correct

pull-request:
type: object
title: Pull Request
properties:
labels:
type: array
items:
properties:
description:
type:
- string
- 'null'
Expected
change the repo field to oneof repository / type: null

Reproduction Steps
list pull request using curl -X GET https://api.github.com/repos/apache/pulsar/pulls?state=open

Related to https://github.com/yanyongyu/githubkit/issues/7

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.