OAI / OAI/OpenAPI-Specification

Consolidated $ref-to-Some Object feature request

Aperta
#3,853 8 commenti 7 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

re-use: ref-everywhere
Lingua principale
Markdown
Stelle
31.2k
Fork
9.2k
Merge medio
6h 37m
PR unite (30g)
27

Descrizione

This issure consolidates and replaces the numerous "can the OAS allow $ref for..." issues:

  • Security Requirement: OAI/OpenAPI-Specification#1850
  • Security Scheme: OAI/OpenAPI-Specification#1972 (but see also OAI/OpenAPI-Specification#3776 for an alternative)
  • Server: OAI/OpenAPI-Specification#2338
  • Tags: OAI/OpenAPI-Specification#2905
  • Operation: OAI/OpenAPI-Specification#2922 (but note that there are impacts on finding and resolving operationId)
  • Media Type: OAI/OpenAPI-Specification#3056 (closed because the specific use case is handled by overriding description with a Reference Object); also OAI/OpenAPI-Specification#2845 although there is more to that one)
  • Contact: OAI/OpenAPI-Specification#3552
  • License: OAI/OpenAPI-Specification#3569

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 esaminando le issue collegate relative a Security Requirement, Security Scheme, Server, Tags, Operation, Media Type, Contact e License per comprendere i singoli casi d’uso e le alternative. Definisci le modifiche necessarie alla specifica per supportare $ref per questi oggetti, inclusi gli impatti indicati su operationId; il lavoro è completato quando i casi rilevanti sono risolti in modo coerente nella OpenAPI Specification.

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à
Tranquilla
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.