Generate setters for readonly properties in server code #1582

tsiq-karold · 2018-11-30T13:09:44Z

PR checklist

Read the contribution guidelines.
Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
Filed the PR against the correct branch: master, 3.4.x, 4.0.x. Default: master.
Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

I explored a couple of other alternatives, namely passing the tag (i.e. CodegenType) to the template and switching there or adding another property to the data passed to the template to indicate that a setter should be generated. Unfortunately, they didn't really work or were horrendously messy.

Please note I have run only ./bin/jaxrs-petstore-server.sh which generated new methods which can be seen in this PR and ./bin/java-petstore-jersey2.sh which generated no changes as expected. This change does impact all generators and I ran ./bin/run-all-petstore locally successfully but the message that printed said not to run it. It also changed some 900 files under samples which I thought would massively pollute this PR. Happy to do that if it's necessary though.

tsiq-karold · 2018-11-30T13:15:42Z

The build failure in Travis seems totally unrelated to my change and I see it across a number of PRs.

tsiq-karold · 2018-11-30T14:06:05Z

Looks like I'll need to run all the petstore samples as their differences fail the CircleCI build. How is this normally handled? It's going to generate a PR with ~900 files changed when the actual change is in one class.

tsiq-karold · 2018-12-20T11:13:05Z

Can someone take a look at this PR please?

wing328 · 2019-01-22T17:17:01Z

@tsiq-karold sorry that I miss your message earlier. I'll have a look tomorrow.

cc @bbdouglas (2017/07) @JFCote (2017/08) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01)

wing328 · 2019-01-22T17:18:35Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultGenerator.java

@@ -480,6 +480,10 @@ private Model getParent(Model model) {
                    }
                }

+                if (config.getTag() == CodegenType.SERVER) {


@tsiq-karold Shall we use .equals() instead of == for string comparision?

These aren't strings, CodegenType is an enum.

Ah you're right. Completely forgot about that.

wing328 · 2019-01-22T17:25:49Z

modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultGenerator.java

+            CodegenModel model = (CodegenModel) modelTemplate.get("model");
+
+            if (model != null && model.vars != null) {
+                model.vars.forEach((var) -> var.isReadOnly = false);


Here is the definitoin of readOnly in OAS v3:

Relevant only for Schema "properties" definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is marked as readOnly being true and is in the required list, the required will take effect on the response only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false.

Instead of forcing all readOnly to false in all model's properties, what about updating the server's model templates instead to remove isReadOnly mustache tag? e.g. https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/JavaJaxRS/pojo.mustache#L90

That would also work although it's then a change that has to be applied per language and potentially library. It would at least solve my problem with updating petstore 😄

…s server template

tsiq-karold · 2019-01-23T15:44:50Z

Hi @wing328, this should be good to review again. I followed your suggested approach and have updated the relevant petstore generated files.

cbornet · 2019-01-23T21:09:45Z

LGTM

tsiq-karold · 2019-02-12T14:43:23Z

@wing328 any chance we could get this into 4.0.0?

wing328 · 2019-03-31T09:11:35Z

@tsiq-karold sorry missed your reply. I've just merged it. Thanks again for the contribution.

@karismann

* master: (48 commits) [Typescript AngularJS] fix Extra package prefix in api parameters operations (OpenAPITools#2522) OpenAPITools#1023 - [Scala] Use status family during response processing (OpenAPITools#1024) Generate setters for readonly properties in server code (OpenAPITools#1582) [JS] fix NPE for null string and improve Travis config file (OpenAPITools#2553) [elm] Update ISO 8601 library (fixes missing time zone designator) (OpenAPITools#2545) [csharp] update sample after OpenAPITools#2528 (OpenAPITools#2550) [JavaScript] fix index.js, ApiClient.js and test files generated to incorrect location (OpenAPITools#2511) Aspnetcore nullable support (OpenAPITools#2529) Csharp nullable support (OpenAPITools#2528) [C++] [Qt5] Add enum support for client and server (OpenAPITools#2339) Fixed typo in migration-from-swagger-codegen.md (OpenAPITools#2548) [TypeScript Client] fix install Aurelia + fix use deprecated function (OpenAPITools#2514) [KOTLIN] fix var name not correctly sanitized (OpenAPITools#2537) Update swagger-parser to '2.0.11-OpenAPITools.org-1' (OpenAPITools#2262) Add @karismann to Java and Kotlin technical committee (OpenAPITools#2542) Add GoDaddy to the list of companies using OpenAPI Generator (OpenAPITools#2541) [Kotlin SpringBoot Server] alternative: fix optional parameter not correctly declared in service (OpenAPITools#2539) improve indentation, update dependencies (OpenAPITools#2521) update kotlin spring samples [JAVA] Use specified data type in enum's fromValue instead of string (OpenAPITools#2347) ...

* master: (133 commits) #2503: fix out-of-memory issue with nested objects with arrays with maxItems set by limiting to max. 5 example items (#2536) remove emitDefaultValue option (#2559) fix EmitDefaultValue default vallue with false (#2558) Added API Key auth to rust-server (#2459) remove initialCaps and replace with camelize (#2546) Add packageName configuration to maven (#2429) [Typescript AngularJS] fix Extra package prefix in api parameters operations (#2522) #1023 - [Scala] Use status family during response processing (#1024) Generate setters for readonly properties in server code (#1582) [JS] fix NPE for null string and improve Travis config file (#2553) [elm] Update ISO 8601 library (fixes missing time zone designator) (#2545) [csharp] update sample after #2528 (#2550) [JavaScript] fix index.js, ApiClient.js and test files generated to incorrect location (#2511) Aspnetcore nullable support (#2529) Csharp nullable support (#2528) [C++] [Qt5] Add enum support for client and server (#2339) Fixed typo in migration-from-swagger-codegen.md (#2548) [TypeScript Client] fix install Aurelia + fix use deprecated function (#2514) [KOTLIN] fix var name not correctly sanitized (#2537) Update swagger-parser to '2.0.11-OpenAPITools.org-1' (#2262) ...

generate setters for readonly properties in server code

02b18be

tsiq-karold mentioned this pull request Jan 22, 2019

[JAVA] Server and models with readOnly properties #1376

Closed

wing328 reviewed Jan 22, 2019

View reviewed changes

tsiq-karold added 3 commits January 23, 2019 11:59

rollback DefaultGenerator change and remove isReadOnly tags from jaxr…

10ef2d7

…s server template

updating petstore

941d834

more petstore updates

3fc9761

wing328 merged commit 822234d into OpenAPITools:master Mar 31, 2019

wing328 added the Server: Java label Mar 31, 2019

wing328 added this to the 4.0.0 milestone Mar 31, 2019

wing328 added the Issue: Bug label Mar 31, 2019

alexbudarov mentioned this pull request Oct 27, 2023

Is readOnly flag misused in the schema? spring-petclinic/spring-petclinic-rest#122

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate setters for readonly properties in server code #1582

Generate setters for readonly properties in server code #1582

tsiq-karold commented Nov 30, 2018 •

edited

Loading

tsiq-karold commented Nov 30, 2018

tsiq-karold commented Nov 30, 2018

tsiq-karold commented Dec 20, 2018

wing328 commented Jan 22, 2019

wing328 Jan 22, 2019

tsiq-karold Jan 23, 2019

wing328 Jan 23, 2019

wing328 Jan 22, 2019

tsiq-karold Jan 23, 2019 •

edited

Loading

tsiq-karold commented Jan 23, 2019

cbornet commented Jan 23, 2019

tsiq-karold commented Feb 12, 2019

wing328 commented Mar 31, 2019

Generate setters for readonly properties in server code #1582

Generate setters for readonly properties in server code #1582

Conversation

tsiq-karold commented Nov 30, 2018 • edited Loading

PR checklist

Description of the PR

tsiq-karold commented Nov 30, 2018

tsiq-karold commented Nov 30, 2018

tsiq-karold commented Dec 20, 2018

wing328 commented Jan 22, 2019

wing328 Jan 22, 2019

Choose a reason for hiding this comment

tsiq-karold Jan 23, 2019

Choose a reason for hiding this comment

wing328 Jan 23, 2019

Choose a reason for hiding this comment

wing328 Jan 22, 2019

Choose a reason for hiding this comment

tsiq-karold Jan 23, 2019 • edited Loading

Choose a reason for hiding this comment

tsiq-karold commented Jan 23, 2019

cbornet commented Jan 23, 2019

tsiq-karold commented Feb 12, 2019

wing328 commented Mar 31, 2019

tsiq-karold commented Nov 30, 2018 •

edited

Loading

tsiq-karold Jan 23, 2019 •

edited

Loading