Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Provide guidance on using OAS with Overlay and Arazzo

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

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
markdown
Ambito
documentation

Direzione di ricerca

Inizia confrontando l’OAS Link Object con le specifiche Arazzo e Overlay, concentrandoti sui casi d’uso descritti nell’issue. Il lavoro è completato quando viene aggiunta una guida chiara di OAS su quando utilizzare ciascuna specifica, inclusi i valori globali o predefiniti e i costrutti reference-and-modify.

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

Descrizione

clarification

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.

Lingua principale
Markdown
Stelle
31.2k
Fork
9.2k
Merge medio
2g 9h
PR unite (30g)
17

Preparare l'ambiente

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 OAI/OpenAPI-Specification

Tutte le issue di OAI/OpenAPI-Specification

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.