[Schema Inaccuracy] Example and schema mismatch at patch-schema

Aperta Adatta ai principianti
#4,470 2 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
65/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
json, openapi
Ambito
api

Direzione di ricerca

Apri descriptions-next/ghes-3.13/ghes-3.13.json e analizza lo schema e le posizioni degli esempi indicate nel report. Confronta la definizione del valore della patch operation con l’esempio addMembers, aggiorna uno dei due lati in modo che corrispondano e verifica che l’esempio venga analizzato rispetto allo schema.

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

Descrizione

documentation

Schema Inaccuracy

The schema at this location is

#/components/schemas/patch-schema/properties/Operations/items/properties/value

                "value": {
                  "type": "string",
                  "description": "Corresponding 'value' of that field specified by 'path'"
                }

The example at is

#/paths/~1scim~1v2~1enterprises~1{enterprise}~1Groups~1{scim_group_id}/patch/requestBody/content/application~1json/examples/addMembers/value

          {
            "Operations" : [ {
              "op" : "add",
              "path" : "members",
              "value" : [ {
                "value" : "879db59-3bdf-4490-ad68-ab880a2694745"
              }, {
                "value" : "0db508eb-91e2-46e4-809c-30dcbda0c685"
              } ]
            } ],
            "schemas" : [ "urn:ietf:params:scim:api:messages:2.0:PatchOp" ]
          }

The value cannot be parsed.

Expected

Either the example or schema is updated to match the other.

Reproduction Steps

This has been observed on

https://github.com/github/rest-api-description/raw/main/descriptions-next/ghes-3.13/ghes-3.13.json

I've checked for this in 3.10, 3.11, 3.12, 3.13, 3.14.

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.