[Spring] Spring generator uses old Swagger dependency - #5556

Closed
alexsuperdev wants to merge 5 commits into
OpenAPITools:masterfrom
alexsuperdev:fix_4245
Closed

[Spring] Spring generator uses old Swagger dependency#5556
alexsuperdev wants to merge 5 commits into
OpenAPITools:masterfrom
alexsuperdev:fix_4245

Conversation

@alexsuperdev

@alexsuperdevalexsuperdev commented Mar 8, 2020

Copy link
Copy Markdown

Fix4245

Updated swagger-annotations dependency from version 1.5.23 to the actual last release 2.1.1
in generated code for spring libraries
So from

<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.5.23</version>
</dependency>

To:

<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>2.1.1</version>
</dependency>

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @bkabrda (2020/01)

changed mustaches in spring libs to use it with io.swagger.core.v3 in version 2.1.1
deleted import of old ApiModel and ApiModelProperty in spring libs, io.swagger.core.v3 in version 2.1.1 will be used instead
updated spring samples for client and server to use swagger-annotations 2.1.1
handling security with io.swagger.core.v3 in version 2.1.1
fixed comment
updated spring samples handling security for client and server to use swagger-annotations 2.1.1
@alexsuperdev

Copy link
Copy Markdown
Author

Is there a chance that this pullrequest will be reviewed already in this month?

@alexsuperdev

Copy link
Copy Markdown
Author

@wing328 Can you please review this peace of code?

@shred22

Copy link
Copy Markdown

Any tentative timeline on this PR merge ?

@atkawa7

Copy link
Copy Markdown

@wing328 ping

@piotrkav

Copy link
Copy Markdown

any update on this?

@cbornet

Copy link
Copy Markdown
Member

The problem is I don't think Sprinfox v2 which is a widely used lib for Spring support OASv3 annotations.
Sprinfox v3 has been released but I don't think the adoption is significant yet.

@piotrkav

Copy link
Copy Markdown

The problem is I don't think Sprinfox v2 which is a widely used lib for Spring support OASv3 annotations.
Sprinfox v3 has been released but I don't think the adoption is significant yet.

Sorry for misunderstanding, but how springfox is related in this matter?
Using the openapi-generator-maven-plugin it would be ideal if it would generate api interfaces using

<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>2.1.1</version>
</dependency>

which this PR fixes.
According to https://openapi-generator.tech/docs/plugins#dependencies there is a possibility to use v3 annotations, but it doesn't work.

@cbornet

Copy link
Copy Markdown
Member

These annotations are used by libraries to generate the OAS. Springfox is I think the most widely used lib in the Spring world. Or do you have other libs in mind ?

@piotrkav

Copy link
Copy Markdown

These annotations are used by libraries to generate the OAS. Springfox is I think the most widely used lib in the Spring world. Or do you have other libs in mind ?

Springfox is not required to use openapi-generator-maven-plugin. That's why it confuses me 😄

I was thinking about using the springdoc (which would require the v3 annotations to actually show examples/description) and redoc for static files.

@cbornet

Copy link
Copy Markdown
Member

This PR is not about openapi-generator-maven-plugin. It's about the generated code.
Yes Springdoc and Springfox v3 will work with the new annotations. But I think the large majority still uses Springfox v2.
Note that Springfox v3 works with the old annotations to generate an OASv3 doc.

@alexsuperdev

alexsuperdev commented Aug 1, 2020

Copy link
Copy Markdown
Author

This PR is not about openapi-generator-maven-plugin. It's about the generated code.
Yes Springdoc and Springfox v3 will work with the new annotations. But I think the large majority still uses Springfox v2.
Note that Springfox v3 works with the old annotations to generate an OASv3 doc.

Hello @cbornet . I tested it locally, it works with Springfox v2.

@jimschubert

Copy link
Copy Markdown
Member

@cbornet this is specific to the JavaSpring generated output. Since we have a major release coming, I think it would make sense to update to springfox2 3.0.0 in JavaSpring and have this PR integrated in the 5.0 release. If that could be done here, it would also solve issues with pulling openapi-generator into a Spring project generated with our tooling (which currently does not work). See #7102 which is related.

@jimschubertjimschubert added this to the 5.0.0 milestone Aug 1, 2020
@cbornet

Copy link
Copy Markdown
Member

Hello @cbornet . I tested it locally, it works with Springfox v2.

Oh, great ! I thought this was only part of the v3. Then I have no more concern for this PR.

alexsuperdev pushed a commit to alexsuperdev/openapi-generator that referenced this pull request Aug 8, 2020
fixed alignment according to actual master
fixed alignment to 4 spaces
@alexsuperdev

Copy link
Copy Markdown
Author

@cbornet i fixed places, that you commented. The rest is okay?

@atkawa7

Copy link
Copy Markdown

ping @wing328

@cbornet

Copy link
Copy Markdown
Member

LGTM. @alexsuperdev can you resolve the conflicts ?

@alexsuperdev

Copy link
Copy Markdown
Author

LGTM. @alexsuperdev can you resolve the conflicts ?

I tried to resolve them, but not succeeded, its to much work to do, because to many changes were made in code since march.
So in short, i will not resolve this issue. Sorry

@wing328wing328 modified the milestones: 5.0.0, 5.0.1Dec 21, 2020
@wing328wing328 modified the milestones: 5.0.1, 5.1.0Feb 8, 2021
@wing328wing328 removed this from the 5.1.0 milestone Mar 19, 2021
@ddeath

Copy link
Copy Markdown
Contributor

@wing328 I guess this one can be closed

@wing328wing328 closed this Jun 13, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] Spring generator uses old Swagger dependency

10 participants

@alexsuperdev@shred22@atkawa7@piotrkav@cbornet@jimschubert@ddeath@wing328@ackintosh@codermoderlife
, '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

[Spring] Spring generator uses old Swagger dependency - #5556

Closed
alexsuperdev wants to merge 5 commits into
OpenAPITools:masterfrom
alexsuperdev:fix_4245
Closed

[Spring] Spring generator uses old Swagger dependency#5556
alexsuperdev wants to merge 5 commits into
OpenAPITools:masterfrom
alexsuperdev:fix_4245

Conversation

@alexsuperdev

@alexsuperdevalexsuperdev commented Mar 8, 2020

Copy link
Copy Markdown

Fix4245

Updated swagger-annotations dependency from version 1.5.23 to the actual last release 2.1.1
in generated code for spring libraries
So from

<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.5.23</version>
</dependency>

To:

<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>2.1.1</version>
</dependency>

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @bkabrda (2020/01)

changed mustaches in spring libs to use it with io.swagger.core.v3 in version 2.1.1
deleted import of old ApiModel and ApiModelProperty in spring libs, io.swagger.core.v3 in version 2.1.1 will be used instead
updated spring samples for client and server to use swagger-annotations 2.1.1
handling security with io.swagger.core.v3 in version 2.1.1
fixed comment
updated spring samples handling security for client and server to use swagger-annotations 2.1.1
@alexsuperdev

Copy link
Copy Markdown
Author

Is there a chance that this pullrequest will be reviewed already in this month?

@alexsuperdev

Copy link
Copy Markdown
Author

@wing328 Can you please review this peace of code?

@shred22

Copy link
Copy Markdown

Any tentative timeline on this PR merge ?

@atkawa7

Copy link
Copy Markdown

@wing328 ping

@piotrkav

Copy link
Copy Markdown

any update on this?

@cbornet

Copy link
Copy Markdown
Member

The problem is I don't think Sprinfox v2 which is a widely used lib for Spring support OASv3 annotations.
Sprinfox v3 has been released but I don't think the adoption is significant yet.

@piotrkav

Copy link
Copy Markdown

The problem is I don't think Sprinfox v2 which is a widely used lib for Spring support OASv3 annotations.
Sprinfox v3 has been released but I don't think the adoption is significant yet.

Sorry for misunderstanding, but how springfox is related in this matter?
Using the openapi-generator-maven-plugin it would be ideal if it would generate api interfaces using

<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>2.1.1</version>
</dependency>

which this PR fixes.
According to https://openapi-generator.tech/docs/plugins#dependencies there is a possibility to use v3 annotations, but it doesn't work.

@cbornet

Copy link
Copy Markdown
Member

These annotations are used by libraries to generate the OAS. Springfox is I think the most widely used lib in the Spring world. Or do you have other libs in mind ?

@piotrkav

Copy link
Copy Markdown

These annotations are used by libraries to generate the OAS. Springfox is I think the most widely used lib in the Spring world. Or do you have other libs in mind ?

Springfox is not required to use openapi-generator-maven-plugin. That's why it confuses me 😄

I was thinking about using the springdoc (which would require the v3 annotations to actually show examples/description) and redoc for static files.

@cbornet

Copy link
Copy Markdown
Member

This PR is not about openapi-generator-maven-plugin. It's about the generated code.
Yes Springdoc and Springfox v3 will work with the new annotations. But I think the large majority still uses Springfox v2.
Note that Springfox v3 works with the old annotations to generate an OASv3 doc.

@alexsuperdev

alexsuperdev commented Aug 1, 2020

Copy link
Copy Markdown
Author

This PR is not about openapi-generator-maven-plugin. It's about the generated code.
Yes Springdoc and Springfox v3 will work with the new annotations. But I think the large majority still uses Springfox v2.
Note that Springfox v3 works with the old annotations to generate an OASv3 doc.

Hello @cbornet . I tested it locally, it works with Springfox v2.

@jimschubert

Copy link
Copy Markdown
Member

@cbornet this is specific to the JavaSpring generated output. Since we have a major release coming, I think it would make sense to update to springfox2 3.0.0 in JavaSpring and have this PR integrated in the 5.0 release. If that could be done here, it would also solve issues with pulling openapi-generator into a Spring project generated with our tooling (which currently does not work). See #7102 which is related.

@jimschubertjimschubert added this to the 5.0.0 milestone Aug 1, 2020
@cbornet

Copy link
Copy Markdown
Member

Hello @cbornet . I tested it locally, it works with Springfox v2.

Oh, great ! I thought this was only part of the v3. Then I have no more concern for this PR.

alexsuperdev pushed a commit to alexsuperdev/openapi-generator that referenced this pull request Aug 8, 2020
fixed alignment according to actual master
fixed alignment to 4 spaces
@alexsuperdev

Copy link
Copy Markdown
Author

@cbornet i fixed places, that you commented. The rest is okay?

@atkawa7

Copy link
Copy Markdown

ping @wing328

@cbornet

Copy link
Copy Markdown
Member

LGTM. @alexsuperdev can you resolve the conflicts ?

@alexsuperdev

Copy link
Copy Markdown
Author

LGTM. @alexsuperdev can you resolve the conflicts ?

I tried to resolve them, but not succeeded, its to much work to do, because to many changes were made in code since march.
So in short, i will not resolve this issue. Sorry

@wing328wing328 modified the milestones: 5.0.0, 5.0.1Dec 21, 2020
@wing328wing328 modified the milestones: 5.0.1, 5.1.0Feb 8, 2021
@wing328wing328 removed this from the 5.1.0 milestone Mar 19, 2021
@ddeath

Copy link
Copy Markdown
Contributor

@wing328 I guess this one can be closed

@wing328wing328 closed this Jun 13, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] Spring generator uses old Swagger dependency

10 participants

@alexsuperdev@shred22@atkawa7@piotrkav@cbornet@jimschubert@ddeath@wing328@ackintosh@codermoderlife
, '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

[Spring] Spring generator uses old Swagger dependency - #5556

Closed
alexsuperdev wants to merge 5 commits into
OpenAPITools:masterfrom
alexsuperdev:fix_4245
Closed

[Spring] Spring generator uses old Swagger dependency#5556
alexsuperdev wants to merge 5 commits into
OpenAPITools:masterfrom
alexsuperdev:fix_4245

Conversation

@alexsuperdev

@alexsuperdevalexsuperdev commented Mar 8, 2020

Copy link
Copy Markdown

Fix4245

Updated swagger-annotations dependency from version 1.5.23 to the actual last release 2.1.1
in generated code for spring libraries
So from

<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.5.23</version>
</dependency>

To:

<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>2.1.1</version>
</dependency>

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @bkabrda (2020/01)

changed mustaches in spring libs to use it with io.swagger.core.v3 in version 2.1.1
deleted import of old ApiModel and ApiModelProperty in spring libs, io.swagger.core.v3 in version 2.1.1 will be used instead
updated spring samples for client and server to use swagger-annotations 2.1.1
handling security with io.swagger.core.v3 in version 2.1.1
fixed comment
updated spring samples handling security for client and server to use swagger-annotations 2.1.1
@alexsuperdev

Copy link
Copy Markdown
Author

Is there a chance that this pullrequest will be reviewed already in this month?

@alexsuperdev

Copy link
Copy Markdown
Author

@wing328 Can you please review this peace of code?

@shred22

Copy link
Copy Markdown

Any tentative timeline on this PR merge ?

@atkawa7

Copy link
Copy Markdown

@wing328 ping

@piotrkav

Copy link
Copy Markdown

any update on this?

@cbornet

Copy link
Copy Markdown
Member

The problem is I don't think Sprinfox v2 which is a widely used lib for Spring support OASv3 annotations.
Sprinfox v3 has been released but I don't think the adoption is significant yet.

@piotrkav

Copy link
Copy Markdown

The problem is I don't think Sprinfox v2 which is a widely used lib for Spring support OASv3 annotations.
Sprinfox v3 has been released but I don't think the adoption is significant yet.

Sorry for misunderstanding, but how springfox is related in this matter?
Using the openapi-generator-maven-plugin it would be ideal if it would generate api interfaces using

<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>2.1.1</version>
</dependency>

which this PR fixes.
According to https://openapi-generator.tech/docs/plugins#dependencies there is a possibility to use v3 annotations, but it doesn't work.

@cbornet

Copy link
Copy Markdown
Member

These annotations are used by libraries to generate the OAS. Springfox is I think the most widely used lib in the Spring world. Or do you have other libs in mind ?

@piotrkav

Copy link
Copy Markdown

These annotations are used by libraries to generate the OAS. Springfox is I think the most widely used lib in the Spring world. Or do you have other libs in mind ?

Springfox is not required to use openapi-generator-maven-plugin. That's why it confuses me 😄

I was thinking about using the springdoc (which would require the v3 annotations to actually show examples/description) and redoc for static files.

@cbornet

Copy link
Copy Markdown
Member

This PR is not about openapi-generator-maven-plugin. It's about the generated code.
Yes Springdoc and Springfox v3 will work with the new annotations. But I think the large majority still uses Springfox v2.
Note that Springfox v3 works with the old annotations to generate an OASv3 doc.

@alexsuperdev

alexsuperdev commented Aug 1, 2020

Copy link
Copy Markdown
Author

This PR is not about openapi-generator-maven-plugin. It's about the generated code.
Yes Springdoc and Springfox v3 will work with the new annotations. But I think the large majority still uses Springfox v2.
Note that Springfox v3 works with the old annotations to generate an OASv3 doc.

Hello @cbornet . I tested it locally, it works with Springfox v2.

@jimschubert

Copy link
Copy Markdown
Member

@cbornet this is specific to the JavaSpring generated output. Since we have a major release coming, I think it would make sense to update to springfox2 3.0.0 in JavaSpring and have this PR integrated in the 5.0 release. If that could be done here, it would also solve issues with pulling openapi-generator into a Spring project generated with our tooling (which currently does not work). See #7102 which is related.

@jimschubertjimschubert added this to the 5.0.0 milestone Aug 1, 2020
@cbornet

Copy link
Copy Markdown
Member

Hello @cbornet . I tested it locally, it works with Springfox v2.

Oh, great ! I thought this was only part of the v3. Then I have no more concern for this PR.

alexsuperdev pushed a commit to alexsuperdev/openapi-generator that referenced this pull request Aug 8, 2020
fixed alignment according to actual master
fixed alignment to 4 spaces
@alexsuperdev

Copy link
Copy Markdown
Author

@cbornet i fixed places, that you commented. The rest is okay?

@atkawa7

Copy link
Copy Markdown

ping @wing328

@cbornet

Copy link
Copy Markdown
Member

LGTM. @alexsuperdev can you resolve the conflicts ?

@alexsuperdev

Copy link
Copy Markdown
Author

LGTM. @alexsuperdev can you resolve the conflicts ?

I tried to resolve them, but not succeeded, its to much work to do, because to many changes were made in code since march.
So in short, i will not resolve this issue. Sorry

@wing328wing328 modified the milestones: 5.0.0, 5.0.1Dec 21, 2020
@wing328wing328 modified the milestones: 5.0.1, 5.1.0Feb 8, 2021
@wing328wing328 removed this from the 5.1.0 milestone Mar 19, 2021
@ddeath

Copy link
Copy Markdown
Contributor

@wing328 I guess this one can be closed

@wing328wing328 closed this Jun 13, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] Spring generator uses old Swagger dependency

10 participants

@alexsuperdev@shred22@atkawa7@piotrkav@cbornet@jimschubert@ddeath@wing328@ackintosh@codermoderlife
, '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

[Spring] Spring generator uses old Swagger dependency - #5556

Closed
alexsuperdev wants to merge 5 commits into
OpenAPITools:masterfrom
alexsuperdev:fix_4245
Closed

[Spring] Spring generator uses old Swagger dependency#5556
alexsuperdev wants to merge 5 commits into
OpenAPITools:masterfrom
alexsuperdev:fix_4245

Conversation

@alexsuperdev

@alexsuperdevalexsuperdev commented Mar 8, 2020

Copy link
Copy Markdown

Fix4245

Updated swagger-annotations dependency from version 1.5.23 to the actual last release 2.1.1
in generated code for spring libraries
So from

<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.5.23</version>
</dependency>

To:

<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>2.1.1</version>
</dependency>

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @bkabrda (2020/01)

changed mustaches in spring libs to use it with io.swagger.core.v3 in version 2.1.1
deleted import of old ApiModel and ApiModelProperty in spring libs, io.swagger.core.v3 in version 2.1.1 will be used instead
updated spring samples for client and server to use swagger-annotations 2.1.1
handling security with io.swagger.core.v3 in version 2.1.1
fixed comment
updated spring samples handling security for client and server to use swagger-annotations 2.1.1
@alexsuperdev

Copy link
Copy Markdown
Author

Is there a chance that this pullrequest will be reviewed already in this month?

@alexsuperdev

Copy link
Copy Markdown
Author

@wing328 Can you please review this peace of code?

@shred22

Copy link
Copy Markdown

Any tentative timeline on this PR merge ?

@atkawa7

Copy link
Copy Markdown

@wing328 ping

@piotrkav

Copy link
Copy Markdown

any update on this?

@cbornet

Copy link
Copy Markdown
Member

The problem is I don't think Sprinfox v2 which is a widely used lib for Spring support OASv3 annotations.
Sprinfox v3 has been released but I don't think the adoption is significant yet.

@piotrkav

Copy link
Copy Markdown

The problem is I don't think Sprinfox v2 which is a widely used lib for Spring support OASv3 annotations.
Sprinfox v3 has been released but I don't think the adoption is significant yet.

Sorry for misunderstanding, but how springfox is related in this matter?
Using the openapi-generator-maven-plugin it would be ideal if it would generate api interfaces using

<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>2.1.1</version>
</dependency>

which this PR fixes.
According to https://openapi-generator.tech/docs/plugins#dependencies there is a possibility to use v3 annotations, but it doesn't work.

@cbornet

Copy link
Copy Markdown
Member

These annotations are used by libraries to generate the OAS. Springfox is I think the most widely used lib in the Spring world. Or do you have other libs in mind ?

@piotrkav

Copy link
Copy Markdown

These annotations are used by libraries to generate the OAS. Springfox is I think the most widely used lib in the Spring world. Or do you have other libs in mind ?

Springfox is not required to use openapi-generator-maven-plugin. That's why it confuses me 😄

I was thinking about using the springdoc (which would require the v3 annotations to actually show examples/description) and redoc for static files.

@cbornet

Copy link
Copy Markdown
Member

This PR is not about openapi-generator-maven-plugin. It's about the generated code.
Yes Springdoc and Springfox v3 will work with the new annotations. But I think the large majority still uses Springfox v2.
Note that Springfox v3 works with the old annotations to generate an OASv3 doc.

@alexsuperdev

alexsuperdev commented Aug 1, 2020

Copy link
Copy Markdown
Author

This PR is not about openapi-generator-maven-plugin. It's about the generated code.
Yes Springdoc and Springfox v3 will work with the new annotations. But I think the large majority still uses Springfox v2.
Note that Springfox v3 works with the old annotations to generate an OASv3 doc.

Hello @cbornet . I tested it locally, it works with Springfox v2.

@jimschubert

Copy link
Copy Markdown
Member

@cbornet this is specific to the JavaSpring generated output. Since we have a major release coming, I think it would make sense to update to springfox2 3.0.0 in JavaSpring and have this PR integrated in the 5.0 release. If that could be done here, it would also solve issues with pulling openapi-generator into a Spring project generated with our tooling (which currently does not work). See #7102 which is related.

@jimschubertjimschubert added this to the 5.0.0 milestone Aug 1, 2020
@cbornet

Copy link
Copy Markdown
Member

Hello @cbornet . I tested it locally, it works with Springfox v2.

Oh, great ! I thought this was only part of the v3. Then I have no more concern for this PR.

alexsuperdev pushed a commit to alexsuperdev/openapi-generator that referenced this pull request Aug 8, 2020
fixed alignment according to actual master
fixed alignment to 4 spaces
@alexsuperdev

Copy link
Copy Markdown
Author

@cbornet i fixed places, that you commented. The rest is okay?

@atkawa7

Copy link
Copy Markdown

ping @wing328

@cbornet

Copy link
Copy Markdown
Member

LGTM. @alexsuperdev can you resolve the conflicts ?

@alexsuperdev

Copy link
Copy Markdown
Author

LGTM. @alexsuperdev can you resolve the conflicts ?

I tried to resolve them, but not succeeded, its to much work to do, because to many changes were made in code since march.
So in short, i will not resolve this issue. Sorry

@wing328wing328 modified the milestones: 5.0.0, 5.0.1Dec 21, 2020
@wing328wing328 modified the milestones: 5.0.1, 5.1.0Feb 8, 2021
@wing328wing328 removed this from the 5.1.0 milestone Mar 19, 2021
@ddeath

Copy link
Copy Markdown
Contributor

@wing328 I guess this one can be closed

@wing328wing328 closed this Jun 13, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] Spring generator uses old Swagger dependency

10 participants

@alexsuperdev@shred22@atkawa7@piotrkav@cbornet@jimschubert@ddeath@wing328@ackintosh@codermoderlife
, '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

[Spring] Spring generator uses old Swagger dependency - #5556

Closed
alexsuperdev wants to merge 5 commits into
OpenAPITools:masterfrom
alexsuperdev:fix_4245
Closed

[Spring] Spring generator uses old Swagger dependency#5556
alexsuperdev wants to merge 5 commits into
OpenAPITools:masterfrom
alexsuperdev:fix_4245

Conversation

@alexsuperdev

@alexsuperdevalexsuperdev commented Mar 8, 2020

Copy link
Copy Markdown

Fix4245

Updated swagger-annotations dependency from version 1.5.23 to the actual last release 2.1.1
in generated code for spring libraries
So from

<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.5.23</version>
</dependency>

To:

<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>2.1.1</version>
</dependency>

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @bkabrda (2020/01)

changed mustaches in spring libs to use it with io.swagger.core.v3 in version 2.1.1
deleted import of old ApiModel and ApiModelProperty in spring libs, io.swagger.core.v3 in version 2.1.1 will be used instead
updated spring samples for client and server to use swagger-annotations 2.1.1
handling security with io.swagger.core.v3 in version 2.1.1
fixed comment
updated spring samples handling security for client and server to use swagger-annotations 2.1.1
@alexsuperdev

Copy link
Copy Markdown
Author

Is there a chance that this pullrequest will be reviewed already in this month?

@alexsuperdev

Copy link
Copy Markdown
Author

@wing328 Can you please review this peace of code?

@shred22

Copy link
Copy Markdown

Any tentative timeline on this PR merge ?

@atkawa7

Copy link
Copy Markdown

@wing328 ping

@piotrkav

Copy link
Copy Markdown

any update on this?

@cbornet

Copy link
Copy Markdown
Member

The problem is I don't think Sprinfox v2 which is a widely used lib for Spring support OASv3 annotations.
Sprinfox v3 has been released but I don't think the adoption is significant yet.

@piotrkav

Copy link
Copy Markdown

The problem is I don't think Sprinfox v2 which is a widely used lib for Spring support OASv3 annotations.
Sprinfox v3 has been released but I don't think the adoption is significant yet.

Sorry for misunderstanding, but how springfox is related in this matter?
Using the openapi-generator-maven-plugin it would be ideal if it would generate api interfaces using

<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>2.1.1</version>
</dependency>

which this PR fixes.
According to https://openapi-generator.tech/docs/plugins#dependencies there is a possibility to use v3 annotations, but it doesn't work.

@cbornet

Copy link
Copy Markdown
Member

These annotations are used by libraries to generate the OAS. Springfox is I think the most widely used lib in the Spring world. Or do you have other libs in mind ?

@piotrkav

Copy link
Copy Markdown

These annotations are used by libraries to generate the OAS. Springfox is I think the most widely used lib in the Spring world. Or do you have other libs in mind ?

Springfox is not required to use openapi-generator-maven-plugin. That's why it confuses me 😄

I was thinking about using the springdoc (which would require the v3 annotations to actually show examples/description) and redoc for static files.

@cbornet

Copy link
Copy Markdown
Member

This PR is not about openapi-generator-maven-plugin. It's about the generated code.
Yes Springdoc and Springfox v3 will work with the new annotations. But I think the large majority still uses Springfox v2.
Note that Springfox v3 works with the old annotations to generate an OASv3 doc.

@alexsuperdev

alexsuperdev commented Aug 1, 2020

Copy link
Copy Markdown
Author

This PR is not about openapi-generator-maven-plugin. It's about the generated code.
Yes Springdoc and Springfox v3 will work with the new annotations. But I think the large majority still uses Springfox v2.
Note that Springfox v3 works with the old annotations to generate an OASv3 doc.

Hello @cbornet . I tested it locally, it works with Springfox v2.

@jimschubert

Copy link
Copy Markdown
Member

@cbornet this is specific to the JavaSpring generated output. Since we have a major release coming, I think it would make sense to update to springfox2 3.0.0 in JavaSpring and have this PR integrated in the 5.0 release. If that could be done here, it would also solve issues with pulling openapi-generator into a Spring project generated with our tooling (which currently does not work). See #7102 which is related.

@jimschubertjimschubert added this to the 5.0.0 milestone Aug 1, 2020
@cbornet

Copy link
Copy Markdown
Member

Hello @cbornet . I tested it locally, it works with Springfox v2.

Oh, great ! I thought this was only part of the v3. Then I have no more concern for this PR.

alexsuperdev pushed a commit to alexsuperdev/openapi-generator that referenced this pull request Aug 8, 2020
fixed alignment according to actual master
fixed alignment to 4 spaces
@alexsuperdev

Copy link
Copy Markdown
Author

@cbornet i fixed places, that you commented. The rest is okay?

@atkawa7

Copy link
Copy Markdown

ping @wing328

@cbornet

Copy link
Copy Markdown
Member

LGTM. @alexsuperdev can you resolve the conflicts ?

@alexsuperdev

Copy link
Copy Markdown
Author

LGTM. @alexsuperdev can you resolve the conflicts ?

I tried to resolve them, but not succeeded, its to much work to do, because to many changes were made in code since march.
So in short, i will not resolve this issue. Sorry

@wing328wing328 modified the milestones: 5.0.0, 5.0.1Dec 21, 2020
@wing328wing328 modified the milestones: 5.0.1, 5.1.0Feb 8, 2021
@wing328wing328 removed this from the 5.1.0 milestone Mar 19, 2021
@ddeath

Copy link
Copy Markdown
Contributor

@wing328 I guess this one can be closed

@wing328wing328 closed this Jun 13, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] Spring generator uses old Swagger dependency

10 participants

@alexsuperdev@shred22@atkawa7@piotrkav@cbornet@jimschubert@ddeath@wing328@ackintosh@codermoderlife
, '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

[Spring] Spring generator uses old Swagger dependency - #5556

Closed
alexsuperdev wants to merge 5 commits into
OpenAPITools:masterfrom
alexsuperdev:fix_4245
Closed

[Spring] Spring generator uses old Swagger dependency#5556
alexsuperdev wants to merge 5 commits into
OpenAPITools:masterfrom
alexsuperdev:fix_4245

Conversation

@alexsuperdev

@alexsuperdevalexsuperdev commented Mar 8, 2020

Copy link
Copy Markdown

Fix4245

Updated swagger-annotations dependency from version 1.5.23 to the actual last release 2.1.1
in generated code for spring libraries
So from

<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.5.23</version>
</dependency>

To:

<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>2.1.1</version>
</dependency>

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @bkabrda (2020/01)

changed mustaches in spring libs to use it with io.swagger.core.v3 in version 2.1.1
deleted import of old ApiModel and ApiModelProperty in spring libs, io.swagger.core.v3 in version 2.1.1 will be used instead
updated spring samples for client and server to use swagger-annotations 2.1.1
handling security with io.swagger.core.v3 in version 2.1.1
fixed comment
updated spring samples handling security for client and server to use swagger-annotations 2.1.1
@alexsuperdev

Copy link
Copy Markdown
Author

Is there a chance that this pullrequest will be reviewed already in this month?

@alexsuperdev

Copy link
Copy Markdown
Author

@wing328 Can you please review this peace of code?

@shred22

Copy link
Copy Markdown

Any tentative timeline on this PR merge ?

@atkawa7

Copy link
Copy Markdown

@wing328 ping

@piotrkav

Copy link
Copy Markdown

any update on this?

@cbornet

Copy link
Copy Markdown
Member

The problem is I don't think Sprinfox v2 which is a widely used lib for Spring support OASv3 annotations.
Sprinfox v3 has been released but I don't think the adoption is significant yet.

@piotrkav

Copy link
Copy Markdown

The problem is I don't think Sprinfox v2 which is a widely used lib for Spring support OASv3 annotations.
Sprinfox v3 has been released but I don't think the adoption is significant yet.

Sorry for misunderstanding, but how springfox is related in this matter?
Using the openapi-generator-maven-plugin it would be ideal if it would generate api interfaces using

<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>2.1.1</version>
</dependency>

which this PR fixes.
According to https://openapi-generator.tech/docs/plugins#dependencies there is a possibility to use v3 annotations, but it doesn't work.

@cbornet

Copy link
Copy Markdown
Member

These annotations are used by libraries to generate the OAS. Springfox is I think the most widely used lib in the Spring world. Or do you have other libs in mind ?

@piotrkav

Copy link
Copy Markdown

These annotations are used by libraries to generate the OAS. Springfox is I think the most widely used lib in the Spring world. Or do you have other libs in mind ?

Springfox is not required to use openapi-generator-maven-plugin. That's why it confuses me 😄

I was thinking about using the springdoc (which would require the v3 annotations to actually show examples/description) and redoc for static files.

@cbornet

Copy link
Copy Markdown
Member

This PR is not about openapi-generator-maven-plugin. It's about the generated code.
Yes Springdoc and Springfox v3 will work with the new annotations. But I think the large majority still uses Springfox v2.
Note that Springfox v3 works with the old annotations to generate an OASv3 doc.

@alexsuperdev

alexsuperdev commented Aug 1, 2020

Copy link
Copy Markdown
Author

This PR is not about openapi-generator-maven-plugin. It's about the generated code.
Yes Springdoc and Springfox v3 will work with the new annotations. But I think the large majority still uses Springfox v2.
Note that Springfox v3 works with the old annotations to generate an OASv3 doc.

Hello @cbornet . I tested it locally, it works with Springfox v2.

@jimschubert

Copy link
Copy Markdown
Member

@cbornet this is specific to the JavaSpring generated output. Since we have a major release coming, I think it would make sense to update to springfox2 3.0.0 in JavaSpring and have this PR integrated in the 5.0 release. If that could be done here, it would also solve issues with pulling openapi-generator into a Spring project generated with our tooling (which currently does not work). See #7102 which is related.

@jimschubertjimschubert added this to the 5.0.0 milestone Aug 1, 2020
@cbornet

Copy link
Copy Markdown
Member

Hello @cbornet . I tested it locally, it works with Springfox v2.

Oh, great ! I thought this was only part of the v3. Then I have no more concern for this PR.

alexsuperdev pushed a commit to alexsuperdev/openapi-generator that referenced this pull request Aug 8, 2020
fixed alignment according to actual master
fixed alignment to 4 spaces
@alexsuperdev

Copy link
Copy Markdown
Author

@cbornet i fixed places, that you commented. The rest is okay?

@atkawa7

Copy link
Copy Markdown

ping @wing328

@cbornet

Copy link
Copy Markdown
Member

LGTM. @alexsuperdev can you resolve the conflicts ?

@alexsuperdev

Copy link
Copy Markdown
Author

LGTM. @alexsuperdev can you resolve the conflicts ?

I tried to resolve them, but not succeeded, its to much work to do, because to many changes were made in code since march.
So in short, i will not resolve this issue. Sorry

@wing328wing328 modified the milestones: 5.0.0, 5.0.1Dec 21, 2020
@wing328wing328 modified the milestones: 5.0.1, 5.1.0Feb 8, 2021
@wing328wing328 removed this from the 5.1.0 milestone Mar 19, 2021
@ddeath

Copy link
Copy Markdown
Contributor

@wing328 I guess this one can be closed

@wing328wing328 closed this Jun 13, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] Spring generator uses old Swagger dependency

10 participants

@alexsuperdev@shred22@atkawa7@piotrkav@cbornet@jimschubert@ddeath@wing328@ackintosh@codermoderlife
, '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

[Spring] Spring generator uses old Swagger dependency - #5556

Closed
alexsuperdev wants to merge 5 commits into
OpenAPITools:masterfrom
alexsuperdev:fix_4245
Closed

[Spring] Spring generator uses old Swagger dependency#5556
alexsuperdev wants to merge 5 commits into
OpenAPITools:masterfrom
alexsuperdev:fix_4245

Conversation

@alexsuperdev

@alexsuperdevalexsuperdev commented Mar 8, 2020

Copy link
Copy Markdown

Fix4245

Updated swagger-annotations dependency from version 1.5.23 to the actual last release 2.1.1
in generated code for spring libraries
So from

<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.5.23</version>
</dependency>

To:

<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>2.1.1</version>
</dependency>

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @bkabrda (2020/01)

changed mustaches in spring libs to use it with io.swagger.core.v3 in version 2.1.1
deleted import of old ApiModel and ApiModelProperty in spring libs, io.swagger.core.v3 in version 2.1.1 will be used instead
updated spring samples for client and server to use swagger-annotations 2.1.1
handling security with io.swagger.core.v3 in version 2.1.1
fixed comment
updated spring samples handling security for client and server to use swagger-annotations 2.1.1
@alexsuperdev

Copy link
Copy Markdown
Author

Is there a chance that this pullrequest will be reviewed already in this month?

@alexsuperdev

Copy link
Copy Markdown
Author

@wing328 Can you please review this peace of code?

@shred22

Copy link
Copy Markdown

Any tentative timeline on this PR merge ?

@atkawa7

Copy link
Copy Markdown

@wing328 ping

@piotrkav

Copy link
Copy Markdown

any update on this?

@cbornet

Copy link
Copy Markdown
Member

The problem is I don't think Sprinfox v2 which is a widely used lib for Spring support OASv3 annotations.
Sprinfox v3 has been released but I don't think the adoption is significant yet.

@piotrkav

Copy link
Copy Markdown

The problem is I don't think Sprinfox v2 which is a widely used lib for Spring support OASv3 annotations.
Sprinfox v3 has been released but I don't think the adoption is significant yet.

Sorry for misunderstanding, but how springfox is related in this matter?
Using the openapi-generator-maven-plugin it would be ideal if it would generate api interfaces using

<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>2.1.1</version>
</dependency>

which this PR fixes.
According to https://openapi-generator.tech/docs/plugins#dependencies there is a possibility to use v3 annotations, but it doesn't work.

@cbornet

Copy link
Copy Markdown
Member

These annotations are used by libraries to generate the OAS. Springfox is I think the most widely used lib in the Spring world. Or do you have other libs in mind ?

@piotrkav

Copy link
Copy Markdown

These annotations are used by libraries to generate the OAS. Springfox is I think the most widely used lib in the Spring world. Or do you have other libs in mind ?

Springfox is not required to use openapi-generator-maven-plugin. That's why it confuses me 😄

I was thinking about using the springdoc (which would require the v3 annotations to actually show examples/description) and redoc for static files.

@cbornet

Copy link
Copy Markdown
Member

This PR is not about openapi-generator-maven-plugin. It's about the generated code.
Yes Springdoc and Springfox v3 will work with the new annotations. But I think the large majority still uses Springfox v2.
Note that Springfox v3 works with the old annotations to generate an OASv3 doc.

@alexsuperdev

alexsuperdev commented Aug 1, 2020

Copy link
Copy Markdown
Author

This PR is not about openapi-generator-maven-plugin. It's about the generated code.
Yes Springdoc and Springfox v3 will work with the new annotations. But I think the large majority still uses Springfox v2.
Note that Springfox v3 works with the old annotations to generate an OASv3 doc.

Hello @cbornet . I tested it locally, it works with Springfox v2.

@jimschubert

Copy link
Copy Markdown
Member

@cbornet this is specific to the JavaSpring generated output. Since we have a major release coming, I think it would make sense to update to springfox2 3.0.0 in JavaSpring and have this PR integrated in the 5.0 release. If that could be done here, it would also solve issues with pulling openapi-generator into a Spring project generated with our tooling (which currently does not work). See #7102 which is related.

@jimschubertjimschubert added this to the 5.0.0 milestone Aug 1, 2020
@cbornet

Copy link
Copy Markdown
Member

Hello @cbornet . I tested it locally, it works with Springfox v2.

Oh, great ! I thought this was only part of the v3. Then I have no more concern for this PR.

alexsuperdev pushed a commit to alexsuperdev/openapi-generator that referenced this pull request Aug 8, 2020
fixed alignment according to actual master
fixed alignment to 4 spaces
@alexsuperdev

Copy link
Copy Markdown
Author

@cbornet i fixed places, that you commented. The rest is okay?

@atkawa7

Copy link
Copy Markdown

ping @wing328

@cbornet

Copy link
Copy Markdown
Member

LGTM. @alexsuperdev can you resolve the conflicts ?

@alexsuperdev

Copy link
Copy Markdown
Author

LGTM. @alexsuperdev can you resolve the conflicts ?

I tried to resolve them, but not succeeded, its to much work to do, because to many changes were made in code since march.
So in short, i will not resolve this issue. Sorry

@wing328wing328 modified the milestones: 5.0.0, 5.0.1Dec 21, 2020
@wing328wing328 modified the milestones: 5.0.1, 5.1.0Feb 8, 2021
@wing328wing328 removed this from the 5.1.0 milestone Mar 19, 2021
@ddeath

Copy link
Copy Markdown
Contributor

@wing328 I guess this one can be closed

@wing328wing328 closed this Jun 13, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] Spring generator uses old Swagger dependency

10 participants

@alexsuperdev@shred22@atkawa7@piotrkav@cbornet@jimschubert@ddeath@wing328@ackintosh@codermoderlife
, '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

[Spring] Spring generator uses old Swagger dependency - #5556

Closed
alexsuperdev wants to merge 5 commits into
OpenAPITools:masterfrom
alexsuperdev:fix_4245
Closed

[Spring] Spring generator uses old Swagger dependency#5556
alexsuperdev wants to merge 5 commits into
OpenAPITools:masterfrom
alexsuperdev:fix_4245

Conversation

@alexsuperdev

@alexsuperdevalexsuperdev commented Mar 8, 2020

Copy link
Copy Markdown

Fix4245

Updated swagger-annotations dependency from version 1.5.23 to the actual last release 2.1.1
in generated code for spring libraries
So from

<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.5.23</version>
</dependency>

To:

<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>2.1.1</version>
</dependency>

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project before.
  • Run the shell script(s) under ./bin/ (or Windows batch scripts under.\bin\windows) to update Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit, and these must match the expectations made by your contribution. You only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the code or mustache templates for a language ({LANG}) (e.g. php, ruby, python, etc).
  • File the PR against the correct branch: master, 4.3.x, 5.0.x. Default: master.
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

cc @bbdouglas (2017/07) @sreeshas (2017/08) @jfiala (2017/08) @lukoyanov (2017/09) @cbornet (2017/09) @jeff9finger (2018/01) @karismann (2019/03) @Zomzog (2019/04) @lwlee2608 (2019/10) @bkabrda (2020/01)

changed mustaches in spring libs to use it with io.swagger.core.v3 in version 2.1.1
deleted import of old ApiModel and ApiModelProperty in spring libs, io.swagger.core.v3 in version 2.1.1 will be used instead
updated spring samples for client and server to use swagger-annotations 2.1.1
handling security with io.swagger.core.v3 in version 2.1.1
fixed comment
updated spring samples handling security for client and server to use swagger-annotations 2.1.1
@alexsuperdev

Copy link
Copy Markdown
Author

Is there a chance that this pullrequest will be reviewed already in this month?

@alexsuperdev

Copy link
Copy Markdown
Author

@wing328 Can you please review this peace of code?

@shred22

Copy link
Copy Markdown

Any tentative timeline on this PR merge ?

@atkawa7

Copy link
Copy Markdown

@wing328 ping

@piotrkav

Copy link
Copy Markdown

any update on this?

@cbornet

Copy link
Copy Markdown
Member

The problem is I don't think Sprinfox v2 which is a widely used lib for Spring support OASv3 annotations.
Sprinfox v3 has been released but I don't think the adoption is significant yet.

@piotrkav

Copy link
Copy Markdown

The problem is I don't think Sprinfox v2 which is a widely used lib for Spring support OASv3 annotations.
Sprinfox v3 has been released but I don't think the adoption is significant yet.

Sorry for misunderstanding, but how springfox is related in this matter?
Using the openapi-generator-maven-plugin it would be ideal if it would generate api interfaces using

<dependency>
<groupId>io.swagger.core.v3</groupId>
<artifactId>swagger-annotations</artifactId>
<version>2.1.1</version>
</dependency>

which this PR fixes.
According to https://openapi-generator.tech/docs/plugins#dependencies there is a possibility to use v3 annotations, but it doesn't work.

@cbornet

Copy link
Copy Markdown
Member

These annotations are used by libraries to generate the OAS. Springfox is I think the most widely used lib in the Spring world. Or do you have other libs in mind ?

@piotrkav

Copy link
Copy Markdown

These annotations are used by libraries to generate the OAS. Springfox is I think the most widely used lib in the Spring world. Or do you have other libs in mind ?

Springfox is not required to use openapi-generator-maven-plugin. That's why it confuses me 😄

I was thinking about using the springdoc (which would require the v3 annotations to actually show examples/description) and redoc for static files.

@cbornet

Copy link
Copy Markdown
Member

This PR is not about openapi-generator-maven-plugin. It's about the generated code.
Yes Springdoc and Springfox v3 will work with the new annotations. But I think the large majority still uses Springfox v2.
Note that Springfox v3 works with the old annotations to generate an OASv3 doc.

@alexsuperdev

alexsuperdev commented Aug 1, 2020

Copy link
Copy Markdown
Author

This PR is not about openapi-generator-maven-plugin. It's about the generated code.
Yes Springdoc and Springfox v3 will work with the new annotations. But I think the large majority still uses Springfox v2.
Note that Springfox v3 works with the old annotations to generate an OASv3 doc.

Hello @cbornet . I tested it locally, it works with Springfox v2.

@jimschubert

Copy link
Copy Markdown
Member

@cbornet this is specific to the JavaSpring generated output. Since we have a major release coming, I think it would make sense to update to springfox2 3.0.0 in JavaSpring and have this PR integrated in the 5.0 release. If that could be done here, it would also solve issues with pulling openapi-generator into a Spring project generated with our tooling (which currently does not work). See #7102 which is related.

@jimschubertjimschubert added this to the 5.0.0 milestone Aug 1, 2020
@cbornet

Copy link
Copy Markdown
Member

Hello @cbornet . I tested it locally, it works with Springfox v2.

Oh, great ! I thought this was only part of the v3. Then I have no more concern for this PR.

alexsuperdev pushed a commit to alexsuperdev/openapi-generator that referenced this pull request Aug 8, 2020
fixed alignment according to actual master
fixed alignment to 4 spaces
@alexsuperdev

Copy link
Copy Markdown
Author

@cbornet i fixed places, that you commented. The rest is okay?

@atkawa7

Copy link
Copy Markdown

ping @wing328

@cbornet

Copy link
Copy Markdown
Member

LGTM. @alexsuperdev can you resolve the conflicts ?

@alexsuperdev

Copy link
Copy Markdown
Author

LGTM. @alexsuperdev can you resolve the conflicts ?

I tried to resolve them, but not succeeded, its to much work to do, because to many changes were made in code since march.
So in short, i will not resolve this issue. Sorry

@wing328wing328 modified the milestones: 5.0.0, 5.0.1Dec 21, 2020
@wing328wing328 modified the milestones: 5.0.1, 5.1.0Feb 8, 2021
@wing328wing328 removed this from the 5.1.0 milestone Mar 19, 2021
@ddeath

Copy link
Copy Markdown
Contributor

@wing328 I guess this one can be closed

@wing328wing328 closed this Jun 13, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] Spring generator uses old Swagger dependency

10 participants

@alexsuperdev@shred22@atkawa7@piotrkav@cbornet@jimschubert@ddeath@wing328@ackintosh@codermoderlife