interpretation of openapi readOnly flag in model

Aperta
#334 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
java, openapi, spring-boot
Ambito
backend-api-design, tooling

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.

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.

See: https://fasterxml.github.io/jackson-annotations/javadoc/2.6/com/fasterxml/jackson/annotation/JsonProperty.Access.html

Lingua principale
Kotlin
Stelle
56
Fork
11
Merge medio
2g 4h
PR unite (30g)
8

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di openapi-processor/openapi-processor-spring

Tutte le issue di openapi-processor/openapi-processor-spring

Issue simili

Altre issue su Kotlin

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.