OAI / OAI/OpenAPI-Specification
Inconsistency in runtime expression examples for request headers
Nessuno ha ancora preso questa issue.
- Lingua principale
- Markdown
- Stelle
- 31.2k
- Fork
- 9.2k
- Merge medio
- 6h 37m
- PR unite (30g)
- 27
Descrizione
Runtime expression examples include the following:
| Source Location | example expression | notes |
|---|---|---|
| Requested media type | $request.header.accept |
|
| Request parameter | $request.path.id |
Request parameters MUST be declared in the parameters section of the parent operation or they cannot be evaluated. This includes request headers. |
The 2nd example says that headers MUST be defined as parameters. But the 1st example refers to the Accept header which is not allowed in parameters.
Is $request.header.accept is an invalid example? Or are runtime expressions supposed to access any request headers?
Similarly, the section about callback path keys provides an example with the Content-Type header:
$request.header.content-Type application/json
Like Accept, Content-Type is not allowed in parameters. Is this example valid or not?
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 gli esempi di espressioni di runtime e la sezione sulle chiavi del percorso di callback in versions/3.0.0.md, insieme alla sezione referenziata sui campi fissi dei parametri. Per prima cosa confronta gli esempi con le regole dei parametri indicate. Il lavoro è completato quando è stato stabilito se gli esempi degli header sono validi e il testo della specifica è stato aggiornato in modo coerente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 28/100