Duplicate model names generated for FlowSegment, FlowSegmentPost and DeletionRequest

Aperta
#201 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
70/100
Tipo di issue
Bug
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Stack tecnologico
openapi
Ambito
api

Direzione di ricerca

Inizia da TimeAddressableMediaStore.yaml e individua le registrazioni degli schemi radice, oltre a ogni $ref diretto a schemas/.json. Consolida gli schemi denominati sotto components/schemas, aggiorna questi riferimenti e rigenera gli stub del server con openapitools/openapi-generator-cli; il lavoro è completato quando ciascuno tra FlowSegment, FlowSegmentPost e DeletionRequest produce un modello senza duplicati numerati.

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

Descrizione

Describe the bug
When generating server stubs from TimeAddressableMediaStore.yaml using openapitools/openapi-generator-cli, three schemas produce duplicate model pairs: FlowSegment / FlowSegment1, FlowSegmentPost / FlowSegmentPost1, and DeletionRequest / DeletionRequest1. Both models in each pair are structurally identical. A developer implementing the server traits has no clear basis for choosing between them.

Expected behavior
Each schema should produce a single, consistently named model.

Suggested fix
Register each schema once in components/schemas in the root YAML and replace all direct $ref: schemas/<file>.json usage sites with $ref: '#/components/schemas/<Name>'. The generator deduplicates schemas keyed on their components/schemas path, so all references to the same entry resolve to one model.

Additional context
The root cause is that the same external schema file is referenced at multiple distinct YAML paths. The generator resolves each path independently and treats them as separate schemas. This is a spec convention issue rather than a generator bug — using components/schemas is the intended OpenAPI pattern for shared, reusable schemas.

Lingua principale
Makefile
Stelle
117
Fork
13
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

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 bbc/tams

Tutte le issue di bbc/tams

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.