interpretation of openapi readOnly flag in model

Offen

#334 erstellt am 08.4.2025 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit: 5/5
Geschätzter Aufwand: Über eine Woche
Anfängerfreundlichkeit: 35/100

Issue-Typ: Feature
Klarheit: Größtenteils klar
Aktivitätsstatus: Veraltet
Tech-Stack: java, openapi, spring-boot
Bereich: backend-api-design, tooling

Rechercherichtung

Im Issue sind keine Quelldateien, Tests oder Einstiegspunkte identifiziert. Beginne damit nachzuverfolgen, wie der Generator OpenAPI-readOnly-Eigenschaften auf Jackson-Zugriffsannotationen abbildet, ermittle dann, wo eine Provider-gegen-Client-Generierungsoption konfiguriert werden sollte, und definiere Tests, die beide Modi abdecken.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

Vorherrschende Sprache: Kotlin
Sterne: 56
Forks: 11
Ø Merge: 2 T. 4 Std.
Gemergte PRs (30 T.): 8

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
Forken Sie das Repository und arbeiten Sie in einem Branch.
Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus openapi-processor/openapi-processor-spring

Inheritance support Offen

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 20/100

openapi-processor/openapi-processor-spring#159 · 1 Kommentar · Erstellt am 21.3.2023
Support complex generic type response mapping procesing Offen

enhancement

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 42/100

openapi-processor/openapi-processor-spring#150 · 3 Kommentare · Erstellt am 13.12.2022
multiple endpoints for xor query parameters Offen

undecided

Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100

openapi-processor/openapi-processor-spring#101 · 1 Kommentar · Erstellt am 27.4.2020
log unknown options Offen

enhancement undecided

Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 35/100

openapi-processor/openapi-processor-spring#51 · Erstellt am 02.1.2020

Alle Issues in openapi-processor/openapi-processor-spring