grpc-ecosystem/grpc-gateway

[protoc-gen-openapiv2] Incorrectly generated OpenAPIv2 spec when using repeated_path_param_separator option

Open

#3696 aperta il 26 ott 2023

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Go (2250 fork)batch import
bughelp wantedopenapi

Metriche repository

Star
 (16.971 star)
Metriche merge PR
 (Merge medio 1g 4h) (141 PR mergiate in 30 g)

Descrizione

🐛 Bug Report

When I use repeated_path_param_separator option with any value I get result in my documentation where "collectionFormat": "multi". I found what in template.go you force set 'multi' to "collectionFormat".

Guida contributor

Direzione di ricerca
Esamina il file template.go nella directory protoc gen openapiv2 per individuare dove collectionFormat è hardcoded a 'multi'. Rivedi la gestione dell'opzione repeated path param separator per assicurarti che venga propagata correttamente. Controlla eventuali test esistenti per la generazione dei parametri di percorso e verifica che la correzione produca una specifica OpenAPI corretta.
Tech stack
go
Dominio
api
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Go programmingprotoc gen openapiv2 template understanding
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75