OAI / OAI/OpenAPI-Specification

Link Object (and Arazzo?): require referencing operation with unambiguous path template

Aperta
#4,084 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

bug re-use: ref/id resolution
Lingua principale
Markdown
Stelle
31.2k
Fork
9.2k
Merge medio
6h 37m
PR unite (30g)
27

Descrizione

Assume paths /foo and /bar both have a Path Item Object that $ref the same external "complete" Path Item Object.

If a Link Object now operationRefs the get Operation Object within that external Path Item Object, which request should the client construct?

It could be both

  • GET /foo or
  • GET /bar

Proposal:

  • Add restriction to Link Object that operationRef and operationId MUST NOT reference a reusable/multi-used Path Item Object
  • Possibly: require that the operationRef value "goes through" a Paths Object

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.

Direzione di ricerca

Inizia leggendo le definizioni di Link Object e Arazzo operationRef, quindi confrontale con il comportamento di Paths Object e dei Path Item riutilizzabili descritto nella specifica. Il lavoro è completato quando la specifica definisce chiaramente se operationRef e operationId possono puntare a Path Item Objects riutilizzati e come viene determinato un percorso di richiesta non ambiguo.

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

Valutazione

Stack tecnologico
openapi
Ambito
api, documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.