Skip to content

[Java] [JavaJaxRS] Respect readOnly/writeOnly attribute markers #9221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Conversation

mickroll
Copy link
Contributor

@mickroll mickroll commented Apr 9, 2021

Fixes #9222

Generate jackson JsonProperty like following:

  • readOnly is present in Spec: @JsonProperty(value = "[name]", access = JsonProperty.Access.READ_ONLY)
  • writeOnly is present in Spec: @JsonProperty(value = "[name]", access = JsonProperty.Access.WRITE_ONLY)

Edge case: both are present -> Spec is invalid and generator cancels anyway with:

org.openapitools.codegen.SpecValidationException: There were issues with the specification. The option can be disabled via validateSpec (Maven/Gradle) or --skip-validate-spec (CLI).
| Error count: 1, Warning count: 1
Errors:
-attribute components.schemas.Example. writeOnly and readOnly are both present

@nmuesch

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master, 5.1.x, 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Generate jackson JsonProperty like following:
- `readOnly` is present in Spec: `@JsonProperty(value = "[name]", access = JsonProperty.Access.READ_ONLY)`
- `writeOnly` is present in Spec: `@JsonProperty(value = "[name]", access = JsonProperty.Access.WRITE_ONLY)`

Edge case: both are present -> Spec is invalid and generator cancels anyway with:
> org.openapitools.codegen.SpecValidationException: There were issues with the specification. The option can be disabled via validateSpec (Maven/Gradle) or --skip-validate-spec (CLI).
> | Error count: 1, Warning count: 1
> Errors: 
>	-attribute components.schemas.Example. writeOnly and readOnly are both present
@wing328 wing328 changed the base branch from 5.2.x to master April 16, 2021 03:51
@wing328 wing328 requested a review from jimschubert as a code owner April 16, 2021 03:51
@wing328 wing328 changed the base branch from master to 5.2.x April 16, 2021 03:52
@wing328
Copy link
Member

wing328 commented Apr 16, 2021

Samples updated via d42cda0

@wing328
Copy link
Member

wing328 commented Apr 16, 2021

I think this change can target the current master as it's not a breaking changes (more like a fix to me)

I'll create a new PR, cherry-pick your commit and then file a new PR targeting master instead.

@wing328
Copy link
Member

wing328 commented Apr 16, 2021

Closed via #9276

@wing328 wing328 closed this Apr 16, 2021
@mickroll mickroll deleted the patch-1 branch April 27, 2021 10:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants