OAI / OAI/OpenAPI-Specification

Allow required as sibling of $ref (like summary/description)

Aperta
#2,498 5 commenti 19 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

param serialization re-use: traits/merges
Lingua principale
Markdown
Stelle
31.2k
Fork
9.2k
Merge medio
6h 37m
PR unite (30g)
27

Descrizione

Hello,

it would be great for reusability if I could overwrite the required field of parameter and header objects, like I can overwritesummary and description in OpenAPI 3.1.

paths:
  /my-resource:
    parameters:
      - $ref: '#/components/parameters/Accept'
        required: true
    get:
      # some definition

components:
  parameters:
    Accept:
      name: Accept
      in: header
      required: false
      schema:
        type: string

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Inizia con le regole di OpenAPI 3.1 per Parameter e Header Objects, quindi confronta come sono specificate le sovrascritture di summary e description tra elementi fratelli. Determina se required può essere sovrascritto accanto a $ref e documenta il comportamento risultante della specifica; il lavoro è completo quando la regola è non ambigua e coerente con le indicazioni esistenti per i Reference Objects.

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
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.