OAI / OAI/OpenAPI-Specification
Supporting of one separate 'required' option for query parameters
Nessuno ha ancora preso questa issue.
- Lingua principale
- Markdown
- Stelle
- 31.2k
- Fork
- 9.2k
- Merge medio
- 6h 37m
- PR unite (30g)
- 27
Descrizione
Hi!
For example, there are several paths that include similar parameters, but with different required options: in some paths parameters are required, in others they are optional.
If we can specify the required option separately, we can reuse parameter descriptions. Like this:
/api/v1/rootname:
get:
summary: 'Path example'
parameters:
- $ref: '#/components/parameters/queryFiltersDateFrom'
- $ref: '#/components/parameters/queryFiltersDateTo'
- $ref: '#/components/parameters/queryGroups'
- $ref: '#/components/parameters/queryOrderByColumn'
- $ref: '#/components/parameters/queryOrderByDirection'
required:
- 'filters[date_from]'
- 'filters[date_to]'
- 'groups'
- 'order_by_column'
- 'order_by_direction'
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
Inizia esaminando lo YAML proposto nell’issue e le regole di OpenAPI per i Parameter Objects riutilizzabili, i parametri delle operazioni e la proprietà required. Poiché non sono indicati file del repository né test, individua prima le sezioni della specifica e le discussioni correlate. Il lavoro sarà completato quando sarà disponibile un modello concordato per la gestione separata dell’obbligatorietà e saranno presenti i corrispondenti aggiornamenti della specifica o della validazione.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- openapi
- Ambito
- api
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 30/100