Generate setters for readonly properties in server code - #1582

Merged
wing328 merged 4 commits into
OpenAPITools:masterfrom
tsiq-karold:1376-server-readonly
Mar 31, 2019
Merged

Generate setters for readonly properties in server code#1582
wing328 merged 4 commits into
OpenAPITools:masterfrom
tsiq-karold:1376-server-readonly

Conversation

@tsiq-karold

@tsiq-karoldtsiq-karold commented Nov 30, 2018

Copy link
Copy Markdown
Contributor

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

Fixes#1376.

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

Copy link
Copy Markdown
ContributorAuthor

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

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
ContributorAuthor

Can someone take a look at this PR please?

@wing328

Copy link
Copy Markdown
Member

@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)

}
}

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These aren't strings, CodegenType is an enum.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah you're right. Completely forgot about that.

CodegenModel model = (CodegenModel) modelTemplate.get("model");

if (model != null && model.vars != null) {
model.vars.forEach((var) -> var.isReadOnly = false);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@tsiq-karoldtsiq-karoldJan 23, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😄

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

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

@cbornet

Copy link
Copy Markdown
Member

LGTM

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

@wing328 any chance we could get this into 4.0.0?

@wing328
wing328 merged commit 822234d into OpenAPITools:masterMar 31, 2019
@wing328

Copy link
Copy Markdown
Member

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

@wing328wing328 added this to the 4.0.0 milestone Mar 31, 2019
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Apr 1, 2019
* 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)
...
jimschubert added a commit that referenced this pull request Apr 2, 2019
* 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)
...
Sign up for freeto 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.

3 participants

@tsiq-karold@wing328@cbornet
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Generate setters for readonly properties in server code - #1582

Merged
wing328 merged 4 commits into
OpenAPITools:masterfrom
tsiq-karold:1376-server-readonly
Mar 31, 2019
Merged

Generate setters for readonly properties in server code#1582
wing328 merged 4 commits into
OpenAPITools:masterfrom
tsiq-karold:1376-server-readonly

Conversation

@tsiq-karold

@tsiq-karoldtsiq-karold commented Nov 30, 2018

Copy link
Copy Markdown
Contributor

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

Fixes#1376.

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

Copy link
Copy Markdown
ContributorAuthor

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

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
ContributorAuthor

Can someone take a look at this PR please?

@wing328

Copy link
Copy Markdown
Member

@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)

}
}

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These aren't strings, CodegenType is an enum.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah you're right. Completely forgot about that.

CodegenModel model = (CodegenModel) modelTemplate.get("model");

if (model != null && model.vars != null) {
model.vars.forEach((var) -> var.isReadOnly = false);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@tsiq-karoldtsiq-karoldJan 23, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😄

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

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

@cbornet

Copy link
Copy Markdown
Member

LGTM

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

@wing328 any chance we could get this into 4.0.0?

@wing328
wing328 merged commit 822234d into OpenAPITools:masterMar 31, 2019
@wing328

Copy link
Copy Markdown
Member

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

@wing328wing328 added this to the 4.0.0 milestone Mar 31, 2019
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Apr 1, 2019
* 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)
...
jimschubert added a commit that referenced this pull request Apr 2, 2019
* 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)
...
Sign up for freeto 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.

3 participants

@tsiq-karold@wing328@cbornet
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Generate setters for readonly properties in server code - #1582

Merged
wing328 merged 4 commits into
OpenAPITools:masterfrom
tsiq-karold:1376-server-readonly
Mar 31, 2019
Merged

Generate setters for readonly properties in server code#1582
wing328 merged 4 commits into
OpenAPITools:masterfrom
tsiq-karold:1376-server-readonly

Conversation

@tsiq-karold

@tsiq-karoldtsiq-karold commented Nov 30, 2018

Copy link
Copy Markdown
Contributor

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

Fixes#1376.

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

Copy link
Copy Markdown
ContributorAuthor

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

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
ContributorAuthor

Can someone take a look at this PR please?

@wing328

Copy link
Copy Markdown
Member

@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)

}
}

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These aren't strings, CodegenType is an enum.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah you're right. Completely forgot about that.

CodegenModel model = (CodegenModel) modelTemplate.get("model");

if (model != null && model.vars != null) {
model.vars.forEach((var) -> var.isReadOnly = false);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@tsiq-karoldtsiq-karoldJan 23, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😄

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

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

@cbornet

Copy link
Copy Markdown
Member

LGTM

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

@wing328 any chance we could get this into 4.0.0?

@wing328
wing328 merged commit 822234d into OpenAPITools:masterMar 31, 2019
@wing328

Copy link
Copy Markdown
Member

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

@wing328wing328 added this to the 4.0.0 milestone Mar 31, 2019
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Apr 1, 2019
* 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)
...
jimschubert added a commit that referenced this pull request Apr 2, 2019
* 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)
...
Sign up for freeto 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.

3 participants

@tsiq-karold@wing328@cbornet
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Generate setters for readonly properties in server code - #1582

Merged
wing328 merged 4 commits into
OpenAPITools:masterfrom
tsiq-karold:1376-server-readonly
Mar 31, 2019
Merged

Generate setters for readonly properties in server code#1582
wing328 merged 4 commits into
OpenAPITools:masterfrom
tsiq-karold:1376-server-readonly

Conversation

@tsiq-karold

@tsiq-karoldtsiq-karold commented Nov 30, 2018

Copy link
Copy Markdown
Contributor

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

Fixes#1376.

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

Copy link
Copy Markdown
ContributorAuthor

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

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
ContributorAuthor

Can someone take a look at this PR please?

@wing328

Copy link
Copy Markdown
Member

@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)

}
}

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These aren't strings, CodegenType is an enum.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah you're right. Completely forgot about that.

CodegenModel model = (CodegenModel) modelTemplate.get("model");

if (model != null && model.vars != null) {
model.vars.forEach((var) -> var.isReadOnly = false);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@tsiq-karoldtsiq-karoldJan 23, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😄

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

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

@cbornet

Copy link
Copy Markdown
Member

LGTM

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

@wing328 any chance we could get this into 4.0.0?

@wing328
wing328 merged commit 822234d into OpenAPITools:masterMar 31, 2019
@wing328

Copy link
Copy Markdown
Member

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

@wing328wing328 added this to the 4.0.0 milestone Mar 31, 2019
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Apr 1, 2019
* 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)
...
jimschubert added a commit that referenced this pull request Apr 2, 2019
* 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)
...
Sign up for freeto 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.

3 participants

@tsiq-karold@wing328@cbornet
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Generate setters for readonly properties in server code - #1582

Merged
wing328 merged 4 commits into
OpenAPITools:masterfrom
tsiq-karold:1376-server-readonly
Mar 31, 2019
Merged

Generate setters for readonly properties in server code#1582
wing328 merged 4 commits into
OpenAPITools:masterfrom
tsiq-karold:1376-server-readonly

Conversation

@tsiq-karold

@tsiq-karoldtsiq-karold commented Nov 30, 2018

Copy link
Copy Markdown
Contributor

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

Fixes#1376.

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

Copy link
Copy Markdown
ContributorAuthor

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

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
ContributorAuthor

Can someone take a look at this PR please?

@wing328

Copy link
Copy Markdown
Member

@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)

}
}

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These aren't strings, CodegenType is an enum.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah you're right. Completely forgot about that.

CodegenModel model = (CodegenModel) modelTemplate.get("model");

if (model != null && model.vars != null) {
model.vars.forEach((var) -> var.isReadOnly = false);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@tsiq-karoldtsiq-karoldJan 23, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😄

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

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

@cbornet

Copy link
Copy Markdown
Member

LGTM

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

@wing328 any chance we could get this into 4.0.0?

@wing328
wing328 merged commit 822234d into OpenAPITools:masterMar 31, 2019
@wing328

Copy link
Copy Markdown
Member

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

@wing328wing328 added this to the 4.0.0 milestone Mar 31, 2019
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Apr 1, 2019
* 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)
...
jimschubert added a commit that referenced this pull request Apr 2, 2019
* 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)
...
Sign up for freeto 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.

3 participants

@tsiq-karold@wing328@cbornet
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Generate setters for readonly properties in server code - #1582

Merged
wing328 merged 4 commits into
OpenAPITools:masterfrom
tsiq-karold:1376-server-readonly
Mar 31, 2019
Merged

Generate setters for readonly properties in server code#1582
wing328 merged 4 commits into
OpenAPITools:masterfrom
tsiq-karold:1376-server-readonly

Conversation

@tsiq-karold

@tsiq-karoldtsiq-karold commented Nov 30, 2018

Copy link
Copy Markdown
Contributor

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

Fixes#1376.

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

Copy link
Copy Markdown
ContributorAuthor

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

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
ContributorAuthor

Can someone take a look at this PR please?

@wing328

Copy link
Copy Markdown
Member

@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)

}
}

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These aren't strings, CodegenType is an enum.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah you're right. Completely forgot about that.

CodegenModel model = (CodegenModel) modelTemplate.get("model");

if (model != null && model.vars != null) {
model.vars.forEach((var) -> var.isReadOnly = false);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@tsiq-karoldtsiq-karoldJan 23, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😄

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

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

@cbornet

Copy link
Copy Markdown
Member

LGTM

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

@wing328 any chance we could get this into 4.0.0?

@wing328
wing328 merged commit 822234d into OpenAPITools:masterMar 31, 2019
@wing328

Copy link
Copy Markdown
Member

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

@wing328wing328 added this to the 4.0.0 milestone Mar 31, 2019
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Apr 1, 2019
* 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)
...
jimschubert added a commit that referenced this pull request Apr 2, 2019
* 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)
...
Sign up for freeto 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.

3 participants

@tsiq-karold@wing328@cbornet
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Generate setters for readonly properties in server code - #1582

Merged
wing328 merged 4 commits into
OpenAPITools:masterfrom
tsiq-karold:1376-server-readonly
Mar 31, 2019
Merged

Generate setters for readonly properties in server code#1582
wing328 merged 4 commits into
OpenAPITools:masterfrom
tsiq-karold:1376-server-readonly

Conversation

@tsiq-karold

@tsiq-karoldtsiq-karold commented Nov 30, 2018

Copy link
Copy Markdown
Contributor

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

Fixes#1376.

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

Copy link
Copy Markdown
ContributorAuthor

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

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
ContributorAuthor

Can someone take a look at this PR please?

@wing328

Copy link
Copy Markdown
Member

@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)

}
}

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These aren't strings, CodegenType is an enum.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah you're right. Completely forgot about that.

CodegenModel model = (CodegenModel) modelTemplate.get("model");

if (model != null && model.vars != null) {
model.vars.forEach((var) -> var.isReadOnly = false);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@tsiq-karoldtsiq-karoldJan 23, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😄

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

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

@cbornet

Copy link
Copy Markdown
Member

LGTM

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

@wing328 any chance we could get this into 4.0.0?

@wing328
wing328 merged commit 822234d into OpenAPITools:masterMar 31, 2019
@wing328

Copy link
Copy Markdown
Member

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

@wing328wing328 added this to the 4.0.0 milestone Mar 31, 2019
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Apr 1, 2019
* 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)
...
jimschubert added a commit that referenced this pull request Apr 2, 2019
* 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)
...
Sign up for freeto 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.

3 participants

@tsiq-karold@wing328@cbornet
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Generate setters for readonly properties in server code - #1582

Merged
wing328 merged 4 commits into
OpenAPITools:masterfrom
tsiq-karold:1376-server-readonly
Mar 31, 2019
Merged

Generate setters for readonly properties in server code#1582
wing328 merged 4 commits into
OpenAPITools:masterfrom
tsiq-karold:1376-server-readonly

Conversation

@tsiq-karold

@tsiq-karoldtsiq-karold commented Nov 30, 2018

Copy link
Copy Markdown
Contributor

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

Fixes#1376.

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

Copy link
Copy Markdown
ContributorAuthor

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

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

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

Copy link
Copy Markdown
ContributorAuthor

Can someone take a look at this PR please?

@wing328

Copy link
Copy Markdown
Member

@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)

}
}

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These aren't strings, CodegenType is an enum.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah you're right. Completely forgot about that.

CodegenModel model = (CodegenModel) modelTemplate.get("model");

if (model != null && model.vars != null) {
model.vars.forEach((var) -> var.isReadOnly = false);

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@tsiq-karoldtsiq-karoldJan 23, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😄

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

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

@cbornet

Copy link
Copy Markdown
Member

LGTM

@tsiq-karold

Copy link
Copy Markdown
ContributorAuthor

@wing328 any chance we could get this into 4.0.0?

@wing328
wing328 merged commit 822234d into OpenAPITools:masterMar 31, 2019
@wing328

Copy link
Copy Markdown
Member

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

@wing328wing328 added this to the 4.0.0 milestone Mar 31, 2019
jimschubert added a commit to jimschubert/openapi-generator that referenced this pull request Apr 1, 2019
* 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)
...
jimschubert added a commit that referenced this pull request Apr 2, 2019
* 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)
...
Sign up for freeto 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.

3 participants

@tsiq-karold@wing328@cbornet