Support OpenAPI 3.1/3.2 $dynamicRef resolution with ApiDOM

Aperta
  • Qualcosa non va?
#4,223 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
javascript, openapi
Ambito
api

Direzione di ricerca

Inizia con la issue di supporto del core ApiDOM #5176 indicata, poi esamina gli esempi di dynamic-ref nell’adoption tracker e il resolver esistente di Swagger Client. Il lavoro è completato quando gli schemi dynamicRef vengono risolti con il contesto completo del documento OpenAPI, i riferimenti ai componenti locali alla radice rimangono compatibili con valori $id assoluti e viene aggiunta una copertura di regressione per la forma dello schema di risposta.

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

Descrizione

Summary

Proposed Swagger Client resolver work for OpenAPI 3.1/3.2 $dynamicRef schemas using ApiDOM. This issue is linked from the broader Swagger UI coordination issue so the prerequisite relationship is visible.

Reference implementation / showcase

The showcase repository includes OpenAPI examples used to validate that dynamic response envelopes and root-local #/components/... refs resolve as expected.

Related issues

  • Related coordination issue: swagger-api/swagger-ui#10912
  • Depends on ApiDOM core support: swagger-api/apidom#5176
  • Related user-facing Swagger UI bug: swagger-api/swagger-ui#10651
  • Related non-blocking Swagger UI display enhancement: swagger-api/swagger-ui#10913

Proposed scope

  • Delegate schemas with $dynamicRef to ApiDOM's dereference logic.
  • Resolve with full OpenAPI document context where dynamic scope requires root-level context.
  • Preserve compatibility for root-local #/components/... refs inside schemas that also declare absolute $id values.
  • Add regression coverage for a dynamic-ref response schema shape.
Lingua principale
JavaScript
Stelle
2.7k
Fork
764
Merge medio
1g 10h
PR unite (30g)
8

Preparare l'ambiente

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 swagger-api/swagger-client

Tutte le issue di swagger-api/swagger-client

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.