openapi-processor / openapi-processor/openapi-processor-spring
interpretation of openapi readOnly flag in model
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Kotlin
- Sterne
- 56
- Forks
- 11
- Ø Merge
- 2 T. 4 Std.
- Gemergte PRs (30 T.)
- 8
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
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.
Bewertung
- Tech-Stack
- java, openapi, spring-boot
- Bereich
- backend-api-design, tooling
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100