Indicate that parameterObject has dynamic enum ?

Aperta
#2,313 2 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Ambito
backend-api-design

Direzione di ricerca

Inizia dalla sezione collegata OpenAPI 3.0.2 Parameter Object e confronta le relative regole per enum e $ref con gli esempi proposti di dynamic-enum. Determina se la specifica debba supportare valori enum richiesti da remoto; per considerare completata l'attività è necessaria una proposta definita e conforme alla specifica, non solo un'implementazione.

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

Descrizione

param serialization schema-object

I try to have a parameter, which enum values has to be requested from different endpoint. So I haven't found any way how I could do it in specification. I though about 2 ways or I indicate that enum is dynamic with additionalProperties or I use $ref as value for enum attribute but not sure if this will be with accordance to specification ?

https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject

{
  "in": "query",
  "name": "name",
  "$ref" : "#/paths/enums/name",
  "schema": {
    "type": "object",
    "additionalProperties": {
       "dynamicEnum": "bool"
    },
    "enum": {"$ref" : "#/paths/enums/name"}
  }
}

Any thoughts ?

Lingua principale
Markdown
Stelle
31.2k
Fork
9.2k
Merge medio
6h 37m
PR unite (30g)
27

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.

Altre issue di OAI/OpenAPI-Specification

Tutte le issue di OAI/OpenAPI-Specification

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.