OAI / OAI/OpenAPI-Specification
Structural improvements: enhance headers handling
Nessuno ha ancora preso questa issue.
- Lingua principale
- Markdown
- Stelle
- 31.2k
- Fork
- 9.2k
- Merge medio
- 6h 37m
- PR unite (30g)
- 27
Descrizione
Following (again) ideas from OAI/OpenAPI-Specification#563 and OAI/sig-moonwalk#115, extending OAI/OpenAPI-Specification#369:
- define reusable response headers (like parameters or definitions as proposed in OAI/OpenAPI-Specification#563 by @fehguy )
- set responses headers on each level: whole api, path, operation, responses (and response as stated in OAI/OpenAPI-Specification#369)
paths:
responseHeaders:
# Headers returned on all api responses
/resources:
responseHeaders:
# Headers returned on all /resources operations responses
get:
responseHeaders:
# Headers returned on all operations responses
200:
headers:
# Headers returned on this response
schemas:
responseHeaders:
# reusable headers describe with a Header Object, used with $ref
The problem is the naming consistency: responseHeaders almost everywhere vs headers on response level.
What if we use headers or responseHeaders everywhere?
nb: and don't forget to modify Header Object to include OAI/OpenAPI-Specification#321 (required)
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Esamina le issue collegate di OpenAPI Specification #563, #115, #369 e #321, quindi confronta le posizioni proposte per responseHeaders e headers in questa issue. Determina la denominazione coerente e i requisiti di Header Object prima di modificare la specifica. Il lavoro è completato quando la proposta strutturale e il comportamento degli header richiesti sono risolti e documentati in modo coerente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- openapi
- Ambito
- api, backend-api-design
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 25/100