OAI / OAI/OpenAPI-Specification
Link Object (and Arazzo?): require referencing operation with unambiguous path template
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Markdown
- Sterne
- 31.2k
- Forks
- 9.2k
- Ø Merge
- 6 Std. 37 Min.
- Gemergte PRs (30 T.)
- 27
Beschreibung
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 /fooorGET /bar
Proposal:
- Add restriction to Link Object that
operationRefandoperationIdMUST NOT reference a reusable/multi-used Path Item Object - Possibly: require that the
operationRefvalue "goes through" a Paths Object
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginnen Sie mit dem Lesen der Definitionen von Link Object und Arazzo operationRef und vergleichen Sie sie anschließend mit dem in der Spezifikation beschriebenen Verhalten von Paths Object und wiederverwendbaren Path Item Objects. Als erledigt gilt die Aufgabe, wenn die Spezifikation eindeutig definiert, ob operationRef und operationId auf wiederverwendete Path Item Objects verweisen dürfen und wie ein eindeutiger Request-Pfad bestimmt wird.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- openapi
- Bereich
- api, documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Ruhig
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100