Skip to content
New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

[JavaSpring] Enable scopes for all security scheme types #17083

Merged
merged 1 commit into from
Dec 9, 2023
Merged

[JavaSpring] Enable scopes for all security scheme types #17083

merged 1 commit into from
Dec 9, 2023
+17 −6

Conversation

kota65535
Copy link
Contributor

@kota65535 kota65535 commented Nov 15, 2023 •
edited
Loading

fix: #17085

To Java technical committee: @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) @martin-mfg (2023/08)

PR checklist

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

@kota65535 kota65535 marked this pull request as draft November 15, 2023 14:53
@kota65535 kota65535 force-pushed the spring-scope-for-all-auth branch from a6c6665 to 1d134cd Compare November 15, 2023 15:44
@kota65535 kota65535 changed the title enable scopes for all security scheme types [JavaSpring] Enable scopes for all security scheme types Nov 15, 2023
@kota65535 kota65535 force-pushed the spring-scope-for-all-auth branch from 1d134cd to 79e02e6 Compare November 15, 2023 15:53
@kota65535 kota65535 marked this pull request as ready for review November 15, 2023 16:08
@wing328
Copy link
Member

wing328 commented Nov 17, 2023

cc
@cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02) @Zomzog (2022/09) @martin-mfg (2023/08)

@kota65535
Copy link
Contributor Author

Hi team, could you take a look?
@cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02) @Zomzog (2022/09) @martin-mfg (2023/08)

welshm
welshm reviewed Dec 8, 2023
View reviewed changes
modules/openapi-generator/src/main/resources/JavaSpring/api.mustache
@@ -196,16 +196,16 @@ public interface {{classname}} {
responseContainer = "{{{.}}}"{{/returnContainer}}{{#hasAuthMethods}},
authorizations = {
{{#authMethods}}
{{#isOAuth}}
{{#scopes.0}}
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this just using the first scope? Can/should this consider any additional scopes?

Copy link
Contributor Author

@kota65535 kota65535 Dec 9, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

Hi welshm, Thanks for your review.
This is idiom that checks if the array scopes is not empty, which is already used in the many places of existing templates (ex: here, and here).

So when multiple scopes are specified...

security:
  - bearer: [ foo, bar ]

It will be generated using all scopes as follows.

security = {
    @SecurityRequirement(name = "bearer", scopes={ "foo", "bar" })
}

wing328
wing328 reviewed Dec 9, 2023
View reviewed changes
modules/openapi-generator/src/main/java/org/openapitools/codegen/CodegenSecurity.java
@@ -89,6 +90,16 @@ public CodegenSecurity (CodegenSecurity original) {
public CodegenSecurity filterByScopeNames(List<String> filterScopes) {
CodegenSecurity filteredSecurity = new CodegenSecurity(this);

// Since OAS 3.1.0, security scheme types other than "oauth2" and "openIdConnect" may have a list of role names
Copy link
Member

Choose a reason for hiding this comment

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

FYI @OpenAPITools/generator-core-team

@wing328 wing328 merged commit a21e681 into OpenAPITools:master Dec 9, 2023
11 checks passed
@wing328 wing328 added this to the 7.2.0 milestone Dec 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wing328 wing328 wing328 left review comments

@welshm welshm welshm approved these changes

Assignees
No one assigned
Labels
Enhancement: Security Server: Java Server: Spring
Projects
None yet
Milestone
7.2.0
Development

Successfully merging this pull request may close these issues.

[REQ][Spring] Enable scopes for all security scheme types
3 participants
@kota65535 @wing328 @welshm