Provide guidance on using OAS with Overlay and Arazzo
Maintainer antworten meist innerhalb von 1 Tag
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Anfängerfreundlichkeit
- 35/100
- Issue-Typ
- Dokumentation
- Klarheit
- Muss geklärt werden
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- markdown
- Bereich
- documentation
Rechercherichtung
Beginne mit dem Vergleich des OAS Link Object mit den Spezifikationen Arazzo und Overlay und konzentriere dich dabei auf die im Issue beschriebenen Anwendungsfälle. Als abgeschlossen gilt die Aufgabe, wenn klare OAS-Leitlinien dazu hinzugefügt wurden, wann welche Spezifikation verwendet werden soll, einschließlich globaler oder Standardwerte und reference-and-modify-Konstrukten.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Many long-requested features for OAS can now be better handled by using the Overlay and/or Arazzo specifications.
I think Arazzo mostly overlaps with the Link Object, but I might be wrong there. Some guidance as to when to use which would probably be good to add.
Overlays solve many requests for global or default values, and if it is reasonably straightforward to do that, we should include info in the OAS pointing to the Overlay spec for that use case. Other use cases include various reference-and-modify constructs (hmm.. do we want to consider pushing this instead of the adjacent-fields-in-Reference-Object approach?)
Putting this in the next patch release, although there may be additional things to do in minor releases here.
- Vorherrschende Sprache
- Markdown
- Sterne
- 31.2k
- Forks
- 9.2k
- Ø Merge
- 2 T. 9 Std.
- Gemergte PRs (30 T.)
- 17
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Beitragsleitfaden lesen
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus OAI/OpenAPI-Specification
-
Housekeeping
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 45/100
OAI/OpenAPI-Specification#5566 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Housekeeping
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 35/100
OAI/OpenAPI-Specification#5562 · 4 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
Housekeeping
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 10/100
OAI/OpenAPI-Specification#5556 · 3 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
-
v3.2.1 releaseEvtl. wieder frei @lornajane hat das vor 33 Tagen übernommen, und es ist kein Pull Request offen. Offen
OAI/OpenAPI-Specification#5460 · 11 Kommentare · 1 Reaktion · 1 zugewiesene Person ·
Maintainer antworten meist innerhalb von 1 Tag
-
param serialization
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
OAI/OpenAPI-Specification#5366 · 12 Kommentare ·
Maintainer antworten meist innerhalb von 1 Tag
Alle Issues in OAI/OpenAPI-Specification
Ähnliche Issues
-
add bootmlmOffen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 62/100
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
Maintainer antworten meist innerhalb von 1 Tag
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 78/100
aws-samples/sample-per-model-bedrock#191 ·
Maintainer antworten meist innerhalb von 1 Tag
-
Docs viewer: inverted grey colormap, Phantom CT window -20 to 35 HU, smoothing up to 40 mmEvtl. vergeben Ein verknüpfter Pull Request ist offen oder bereits gemergt. Offenarea: docs enhancement
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 64/100
PyTomography/PyTomography#331 ·
Maintainer antworten meist innerhalb von 1 Tag
-
content 📄 needs triage 🤔
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
Qiskit/documentation#5790 ·
Maintainer antworten meist innerhalb von 1 Tag