grpc-ecosystem/grpc-gateway

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

Open

#3.696 aberto em 26 de out. de 2023

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)Go (2.250 forks)batch import
bughelp wantedopenapi

Métricas do repositório

Stars
 (16.971 stars)
Métricas de merge de PR
 (Mesclagem média 1d 4h) (141 fundiu PRs em 30d)

Description

🐛 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".

Guia do colaborador

Direção de pesquisa
Examine o arquivo template.go no diretório protoc gen openapiv2 para localizar onde collectionFormat está codificado como 'multi'. Revise o tratamento da opção repeated path param separator para garantir a propagação adequada. Verifique quaisquer testes existentes para geração de parâmetros de caminho e confirme se a correção produz a especificação OpenAPI correta.
Pilha de tecnologia
go
Domain
api
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Go programmingprotoc gen openapiv2 template understanding
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75