array return types get assigned names that contain special characters, breaking tooling
Mantenedores costumam responder em até 9 dias
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Facilidade para iniciantes
- 45/100
- Tipo de issue
- Bug
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- java, openapi, spring, spring-boot
- Domínio
- api, backend-api-design
Direção de pesquisa
Start by tracing how springdoc derives OpenAPI schema component names for the shown ResponseEntity<ResponseEnvelope<Foo[]>> return type, then check the related schema naming tests. Reproduce the generated ResponseEnvelopeFoo[] name and determine whether the issue calls for changing that name or adding the suggested configuration and warning. Done means the chosen behavior is covered by a regression test; the issue does not name a file or test.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
this code:
// Foo[] is BAD and breaks our action!
@GetMapping
public ResponseEntity<ResponseEnvelope<Foo[]>> getFoos() {
...
}
gets parsed into this:
"ResponseEnvelopeFoo[]": {
"type": "object",
"properties": {
"status": { "type": "string", "enum": ["OK", "ERROR"] },
"httpCode": { "type": "integer", "format": "int32" },
"data": {
"type": "array",
"items": { "$ref": "#/components/schemas/Foo" }
},
"error": { "$ref": "#/components/schemas/ErrorDetails" }
}
}
which is of course valid json and allowed by the openapi spec, but it did break my tooling and it took me a good hour to figure out what happened.
if you don't consider this a bug and don't want to break backwards compatibility for this i understand, maybe add a configuration option <entityNamesMayContainSpecialCharacters>false</entityNamesMayContainSpecialCharacters> and add a console warning if an entity like this is generated? cheers
- Linguagem predominante
- Java
- Estrelas
- 3.7k
- Forks
- 605
- Merge médio
- 9d 11h
- PRs com merge (30d)
- 14
Preparar o ambiente
Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de springdoc/springdoc-openapi
-
enhancement upstream
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 48/100
springdoc/springdoc-openapi#3324 · 2 comentários ·
Mantenedores costumam responder em até 9 dias
-
enhancement upstream
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 55/100
springdoc/springdoc-openapi#3309 · 4 comentários · 1 reação ·
Mantenedores costumam responder em até 9 dias
Todas as issues de springdoc/springdoc-openapi
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
scylladb/scylla-cdc-source-connector#402 ·
Mantenedores costumam responder em até 1 dia
-
enhancement
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
Mantenedores costumam responder em até 1 dia
-
bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 64/100
Mantenedores costumam responder em até 1 dia
-
enhancement good first issue
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
ahmedmmordi/store-app#8 ·
-
jhipster heroku fails on heroku git:remote when reusing an existing app outside a git repositoryAbertaarea: triage theme: undefined
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
jhipster/generator-jhipster#36018 ·
Mantenedores costumam responder em até 1 dia