grpc-ecosystem/grpc-gateway

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

Aperta

#3696 aperta il 26 ott 2023

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

Metriche repository

Star
 (16.971 stelle)
Metriche merge PR
 (Merge medio 8g 23h) (147 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
Ispeziona il file template.go nella directory protoc gen openapiv2, individua dove collectionFormat è hardcodato come 'multi' e comprendi come l'opzione repeated path param separator dovrebbe influenzare l'output. Controlla la gestione dell'opzione nella logica del generatore.
Tech stack
go
Dominio
apibackend
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Goprotoc
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60