Various fix for Kotlin templates - #3504

Merged
jimschubert merged 4 commits into
OpenAPITools:masterfrom
gimlet2:kotlin_templates_fix
Aug 11, 2019
Merged

Various fix for Kotlin templates#3504
jimschubert merged 4 commits into
OpenAPITools:masterfrom
gimlet2:kotlin_templates_fix

Conversation

@gimlet2

Copy link
Copy Markdown
Contributor

Fix escaping of dataType field.
Fix handling of arrays/lists of enums.
Update okhttp to 4.0.1
main issue was:
val `data`: ApiResponseListString.`Data`? = null, ... enum class `Data`(val value: kotlin.collection.List<kotlin.String>)
instead of
val `data`: kotlin.collection.List<ApiResponseListString.`Data`>? = null,` `enum class `Data`(val value: kotlin.String)

Andrei Chernyshev added 2 commits July 31, 2019 11:55
Fix escaping of dataType field.
Fix handling of arrays/lists of enums.
typeMapping.put("binary", "kotlin.Array<kotlin.Byte>");
typeMapping.put("Date", "java.time.LocalDate");
typeMapping.put("DateTime", "java.time.LocalDateTime");
typeMapping.put("ref", "kotlin.Any");

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.

@gimlet2 I don't think there's a type called "ref".

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.

Hi @wing328! Yes, there is no such type. But in spec I've got i see { "name": "request", "in": "formData", "description": "request", "required": false, "type": "ref" }
And that was generated by springfox swagger. I think that can be fixed some other way and will be happy to do it if you can recommend me how.

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.

I think it's bug in springfox based on the information you've provided as type: ref is not defined in the official openapi/swagger spec.

Given that it's a form parameter, what exactly is that? string? float?

What does the HTTP request payload look like?

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.

It looks like ref is default type https://github.com/swagger-api/swagger-core/blob/v1.5.21/modules/swagger-models/src/main/java/io/swagger/models/properties/RefProperty.java But it was changed in lates versions. Maybe that will help

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.

ref is not defined in the OpenAPI/Swagger spec. Please use a validator to validate the API spec/document first.

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.

I don't think we should include this in the generator, and rather require those who need it to pass this as a type mapping at generation time (see CLI options for example.

A ref in OpenAPI means something completely different than a top-level object type. Adding this means we need to support it through a deprecation cycle, and it may cause problems for others.

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.

Agree. Removed

@wing328

Copy link
Copy Markdown
Member

cc @jimschubert (2017/09), @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04)

@gimlet2

Copy link
Copy Markdown
ContributorAuthor

Dear reviewers, can you give me please a hint what is wrong with Shippable ci job and how to fix it?
@wing328@jimschubert

@wing328

Copy link
Copy Markdown
Member

I've restarted the shippable job. Let's see how it goes.

@gimlet2

Copy link
Copy Markdown
ContributorAuthor

@wing328 Thank you for rerunning shippable. Looks like all checks are ok now. Should I fix something else, or it would be fine to merge at some point?

@jimschubert

jimschubert commented Aug 11, 2019

Copy link
Copy Markdown
Member

@gimlet2 I noticed there's an additional isList property being added which doesn't seem to be used and will cause confusion with isListContainer. Could you verify that this isn't being used, or that I'm not mistaken and missed it?

Sorry for the delay, we had PR merges on hold for the 4.1.0 release.

edit: After the explanation in your comment, I looked again and saw the usage in the templates. I just overlooked it previously.

@jimschubert

Copy link
Copy Markdown
Member

Thanks for the contribution! My previous question was a matter of my overlooking the value in the template.

@jimschubert
jimschubert merged commit 07381e7 into OpenAPITools:masterAug 11, 2019
@jimschubertjimschubert added this to the 4.1.1 milestone Aug 11, 2019
@gimlet2

Copy link
Copy Markdown
ContributorAuthor

@jimschubert@wing328 Thank you for help with fixing it! 👍

@wing328wing328 changed the title Fix kotlin templatesVarious fix for Kotlin templatesAug 26, 2019
@wing328

Copy link
Copy Markdown
Member

@gimlet2 thanks for the PR, which has been included in the v4.1.1 release: https://twitter.com/oas_generator/status/1165944867391860737

@4brunu

4brunu commented Sep 30, 2019

Copy link
Copy Markdown
Contributor

I'm not sure if this is the right place or if I should open an issue, but in this PR, the OkHttp version was bumped from 3.14.2 to 4.0.1.

This has a side effect that the Kotlin-client no longer supports Android 4.X version, it only supports Android 5.0 and upwards, because OkHttp 4.X only supports Android 5.0 and upwards.
https://github.com/square/okhttp/blob/master/README.md#requirements

But the Android 4.X version still represents 10% of the global Android market share, and some companies still need to support those devices.
https://developer.android.com/about/dashboards/

I'm not sure if this change was an accident, but it would be great if Kotlin-client supports Android 4.X.

So we have three possibilites:

  • supports OkHttp 4.X and 3.Y in parallel
  • revert this change and only support OkHttp 3.Y
  • only support OkHttp 4.X

What are your thoughts on this? Should I create an issue with this?

EDIT: I created an issue #4007

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.

5 participants

@gimlet2@wing328@jimschubert@4brunu@richardwhiuk
, '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

Various fix for Kotlin templates - #3504

Merged
jimschubert merged 4 commits into
OpenAPITools:masterfrom
gimlet2:kotlin_templates_fix
Aug 11, 2019
Merged

Various fix for Kotlin templates#3504
jimschubert merged 4 commits into
OpenAPITools:masterfrom
gimlet2:kotlin_templates_fix

Conversation

@gimlet2

Copy link
Copy Markdown
Contributor

Fix escaping of dataType field.
Fix handling of arrays/lists of enums.
Update okhttp to 4.0.1
main issue was:
val `data`: ApiResponseListString.`Data`? = null, ... enum class `Data`(val value: kotlin.collection.List<kotlin.String>)
instead of
val `data`: kotlin.collection.List<ApiResponseListString.`Data`>? = null,` `enum class `Data`(val value: kotlin.String)

Andrei Chernyshev added 2 commits July 31, 2019 11:55
Fix escaping of dataType field.
Fix handling of arrays/lists of enums.
typeMapping.put("binary", "kotlin.Array<kotlin.Byte>");
typeMapping.put("Date", "java.time.LocalDate");
typeMapping.put("DateTime", "java.time.LocalDateTime");
typeMapping.put("ref", "kotlin.Any");

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.

@gimlet2 I don't think there's a type called "ref".

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.

Hi @wing328! Yes, there is no such type. But in spec I've got i see { "name": "request", "in": "formData", "description": "request", "required": false, "type": "ref" }
And that was generated by springfox swagger. I think that can be fixed some other way and will be happy to do it if you can recommend me how.

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.

I think it's bug in springfox based on the information you've provided as type: ref is not defined in the official openapi/swagger spec.

Given that it's a form parameter, what exactly is that? string? float?

What does the HTTP request payload look like?

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.

It looks like ref is default type https://github.com/swagger-api/swagger-core/blob/v1.5.21/modules/swagger-models/src/main/java/io/swagger/models/properties/RefProperty.java But it was changed in lates versions. Maybe that will help

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.

ref is not defined in the OpenAPI/Swagger spec. Please use a validator to validate the API spec/document first.

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.

I don't think we should include this in the generator, and rather require those who need it to pass this as a type mapping at generation time (see CLI options for example.

A ref in OpenAPI means something completely different than a top-level object type. Adding this means we need to support it through a deprecation cycle, and it may cause problems for others.

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.

Agree. Removed

@wing328

Copy link
Copy Markdown
Member

cc @jimschubert (2017/09), @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04)

@gimlet2

Copy link
Copy Markdown
ContributorAuthor

Dear reviewers, can you give me please a hint what is wrong with Shippable ci job and how to fix it?
@wing328@jimschubert

@wing328

Copy link
Copy Markdown
Member

I've restarted the shippable job. Let's see how it goes.

@gimlet2

Copy link
Copy Markdown
ContributorAuthor

@wing328 Thank you for rerunning shippable. Looks like all checks are ok now. Should I fix something else, or it would be fine to merge at some point?

@jimschubert

jimschubert commented Aug 11, 2019

Copy link
Copy Markdown
Member

@gimlet2 I noticed there's an additional isList property being added which doesn't seem to be used and will cause confusion with isListContainer. Could you verify that this isn't being used, or that I'm not mistaken and missed it?

Sorry for the delay, we had PR merges on hold for the 4.1.0 release.

edit: After the explanation in your comment, I looked again and saw the usage in the templates. I just overlooked it previously.

@jimschubert

Copy link
Copy Markdown
Member

Thanks for the contribution! My previous question was a matter of my overlooking the value in the template.

@jimschubert
jimschubert merged commit 07381e7 into OpenAPITools:masterAug 11, 2019
@jimschubertjimschubert added this to the 4.1.1 milestone Aug 11, 2019
@gimlet2

Copy link
Copy Markdown
ContributorAuthor

@jimschubert@wing328 Thank you for help with fixing it! 👍

@wing328wing328 changed the title Fix kotlin templatesVarious fix for Kotlin templatesAug 26, 2019
@wing328

Copy link
Copy Markdown
Member

@gimlet2 thanks for the PR, which has been included in the v4.1.1 release: https://twitter.com/oas_generator/status/1165944867391860737

@4brunu

4brunu commented Sep 30, 2019

Copy link
Copy Markdown
Contributor

I'm not sure if this is the right place or if I should open an issue, but in this PR, the OkHttp version was bumped from 3.14.2 to 4.0.1.

This has a side effect that the Kotlin-client no longer supports Android 4.X version, it only supports Android 5.0 and upwards, because OkHttp 4.X only supports Android 5.0 and upwards.
https://github.com/square/okhttp/blob/master/README.md#requirements

But the Android 4.X version still represents 10% of the global Android market share, and some companies still need to support those devices.
https://developer.android.com/about/dashboards/

I'm not sure if this change was an accident, but it would be great if Kotlin-client supports Android 4.X.

So we have three possibilites:

  • supports OkHttp 4.X and 3.Y in parallel
  • revert this change and only support OkHttp 3.Y
  • only support OkHttp 4.X

What are your thoughts on this? Should I create an issue with this?

EDIT: I created an issue #4007

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.

5 participants

@gimlet2@wing328@jimschubert@4brunu@richardwhiuk
, '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

Various fix for Kotlin templates - #3504

Merged
jimschubert merged 4 commits into
OpenAPITools:masterfrom
gimlet2:kotlin_templates_fix
Aug 11, 2019
Merged

Various fix for Kotlin templates#3504
jimschubert merged 4 commits into
OpenAPITools:masterfrom
gimlet2:kotlin_templates_fix

Conversation

@gimlet2

Copy link
Copy Markdown
Contributor

Fix escaping of dataType field.
Fix handling of arrays/lists of enums.
Update okhttp to 4.0.1
main issue was:
val `data`: ApiResponseListString.`Data`? = null, ... enum class `Data`(val value: kotlin.collection.List<kotlin.String>)
instead of
val `data`: kotlin.collection.List<ApiResponseListString.`Data`>? = null,` `enum class `Data`(val value: kotlin.String)

Andrei Chernyshev added 2 commits July 31, 2019 11:55
Fix escaping of dataType field.
Fix handling of arrays/lists of enums.
typeMapping.put("binary", "kotlin.Array<kotlin.Byte>");
typeMapping.put("Date", "java.time.LocalDate");
typeMapping.put("DateTime", "java.time.LocalDateTime");
typeMapping.put("ref", "kotlin.Any");

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.

@gimlet2 I don't think there's a type called "ref".

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.

Hi @wing328! Yes, there is no such type. But in spec I've got i see { "name": "request", "in": "formData", "description": "request", "required": false, "type": "ref" }
And that was generated by springfox swagger. I think that can be fixed some other way and will be happy to do it if you can recommend me how.

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.

I think it's bug in springfox based on the information you've provided as type: ref is not defined in the official openapi/swagger spec.

Given that it's a form parameter, what exactly is that? string? float?

What does the HTTP request payload look like?

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.

It looks like ref is default type https://github.com/swagger-api/swagger-core/blob/v1.5.21/modules/swagger-models/src/main/java/io/swagger/models/properties/RefProperty.java But it was changed in lates versions. Maybe that will help

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.

ref is not defined in the OpenAPI/Swagger spec. Please use a validator to validate the API spec/document first.

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.

I don't think we should include this in the generator, and rather require those who need it to pass this as a type mapping at generation time (see CLI options for example.

A ref in OpenAPI means something completely different than a top-level object type. Adding this means we need to support it through a deprecation cycle, and it may cause problems for others.

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.

Agree. Removed

@wing328

Copy link
Copy Markdown
Member

cc @jimschubert (2017/09), @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04)

@gimlet2

Copy link
Copy Markdown
ContributorAuthor

Dear reviewers, can you give me please a hint what is wrong with Shippable ci job and how to fix it?
@wing328@jimschubert

@wing328

Copy link
Copy Markdown
Member

I've restarted the shippable job. Let's see how it goes.

@gimlet2

Copy link
Copy Markdown
ContributorAuthor

@wing328 Thank you for rerunning shippable. Looks like all checks are ok now. Should I fix something else, or it would be fine to merge at some point?

@jimschubert

jimschubert commented Aug 11, 2019

Copy link
Copy Markdown
Member

@gimlet2 I noticed there's an additional isList property being added which doesn't seem to be used and will cause confusion with isListContainer. Could you verify that this isn't being used, or that I'm not mistaken and missed it?

Sorry for the delay, we had PR merges on hold for the 4.1.0 release.

edit: After the explanation in your comment, I looked again and saw the usage in the templates. I just overlooked it previously.

@jimschubert

Copy link
Copy Markdown
Member

Thanks for the contribution! My previous question was a matter of my overlooking the value in the template.

@jimschubert
jimschubert merged commit 07381e7 into OpenAPITools:masterAug 11, 2019
@jimschubertjimschubert added this to the 4.1.1 milestone Aug 11, 2019
@gimlet2

Copy link
Copy Markdown
ContributorAuthor

@jimschubert@wing328 Thank you for help with fixing it! 👍

@wing328wing328 changed the title Fix kotlin templatesVarious fix for Kotlin templatesAug 26, 2019
@wing328

Copy link
Copy Markdown
Member

@gimlet2 thanks for the PR, which has been included in the v4.1.1 release: https://twitter.com/oas_generator/status/1165944867391860737

@4brunu

4brunu commented Sep 30, 2019

Copy link
Copy Markdown
Contributor

I'm not sure if this is the right place or if I should open an issue, but in this PR, the OkHttp version was bumped from 3.14.2 to 4.0.1.

This has a side effect that the Kotlin-client no longer supports Android 4.X version, it only supports Android 5.0 and upwards, because OkHttp 4.X only supports Android 5.0 and upwards.
https://github.com/square/okhttp/blob/master/README.md#requirements

But the Android 4.X version still represents 10% of the global Android market share, and some companies still need to support those devices.
https://developer.android.com/about/dashboards/

I'm not sure if this change was an accident, but it would be great if Kotlin-client supports Android 4.X.

So we have three possibilites:

  • supports OkHttp 4.X and 3.Y in parallel
  • revert this change and only support OkHttp 3.Y
  • only support OkHttp 4.X

What are your thoughts on this? Should I create an issue with this?

EDIT: I created an issue #4007

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.

5 participants

@gimlet2@wing328@jimschubert@4brunu@richardwhiuk
, '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

Various fix for Kotlin templates - #3504

Merged
jimschubert merged 4 commits into
OpenAPITools:masterfrom
gimlet2:kotlin_templates_fix
Aug 11, 2019
Merged

Various fix for Kotlin templates#3504
jimschubert merged 4 commits into
OpenAPITools:masterfrom
gimlet2:kotlin_templates_fix

Conversation

@gimlet2

Copy link
Copy Markdown
Contributor

Fix escaping of dataType field.
Fix handling of arrays/lists of enums.
Update okhttp to 4.0.1
main issue was:
val `data`: ApiResponseListString.`Data`? = null, ... enum class `Data`(val value: kotlin.collection.List<kotlin.String>)
instead of
val `data`: kotlin.collection.List<ApiResponseListString.`Data`>? = null,` `enum class `Data`(val value: kotlin.String)

Andrei Chernyshev added 2 commits July 31, 2019 11:55
Fix escaping of dataType field.
Fix handling of arrays/lists of enums.
typeMapping.put("binary", "kotlin.Array<kotlin.Byte>");
typeMapping.put("Date", "java.time.LocalDate");
typeMapping.put("DateTime", "java.time.LocalDateTime");
typeMapping.put("ref", "kotlin.Any");

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.

@gimlet2 I don't think there's a type called "ref".

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.

Hi @wing328! Yes, there is no such type. But in spec I've got i see { "name": "request", "in": "formData", "description": "request", "required": false, "type": "ref" }
And that was generated by springfox swagger. I think that can be fixed some other way and will be happy to do it if you can recommend me how.

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.

I think it's bug in springfox based on the information you've provided as type: ref is not defined in the official openapi/swagger spec.

Given that it's a form parameter, what exactly is that? string? float?

What does the HTTP request payload look like?

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.

It looks like ref is default type https://github.com/swagger-api/swagger-core/blob/v1.5.21/modules/swagger-models/src/main/java/io/swagger/models/properties/RefProperty.java But it was changed in lates versions. Maybe that will help

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.

ref is not defined in the OpenAPI/Swagger spec. Please use a validator to validate the API spec/document first.

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.

I don't think we should include this in the generator, and rather require those who need it to pass this as a type mapping at generation time (see CLI options for example.

A ref in OpenAPI means something completely different than a top-level object type. Adding this means we need to support it through a deprecation cycle, and it may cause problems for others.

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.

Agree. Removed

@wing328

Copy link
Copy Markdown
Member

cc @jimschubert (2017/09), @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04)

@gimlet2

Copy link
Copy Markdown
ContributorAuthor

Dear reviewers, can you give me please a hint what is wrong with Shippable ci job and how to fix it?
@wing328@jimschubert

@wing328

Copy link
Copy Markdown
Member

I've restarted the shippable job. Let's see how it goes.

@gimlet2

Copy link
Copy Markdown
ContributorAuthor

@wing328 Thank you for rerunning shippable. Looks like all checks are ok now. Should I fix something else, or it would be fine to merge at some point?

@jimschubert

jimschubert commented Aug 11, 2019

Copy link
Copy Markdown
Member

@gimlet2 I noticed there's an additional isList property being added which doesn't seem to be used and will cause confusion with isListContainer. Could you verify that this isn't being used, or that I'm not mistaken and missed it?

Sorry for the delay, we had PR merges on hold for the 4.1.0 release.

edit: After the explanation in your comment, I looked again and saw the usage in the templates. I just overlooked it previously.

@jimschubert

Copy link
Copy Markdown
Member

Thanks for the contribution! My previous question was a matter of my overlooking the value in the template.

@jimschubert
jimschubert merged commit 07381e7 into OpenAPITools:masterAug 11, 2019
@jimschubertjimschubert added this to the 4.1.1 milestone Aug 11, 2019
@gimlet2

Copy link
Copy Markdown
ContributorAuthor

@jimschubert@wing328 Thank you for help with fixing it! 👍

@wing328wing328 changed the title Fix kotlin templatesVarious fix for Kotlin templatesAug 26, 2019
@wing328

Copy link
Copy Markdown
Member

@gimlet2 thanks for the PR, which has been included in the v4.1.1 release: https://twitter.com/oas_generator/status/1165944867391860737

@4brunu

4brunu commented Sep 30, 2019

Copy link
Copy Markdown
Contributor

I'm not sure if this is the right place or if I should open an issue, but in this PR, the OkHttp version was bumped from 3.14.2 to 4.0.1.

This has a side effect that the Kotlin-client no longer supports Android 4.X version, it only supports Android 5.0 and upwards, because OkHttp 4.X only supports Android 5.0 and upwards.
https://github.com/square/okhttp/blob/master/README.md#requirements

But the Android 4.X version still represents 10% of the global Android market share, and some companies still need to support those devices.
https://developer.android.com/about/dashboards/

I'm not sure if this change was an accident, but it would be great if Kotlin-client supports Android 4.X.

So we have three possibilites:

  • supports OkHttp 4.X and 3.Y in parallel
  • revert this change and only support OkHttp 3.Y
  • only support OkHttp 4.X

What are your thoughts on this? Should I create an issue with this?

EDIT: I created an issue #4007

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.

5 participants

@gimlet2@wing328@jimschubert@4brunu@richardwhiuk
, '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

Various fix for Kotlin templates - #3504

Merged
jimschubert merged 4 commits into
OpenAPITools:masterfrom
gimlet2:kotlin_templates_fix
Aug 11, 2019
Merged

Various fix for Kotlin templates#3504
jimschubert merged 4 commits into
OpenAPITools:masterfrom
gimlet2:kotlin_templates_fix

Conversation

@gimlet2

Copy link
Copy Markdown
Contributor

Fix escaping of dataType field.
Fix handling of arrays/lists of enums.
Update okhttp to 4.0.1
main issue was:
val `data`: ApiResponseListString.`Data`? = null, ... enum class `Data`(val value: kotlin.collection.List<kotlin.String>)
instead of
val `data`: kotlin.collection.List<ApiResponseListString.`Data`>? = null,` `enum class `Data`(val value: kotlin.String)

Andrei Chernyshev added 2 commits July 31, 2019 11:55
Fix escaping of dataType field.
Fix handling of arrays/lists of enums.
typeMapping.put("binary", "kotlin.Array<kotlin.Byte>");
typeMapping.put("Date", "java.time.LocalDate");
typeMapping.put("DateTime", "java.time.LocalDateTime");
typeMapping.put("ref", "kotlin.Any");

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.

@gimlet2 I don't think there's a type called "ref".

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.

Hi @wing328! Yes, there is no such type. But in spec I've got i see { "name": "request", "in": "formData", "description": "request", "required": false, "type": "ref" }
And that was generated by springfox swagger. I think that can be fixed some other way and will be happy to do it if you can recommend me how.

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.

I think it's bug in springfox based on the information you've provided as type: ref is not defined in the official openapi/swagger spec.

Given that it's a form parameter, what exactly is that? string? float?

What does the HTTP request payload look like?

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.

It looks like ref is default type https://github.com/swagger-api/swagger-core/blob/v1.5.21/modules/swagger-models/src/main/java/io/swagger/models/properties/RefProperty.java But it was changed in lates versions. Maybe that will help

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.

ref is not defined in the OpenAPI/Swagger spec. Please use a validator to validate the API spec/document first.

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.

I don't think we should include this in the generator, and rather require those who need it to pass this as a type mapping at generation time (see CLI options for example.

A ref in OpenAPI means something completely different than a top-level object type. Adding this means we need to support it through a deprecation cycle, and it may cause problems for others.

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.

Agree. Removed

@wing328

Copy link
Copy Markdown
Member

cc @jimschubert (2017/09), @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04)

@gimlet2

Copy link
Copy Markdown
ContributorAuthor

Dear reviewers, can you give me please a hint what is wrong with Shippable ci job and how to fix it?
@wing328@jimschubert

@wing328

Copy link
Copy Markdown
Member

I've restarted the shippable job. Let's see how it goes.

@gimlet2

Copy link
Copy Markdown
ContributorAuthor

@wing328 Thank you for rerunning shippable. Looks like all checks are ok now. Should I fix something else, or it would be fine to merge at some point?

@jimschubert

jimschubert commented Aug 11, 2019

Copy link
Copy Markdown
Member

@gimlet2 I noticed there's an additional isList property being added which doesn't seem to be used and will cause confusion with isListContainer. Could you verify that this isn't being used, or that I'm not mistaken and missed it?

Sorry for the delay, we had PR merges on hold for the 4.1.0 release.

edit: After the explanation in your comment, I looked again and saw the usage in the templates. I just overlooked it previously.

@jimschubert

Copy link
Copy Markdown
Member

Thanks for the contribution! My previous question was a matter of my overlooking the value in the template.

@jimschubert
jimschubert merged commit 07381e7 into OpenAPITools:masterAug 11, 2019
@jimschubertjimschubert added this to the 4.1.1 milestone Aug 11, 2019
@gimlet2

Copy link
Copy Markdown
ContributorAuthor

@jimschubert@wing328 Thank you for help with fixing it! 👍

@wing328wing328 changed the title Fix kotlin templatesVarious fix for Kotlin templatesAug 26, 2019
@wing328

Copy link
Copy Markdown
Member

@gimlet2 thanks for the PR, which has been included in the v4.1.1 release: https://twitter.com/oas_generator/status/1165944867391860737

@4brunu

4brunu commented Sep 30, 2019

Copy link
Copy Markdown
Contributor

I'm not sure if this is the right place or if I should open an issue, but in this PR, the OkHttp version was bumped from 3.14.2 to 4.0.1.

This has a side effect that the Kotlin-client no longer supports Android 4.X version, it only supports Android 5.0 and upwards, because OkHttp 4.X only supports Android 5.0 and upwards.
https://github.com/square/okhttp/blob/master/README.md#requirements

But the Android 4.X version still represents 10% of the global Android market share, and some companies still need to support those devices.
https://developer.android.com/about/dashboards/

I'm not sure if this change was an accident, but it would be great if Kotlin-client supports Android 4.X.

So we have three possibilites:

  • supports OkHttp 4.X and 3.Y in parallel
  • revert this change and only support OkHttp 3.Y
  • only support OkHttp 4.X

What are your thoughts on this? Should I create an issue with this?

EDIT: I created an issue #4007

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.

5 participants

@gimlet2@wing328@jimschubert@4brunu@richardwhiuk
, '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

Various fix for Kotlin templates - #3504

Merged
jimschubert merged 4 commits into
OpenAPITools:masterfrom
gimlet2:kotlin_templates_fix
Aug 11, 2019
Merged

Various fix for Kotlin templates#3504
jimschubert merged 4 commits into
OpenAPITools:masterfrom
gimlet2:kotlin_templates_fix

Conversation

@gimlet2

Copy link
Copy Markdown
Contributor

Fix escaping of dataType field.
Fix handling of arrays/lists of enums.
Update okhttp to 4.0.1
main issue was:
val `data`: ApiResponseListString.`Data`? = null, ... enum class `Data`(val value: kotlin.collection.List<kotlin.String>)
instead of
val `data`: kotlin.collection.List<ApiResponseListString.`Data`>? = null,` `enum class `Data`(val value: kotlin.String)

Andrei Chernyshev added 2 commits July 31, 2019 11:55
Fix escaping of dataType field.
Fix handling of arrays/lists of enums.
typeMapping.put("binary", "kotlin.Array<kotlin.Byte>");
typeMapping.put("Date", "java.time.LocalDate");
typeMapping.put("DateTime", "java.time.LocalDateTime");
typeMapping.put("ref", "kotlin.Any");

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.

@gimlet2 I don't think there's a type called "ref".

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.

Hi @wing328! Yes, there is no such type. But in spec I've got i see { "name": "request", "in": "formData", "description": "request", "required": false, "type": "ref" }
And that was generated by springfox swagger. I think that can be fixed some other way and will be happy to do it if you can recommend me how.

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.

I think it's bug in springfox based on the information you've provided as type: ref is not defined in the official openapi/swagger spec.

Given that it's a form parameter, what exactly is that? string? float?

What does the HTTP request payload look like?

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.

It looks like ref is default type https://github.com/swagger-api/swagger-core/blob/v1.5.21/modules/swagger-models/src/main/java/io/swagger/models/properties/RefProperty.java But it was changed in lates versions. Maybe that will help

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.

ref is not defined in the OpenAPI/Swagger spec. Please use a validator to validate the API spec/document first.

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.

I don't think we should include this in the generator, and rather require those who need it to pass this as a type mapping at generation time (see CLI options for example.

A ref in OpenAPI means something completely different than a top-level object type. Adding this means we need to support it through a deprecation cycle, and it may cause problems for others.

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.

Agree. Removed

@wing328

Copy link
Copy Markdown
Member

cc @jimschubert (2017/09), @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04)

@gimlet2

Copy link
Copy Markdown
ContributorAuthor

Dear reviewers, can you give me please a hint what is wrong with Shippable ci job and how to fix it?
@wing328@jimschubert

@wing328

Copy link
Copy Markdown
Member

I've restarted the shippable job. Let's see how it goes.

@gimlet2

Copy link
Copy Markdown
ContributorAuthor

@wing328 Thank you for rerunning shippable. Looks like all checks are ok now. Should I fix something else, or it would be fine to merge at some point?

@jimschubert

jimschubert commented Aug 11, 2019

Copy link
Copy Markdown
Member

@gimlet2 I noticed there's an additional isList property being added which doesn't seem to be used and will cause confusion with isListContainer. Could you verify that this isn't being used, or that I'm not mistaken and missed it?

Sorry for the delay, we had PR merges on hold for the 4.1.0 release.

edit: After the explanation in your comment, I looked again and saw the usage in the templates. I just overlooked it previously.

@jimschubert

Copy link
Copy Markdown
Member

Thanks for the contribution! My previous question was a matter of my overlooking the value in the template.

@jimschubert
jimschubert merged commit 07381e7 into OpenAPITools:masterAug 11, 2019
@jimschubertjimschubert added this to the 4.1.1 milestone Aug 11, 2019
@gimlet2

Copy link
Copy Markdown
ContributorAuthor

@jimschubert@wing328 Thank you for help with fixing it! 👍

@wing328wing328 changed the title Fix kotlin templatesVarious fix for Kotlin templatesAug 26, 2019
@wing328

Copy link
Copy Markdown
Member

@gimlet2 thanks for the PR, which has been included in the v4.1.1 release: https://twitter.com/oas_generator/status/1165944867391860737

@4brunu

4brunu commented Sep 30, 2019

Copy link
Copy Markdown
Contributor

I'm not sure if this is the right place or if I should open an issue, but in this PR, the OkHttp version was bumped from 3.14.2 to 4.0.1.

This has a side effect that the Kotlin-client no longer supports Android 4.X version, it only supports Android 5.0 and upwards, because OkHttp 4.X only supports Android 5.0 and upwards.
https://github.com/square/okhttp/blob/master/README.md#requirements

But the Android 4.X version still represents 10% of the global Android market share, and some companies still need to support those devices.
https://developer.android.com/about/dashboards/

I'm not sure if this change was an accident, but it would be great if Kotlin-client supports Android 4.X.

So we have three possibilites:

  • supports OkHttp 4.X and 3.Y in parallel
  • revert this change and only support OkHttp 3.Y
  • only support OkHttp 4.X

What are your thoughts on this? Should I create an issue with this?

EDIT: I created an issue #4007

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.

5 participants

@gimlet2@wing328@jimschubert@4brunu@richardwhiuk
, '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

Various fix for Kotlin templates - #3504

Merged
jimschubert merged 4 commits into
OpenAPITools:masterfrom
gimlet2:kotlin_templates_fix
Aug 11, 2019
Merged

Various fix for Kotlin templates#3504
jimschubert merged 4 commits into
OpenAPITools:masterfrom
gimlet2:kotlin_templates_fix

Conversation

@gimlet2

Copy link
Copy Markdown
Contributor

Fix escaping of dataType field.
Fix handling of arrays/lists of enums.
Update okhttp to 4.0.1
main issue was:
val `data`: ApiResponseListString.`Data`? = null, ... enum class `Data`(val value: kotlin.collection.List<kotlin.String>)
instead of
val `data`: kotlin.collection.List<ApiResponseListString.`Data`>? = null,` `enum class `Data`(val value: kotlin.String)

Andrei Chernyshev added 2 commits July 31, 2019 11:55
Fix escaping of dataType field.
Fix handling of arrays/lists of enums.
typeMapping.put("binary", "kotlin.Array<kotlin.Byte>");
typeMapping.put("Date", "java.time.LocalDate");
typeMapping.put("DateTime", "java.time.LocalDateTime");
typeMapping.put("ref", "kotlin.Any");

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.

@gimlet2 I don't think there's a type called "ref".

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.

Hi @wing328! Yes, there is no such type. But in spec I've got i see { "name": "request", "in": "formData", "description": "request", "required": false, "type": "ref" }
And that was generated by springfox swagger. I think that can be fixed some other way and will be happy to do it if you can recommend me how.

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.

I think it's bug in springfox based on the information you've provided as type: ref is not defined in the official openapi/swagger spec.

Given that it's a form parameter, what exactly is that? string? float?

What does the HTTP request payload look like?

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.

It looks like ref is default type https://github.com/swagger-api/swagger-core/blob/v1.5.21/modules/swagger-models/src/main/java/io/swagger/models/properties/RefProperty.java But it was changed in lates versions. Maybe that will help

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.

ref is not defined in the OpenAPI/Swagger spec. Please use a validator to validate the API spec/document first.

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.

I don't think we should include this in the generator, and rather require those who need it to pass this as a type mapping at generation time (see CLI options for example.

A ref in OpenAPI means something completely different than a top-level object type. Adding this means we need to support it through a deprecation cycle, and it may cause problems for others.

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.

Agree. Removed

@wing328

Copy link
Copy Markdown
Member

cc @jimschubert (2017/09), @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04)

@gimlet2

Copy link
Copy Markdown
ContributorAuthor

Dear reviewers, can you give me please a hint what is wrong with Shippable ci job and how to fix it?
@wing328@jimschubert

@wing328

Copy link
Copy Markdown
Member

I've restarted the shippable job. Let's see how it goes.

@gimlet2

Copy link
Copy Markdown
ContributorAuthor

@wing328 Thank you for rerunning shippable. Looks like all checks are ok now. Should I fix something else, or it would be fine to merge at some point?

@jimschubert

jimschubert commented Aug 11, 2019

Copy link
Copy Markdown
Member

@gimlet2 I noticed there's an additional isList property being added which doesn't seem to be used and will cause confusion with isListContainer. Could you verify that this isn't being used, or that I'm not mistaken and missed it?

Sorry for the delay, we had PR merges on hold for the 4.1.0 release.

edit: After the explanation in your comment, I looked again and saw the usage in the templates. I just overlooked it previously.

@jimschubert

Copy link
Copy Markdown
Member

Thanks for the contribution! My previous question was a matter of my overlooking the value in the template.

@jimschubert
jimschubert merged commit 07381e7 into OpenAPITools:masterAug 11, 2019
@jimschubertjimschubert added this to the 4.1.1 milestone Aug 11, 2019
@gimlet2

Copy link
Copy Markdown
ContributorAuthor

@jimschubert@wing328 Thank you for help with fixing it! 👍

@wing328wing328 changed the title Fix kotlin templatesVarious fix for Kotlin templatesAug 26, 2019
@wing328

Copy link
Copy Markdown
Member

@gimlet2 thanks for the PR, which has been included in the v4.1.1 release: https://twitter.com/oas_generator/status/1165944867391860737

@4brunu

4brunu commented Sep 30, 2019

Copy link
Copy Markdown
Contributor

I'm not sure if this is the right place or if I should open an issue, but in this PR, the OkHttp version was bumped from 3.14.2 to 4.0.1.

This has a side effect that the Kotlin-client no longer supports Android 4.X version, it only supports Android 5.0 and upwards, because OkHttp 4.X only supports Android 5.0 and upwards.
https://github.com/square/okhttp/blob/master/README.md#requirements

But the Android 4.X version still represents 10% of the global Android market share, and some companies still need to support those devices.
https://developer.android.com/about/dashboards/

I'm not sure if this change was an accident, but it would be great if Kotlin-client supports Android 4.X.

So we have three possibilites:

  • supports OkHttp 4.X and 3.Y in parallel
  • revert this change and only support OkHttp 3.Y
  • only support OkHttp 4.X

What are your thoughts on this? Should I create an issue with this?

EDIT: I created an issue #4007

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.

5 participants

@gimlet2@wing328@jimschubert@4brunu@richardwhiuk
, '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

Various fix for Kotlin templates - #3504

Merged
jimschubert merged 4 commits into
OpenAPITools:masterfrom
gimlet2:kotlin_templates_fix
Aug 11, 2019
Merged

Various fix for Kotlin templates#3504
jimschubert merged 4 commits into
OpenAPITools:masterfrom
gimlet2:kotlin_templates_fix

Conversation

@gimlet2

Copy link
Copy Markdown
Contributor

Fix escaping of dataType field.
Fix handling of arrays/lists of enums.
Update okhttp to 4.0.1
main issue was:
val `data`: ApiResponseListString.`Data`? = null, ... enum class `Data`(val value: kotlin.collection.List<kotlin.String>)
instead of
val `data`: kotlin.collection.List<ApiResponseListString.`Data`>? = null,` `enum class `Data`(val value: kotlin.String)

Andrei Chernyshev added 2 commits July 31, 2019 11:55
Fix escaping of dataType field.
Fix handling of arrays/lists of enums.
typeMapping.put("binary", "kotlin.Array<kotlin.Byte>");
typeMapping.put("Date", "java.time.LocalDate");
typeMapping.put("DateTime", "java.time.LocalDateTime");
typeMapping.put("ref", "kotlin.Any");

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.

@gimlet2 I don't think there's a type called "ref".

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.

Hi @wing328! Yes, there is no such type. But in spec I've got i see { "name": "request", "in": "formData", "description": "request", "required": false, "type": "ref" }
And that was generated by springfox swagger. I think that can be fixed some other way and will be happy to do it if you can recommend me how.

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.

I think it's bug in springfox based on the information you've provided as type: ref is not defined in the official openapi/swagger spec.

Given that it's a form parameter, what exactly is that? string? float?

What does the HTTP request payload look like?

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.

It looks like ref is default type https://github.com/swagger-api/swagger-core/blob/v1.5.21/modules/swagger-models/src/main/java/io/swagger/models/properties/RefProperty.java But it was changed in lates versions. Maybe that will help

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.

ref is not defined in the OpenAPI/Swagger spec. Please use a validator to validate the API spec/document first.

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.

I don't think we should include this in the generator, and rather require those who need it to pass this as a type mapping at generation time (see CLI options for example.

A ref in OpenAPI means something completely different than a top-level object type. Adding this means we need to support it through a deprecation cycle, and it may cause problems for others.

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.

Agree. Removed

@wing328

Copy link
Copy Markdown
Member

cc @jimschubert (2017/09), @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04)

@gimlet2

Copy link
Copy Markdown
ContributorAuthor

Dear reviewers, can you give me please a hint what is wrong with Shippable ci job and how to fix it?
@wing328@jimschubert

@wing328

Copy link
Copy Markdown
Member

I've restarted the shippable job. Let's see how it goes.

@gimlet2

Copy link
Copy Markdown
ContributorAuthor

@wing328 Thank you for rerunning shippable. Looks like all checks are ok now. Should I fix something else, or it would be fine to merge at some point?

@jimschubert

jimschubert commented Aug 11, 2019

Copy link
Copy Markdown
Member

@gimlet2 I noticed there's an additional isList property being added which doesn't seem to be used and will cause confusion with isListContainer. Could you verify that this isn't being used, or that I'm not mistaken and missed it?

Sorry for the delay, we had PR merges on hold for the 4.1.0 release.

edit: After the explanation in your comment, I looked again and saw the usage in the templates. I just overlooked it previously.

@jimschubert

Copy link
Copy Markdown
Member

Thanks for the contribution! My previous question was a matter of my overlooking the value in the template.

@jimschubert
jimschubert merged commit 07381e7 into OpenAPITools:masterAug 11, 2019
@jimschubertjimschubert added this to the 4.1.1 milestone Aug 11, 2019
@gimlet2

Copy link
Copy Markdown
ContributorAuthor

@jimschubert@wing328 Thank you for help with fixing it! 👍

@wing328wing328 changed the title Fix kotlin templatesVarious fix for Kotlin templatesAug 26, 2019
@wing328

Copy link
Copy Markdown
Member

@gimlet2 thanks for the PR, which has been included in the v4.1.1 release: https://twitter.com/oas_generator/status/1165944867391860737

@4brunu

4brunu commented Sep 30, 2019

Copy link
Copy Markdown
Contributor

I'm not sure if this is the right place or if I should open an issue, but in this PR, the OkHttp version was bumped from 3.14.2 to 4.0.1.

This has a side effect that the Kotlin-client no longer supports Android 4.X version, it only supports Android 5.0 and upwards, because OkHttp 4.X only supports Android 5.0 and upwards.
https://github.com/square/okhttp/blob/master/README.md#requirements

But the Android 4.X version still represents 10% of the global Android market share, and some companies still need to support those devices.
https://developer.android.com/about/dashboards/

I'm not sure if this change was an accident, but it would be great if Kotlin-client supports Android 4.X.

So we have three possibilites:

  • supports OkHttp 4.X and 3.Y in parallel
  • revert this change and only support OkHttp 3.Y
  • only support OkHttp 4.X

What are your thoughts on this? Should I create an issue with this?

EDIT: I created an issue #4007

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.

5 participants

@gimlet2@wing328@jimschubert@4brunu@richardwhiuk