openapi-processor / openapi-processor/openapi-processor-spring
interpretation of openapi readOnly flag in model
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Kotlin
- Estrelas
- 56
- Forks
- 11
- Merge médio
- 2d 4h
- PRs com merge (30d)
- 8
Descrição
Given a definition like:
``yaml
Data:
type: object
properties:
status:
type: string)
readOnly: true
get generated java:
```java
public record Data {
@JsonProperty(value = "status", access = JsonProperty.Access.READ_ONLY)
String status
) {}
This is correct if the generated code is for the provider of the interface (i.e. server-side). But if the code is to be the client of the interface, the field should instead be annotated with JsonProperty.Access.WRITE_ONLY.
So, as a feature request, it would be useful if there was a code generation option that declared the intended usage of the generated code.
Guia de contribuição
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.
Direção de pesquisa
Nenhum arquivo-fonte, teste ou ponto de entrada é identificado na issue. Comece rastreando como o gerador mapeia as propriedades readOnly do OpenAPI para as anotações de acesso do Jackson; depois, determine onde uma opção de geração provider-versus-client deve ser configurada e defina testes que cubram ambos os modos.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- java, openapi, spring-boot
- Domínio
- backend-api-design, tooling
- Tipo de issue
- Funcionalidade
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100