openapi-processor / openapi-processor/openapi-processor-spring
interpretation of openapi readOnly flag in model
Nessuno ha ancora preso questa issue.
- Lingua principale
- Kotlin
- Stelle
- 56
- Fork
- 11
- Merge medio
- 2g 4h
- PR unite (30g)
- 8
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Nell’issue non sono identificati file sorgente, test o punti di ingresso. Inizia tracciando il modo in cui il generatore associa le proprietà readOnly di OpenAPI alle annotazioni di accesso di Jackson, quindi determina dove dovrebbe essere configurata un’opzione di generazione provider-versus-client e definisci test che coprano entrambe le modalità.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- java, openapi, spring-boot
- Ambito
- backend-api-design, tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100