[Schema Inaccuracy] `GET /repos/{owner}/{repo}/contents/{path}` spec is missing raw+json / html+json response media types

Aperta
#6,089 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
45/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
openapi
Ambito
api

Direzione di ricerca

Inizia individuando la definizione OpenAPI per GET /repos/{owner}/{repo}/contents/{path} e confronta la relativa risposta 200 con la documentazione REST API collegata. Aggiungi i tipi di media raw+json e html+json con gli schemi mostrati nell’issue per tutte le varianti fpt, ghec e ghes-*, quindi verifica che le definizioni dell’endpoint siano coerenti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation

Schema Inaccuracy

The Get repository content docs list these custom media types for that path, but the structured schema doesn't have them:

  • application/vnd.github.raw+json – Returns the raw file contents for files and symlinks.
  • application/vnd.github.html+json – Returns the file contents in HTML (e.g. via GitHub's Markup library).

The description currently only includes application/json and application/vnd.github.object for the 200 response.

Expected

{
  "paths": {
    "/repos/{owner}/{repo}/contents/{path}": {
      "get": {
        "responses": {
          "200": {
            "content": {
              "application/json": { "...": "..." },
              "application/vnd.github.object": { "...": "..." },
              "application/vnd.github.raw+json": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              },
              "application/vnd.github.html+json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Reproduction Steps

This applies to all variants:

  • fpt
  • ghec
  • ghes-*
Lingua principale
Nessun dato sulla lingua
Stelle
1.6k
Fork
342
Merge medio
3h 33m
PR unite (30g)
51

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di github/rest-api-description

Tutte le issue di github/rest-api-description

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.