Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[Schema Inaccuracy] Response for "/repos/{owner}/{repo}/replicas/caches" has incompatible example

Open
#4,590 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Search the OpenAPI description for the JSON reference ending in responses/200/content/application~1json/examples/default/value and inspect the /repos/{owner}/{repo}/replicas/caches response example. Make the git example conform to the stated object schema, or update the schema if the API returns a list, then validate the affected description.

Written by the indexing model from the issue text.

Description

feature fundamentals-and-support

Schema Inaccuracy

This is the json ref:

#/paths/~1repos~1{owner}~1{repo}~1replicas~1caches/get/responses/200/content/application~1json/examples/default/value

The field spec is

                      "git": {
                        "type": "object",
                        "properties": {
                          "sync_status": {
                            "type": "string",
                            "enum": [
                              "offline",
                              "inactive",
                              "in_sync",
                              "not_in_sync"
                            ]
                          },
                          "last_sync": {
                            "type": "string",
                            "format": "date-time"
                          }
                        },
                        "required": [
                          "sync_status",
                          "last_sync"
                        ]
                      }

The example is

                        "git": [
                          {
                            "sync_status": "in_sync"
                          },
                          {
                            "last_sync": "2022-01-10T19:33:52Z"
                          }
                        ]

I looked at GHES-3.12, GHES-3.13, GHES-3.14, GHES-3.15.

Expected

The example should have an object or the type spec should have a list.

Reproduction Steps

Dominant language
No language data
Stars
1.6k
Forks
342
Avg merge
2h 23m
Merged PRs (30d)
57

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.