Merge pull request #621 from catenax-ng/chore(controller)#]-remove-sc…

…ope-from-security Remove Scope from PolicyStoreController.java
eclipse-tractusx · Nov 14, 2023 · 8d0f467 · 8d0f467
2 parents 2cdd841 + 895b316
commit 8d0f467
Show file tree

Hide file tree

Showing 6 changed files with 36 additions and 54 deletions.
diff --git a/docs/src/api/irs-api.yaml b/docs/src/api/irs-api.yaml
@@ -7,8 +7,7 @@ info:
 servers:
   - url: http://localhost:8080
 security:
-  - oAuth2:
-      - profile email
+  - oAuth2: []
 paths:
   /ess/bpn/investigations:
     post:
@@ -59,8 +58,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - oAuth2:
-            - profile email
+        - oAuth2: []
       summary: Registers an IRS job to start an investigation if a given bpn is contained
         in a part chain of a given globalAssetId.
       tags:
@@ -125,8 +123,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Job with the requested jobId not found.
       security:
-        - oAuth2:
-            - profile email
+        - oAuth2: []
       summary: Return job with additional supplyChainImpacted information.
       tags:
         - Environmental and Social Standards
@@ -205,8 +202,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - oAuth2:
-            - profile email
+        - oAuth2: []
       summary: "Registers an order for an ESS investigation with an array of {globalAssetIds}. 
       Each globalAssetId will be processed in an separate job, grouped in batches."
       tags:
@@ -296,8 +292,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - oAuth2:
-            - profile email
+        - oAuth2: []
       summary: Returns paginated jobs with state and execution times.
       tags:
         - Item Relationship Service
@@ -348,8 +343,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - oAuth2:
-            - profile email
+        - oAuth2: []
       summary: "Register an IRS job to retrieve an item graph for given {globalAssetId}."
       tags:
         - Item Relationship Service
@@ -433,8 +427,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Job with the requested jobId not found.
       security:
-        - oAuth2:
-            - profile email
+        - oAuth2: []
       summary: Return job with optional item graph result for requested id.
       tags:
         - Item Relationship Service
@@ -499,8 +492,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Job for requested jobId not found.
       security:
-        - oAuth2:
-            - profile email
+        - oAuth2: []
       summary: Cancel job for requested jobId.
       tags:
         - Item Relationship Service
@@ -537,8 +529,7 @@ paths:
                 $ref: "#/components/schemas/ErrorResponse"
           description: Authorization refused by server.
       security:
-        - oAuth2:
-            - profile email
+        - oAuth2: []
       summary: Get all available aspect models from semantic hub or local models.
       tags:
         - Aspect Models
@@ -591,8 +582,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - oAuth2:
-            - profile email
+        - oAuth2: []
       summary: "Registers an IRS order with an array of {globalAssetIds}.\
       \ Each globalAssetId will be processed in an IRS Job, grouped in batches."
       tags:
@@ -659,8 +649,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Batch Order with the requested orderId not found.
       security:
-        - oAuth2:
-            - profile email
+        - oAuth2: []
       summary: Get a batch order for a given orderId.
       tags:
         - Item Relationship Service
@@ -725,8 +714,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Batch Order with the requested orderId not found.
       security:
-        - oAuth2:
-            - profile email
+        - oAuth2: []
       summary: Cancel a batch order for a given orderId.
       tags:
         - Item Relationship Service
@@ -802,8 +790,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Batch with the requested orderId and batchId not found.
       security:
-        - oAuth2:
-            - profile email
+        - oAuth2: []
       summary: Get a batch with a given batchId for a given orderId.
       tags:
         - Item Relationship Service
@@ -839,8 +826,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - oAuth2:
-            - profile email
+        - oAuth2: []
       summary: Lists the registered policies that should be accepted in EDC negotiation.
       tags:
         - Item Relationship Service
@@ -884,8 +870,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - oAuth2:
-            - profile email
+        - oAuth2: []
       summary: Register a policy that should be accepted in EDC negotiation.
       tags:
         - Item Relationship Service
@@ -930,8 +915,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - oAuth2:
-            - profile email
+        - oAuth2: []
       summary: Removes a policy that should no longer be accepted in EDC negotiation.
       tags:
         - Item Relationship Service
@@ -981,8 +965,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
           description: Authorization refused by server.
       security:
-        - oAuth2:
-            - profile email
+        - oAuth2: []
       summary: Updates an existing policy with new validUntil value.
       tags:
         - Item Relationship Service
@@ -2635,6 +2618,6 @@ components:
       flows:
         clientCredentials:
           scopes:
-            profile email: ""
+            {}
           tokenUrl: https://localhost
       type: oauth2
diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/OpenApiConfiguration.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/configuration/OpenApiConfiguration.java
@@ -59,7 +59,7 @@ public class OpenApiConfiguration {
     @Bean
     public OpenAPI customOpenAPI() {
         return new OpenAPI().addServersItem(new Server().url(irsConfiguration.getApiUrl().toString()))
-                            .addSecurityItem(new SecurityRequirement().addList("oAuth2", "profile email"))
+                            .addSecurityItem(new SecurityRequirement().addList("oAuth2"))
                             .info(new Info().title("IRS API")
                                             .version(IrsApplication.API_VERSION)
                                             .description(
@@ -80,8 +80,7 @@ public OpenApiCustomizer customizer(
             components.addSecuritySchemes("oAuth2", new SecurityScheme().type(SecurityScheme.Type.OAUTH2)
                                                                         .flows(new OAuthFlows().clientCredentials(
                                                                                 new OAuthFlow().scopes(
-                                                                                                       new Scopes().addString(
-                                                                                                               "profile email", ""))
+                                                                                                       new Scopes())
                                                                                                .tokenUrl(tokenUri))));
             openApi.getComponents().getSchemas().values().forEach(s -> s.setAdditionalProperties(false));
             new OpenApiExamples().createExamples(components);

diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/BatchController.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/BatchController.java
@@ -84,7 +84,7 @@ public class BatchController {
     @Operation(operationId = "registerOrder",
                summary = "Registers an IRS order with an array of {globalAssetIds}. "
                        + "Each globalAssetId will be processed in an IRS Job, grouped in batches.",
-               security = @SecurityRequirement(name = "oAuth2", scopes = "profile email"),
+               security = @SecurityRequirement(name = "oAuth2"),
                tags = { "Item Relationship Service" },
                description = "Registers an IRS order with an array of {globalAssetIds}. "
                        + "Each globalAssetId will be processed in an IRS Job, grouped in batches.")
@@ -124,7 +124,7 @@ public BatchOrderCreated registerBatchOrder(final @Valid @RequestBody RegisterBa
 
     @Operation(operationId = "registerESSInvestigationOrder",
                summary = "Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches.",
-               security = @SecurityRequirement(name = "oAuth2", scopes = "profile email"),
+               security = @SecurityRequirement(name = "oAuth2"),
                tags = { "Environmental and Social Standards" },
                description = "Registers an order for an ESS investigation with an array of {globalAssetIds}. Each globalAssetId will be processed in an separate job, grouped in batches.")
     @ApiResponses(value = { @ApiResponse(responseCode = "201", description = "Returns orderId of registered Batch order.",
@@ -164,7 +164,7 @@ public BatchOrderCreated registerESSInvestigationOrder(final @Valid @RequestBody
     @Operation(description = "Get a batch order for a given orderId.",
                operationId = "getBatchOrder",
                summary = "Get a batch order for a given orderId.",
-               security = @SecurityRequirement(name = "oAuth2", scopes = "profile email"),
+               security = @SecurityRequirement(name = "oAuth2"),
                tags = { "Item Relationship Service" })
     @ApiResponses(value = { @ApiResponse(responseCode = "200",
                                          description = "Get a batch order for a given orderId.",
@@ -210,7 +210,7 @@ public BatchOrderResponse getBatchOrder(
     @Operation(description = "Get a batch with a given batchId for a given orderId.",
                operationId = "getBatch",
                summary = "Get a batch with a given batchId for a given orderId.",
-               security = @SecurityRequirement(name = "oAuth2", scopes = "profile email"),
+               security = @SecurityRequirement(name = "oAuth2"),
                tags = { "Item Relationship Service" })
     @ApiResponses(value = { @ApiResponse(responseCode = "200",
                                          description = "Get a batch with a given batchId for a given orderId.",
@@ -259,7 +259,7 @@ public BatchResponse getBatch(
     @Operation(description = "Cancel a batch order for a given orderId.",
                operationId = "cancelBatchOrder",
                summary = "Cancel a batch order for a given orderId.",
-               security = @SecurityRequirement(name = "oAuth2", scopes = "profile email"),
+               security = @SecurityRequirement(name = "oAuth2"),
                tags = { "Item Relationship Service" })
     @ApiResponses(value = { @ApiResponse(responseCode = "200",
                                          description = "Cancel a batch order for a given orderId.",

diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/IrsController.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/controllers/IrsController.java
@@ -95,7 +95,7 @@ public class IrsController {
 
     @Operation(operationId = "registerJobForGlobalAssetId",
                summary = "Register an IRS job to retrieve an item graph for given {globalAssetId}.",
-               security = @SecurityRequirement(name = "oAuth2", scopes = "profile email"),
+               security = @SecurityRequirement(name = "oAuth2"),
                tags = { "Item Relationship Service" },
                description = "Register an IRS job to retrieve an item graph for given {globalAssetId}.")
     @ApiResponses(value = { @ApiResponse(responseCode = "201", description = "Returns id of registered job.",
@@ -135,7 +135,7 @@ public JobHandle registerJobForGlobalAssetId(final @Valid @RequestBody RegisterJ
     @Operation(description = "Return job with optional item graph result for requested id.",
                operationId = "getJobForJobId",
                summary = "Return job with optional item graph result for requested id.",
-               security = @SecurityRequirement(name = "oAuth2", scopes = "profile email"),
+               security = @SecurityRequirement(name = "oAuth2"),
                tags = { "Item Relationship Service" })
     @ApiResponses(value = { @ApiResponse(responseCode = "200",
                                          description = "Return job with item graph for the requested id.",
@@ -192,7 +192,7 @@ public Jobs getJobById(
 
     @Operation(description = "Cancel job for requested jobId.", operationId = "cancelJobByJobId",
                summary = "Cancel job for requested jobId.",
-               security = @SecurityRequirement(name = "oAuth2", scopes = "profile email"),
+               security = @SecurityRequirement(name = "oAuth2"),
                tags = { "Item Relationship Service" })
     @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Job with requested jobId canceled.",
                                         content = { @Content(mediaType = APPLICATION_JSON_VALUE,
@@ -238,7 +238,7 @@ public Job cancelJobByJobId(
 
     @Operation(description = "Returns paginated jobs with state and execution times.", operationId = "getJobsByJobStates",
                summary = "Returns paginated jobs with state and execution times.",
-               security = @SecurityRequirement(name = "oAuth2", scopes = "profile email"),
+               security = @SecurityRequirement(name = "oAuth2"),
                tags = { "Item Relationship Service" })
     @ApiResponses(value = { @ApiResponse(responseCode = "200",
                                          description = "Paginated list of jobs with state and execution times for requested job states.",
@@ -281,7 +281,7 @@ public PageResult getJobsByState(
 
     @Operation(operationId = "getAllAspectModels",
                summary = "Get all available aspect models from semantic hub or local models.",
-               security = @SecurityRequirement(name = "oAuth2", scopes = "profile email"), tags = { "Aspect Models" },
+               security = @SecurityRequirement(name = "oAuth2"), tags = { "Aspect Models" },
                description = "Get all available aspect models from semantic hub or local models.")
     @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Returns all available aspect models.",
                                          content = { @Content(mediaType = APPLICATION_JSON_VALUE,

diff --git a/irs-api/src/main/java/org/eclipse/tractusx/irs/ess/controller/EssController.java b/irs-api/src/main/java/org/eclipse/tractusx/irs/ess/controller/EssController.java
@@ -77,7 +77,7 @@ class EssController {
 
     @Operation(operationId = "registerBPNInvestigation",
                summary = "Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.",
-               security = @SecurityRequirement(name = "oAuth2", scopes = "profile email"),
+               security = @SecurityRequirement(name = "oAuth2"),
                tags = { "Environmental and Social Standards" },
                description = "Registers an IRS job to start an investigation if a given bpn is contained in a part chain of a given globalAssetId.")
     @ApiResponses(value = { @ApiResponse(responseCode = "201", description = "Returns id of registered job.",
@@ -116,7 +116,7 @@ public JobHandle registerBPNInvestigation(final @Valid @RequestBody RegisterBpnI
     @Operation(description = "Return job with additional supplyChainImpacted information.",
                operationId = "getBPNInvestigation",
                summary = "Return job with additional supplyChainImpacted information.",
-               security = @SecurityRequirement(name = "oAuth2", scopes = "profile email"),
+               security = @SecurityRequirement(name = "oAuth2"),
                tags = { "Environmental and Social Standards" })
     @ApiResponses(value = { @ApiResponse(responseCode = "200",
                                          description = "Return job with item graph for the requested id.",

diff --git a/...src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java b/...src/main/java/org/eclipse/tractusx/irs/policystore/controllers/PolicyStoreController.java
@@ -74,7 +74,7 @@ public class PolicyStoreController {
 
     @Operation(operationId = "registerAllowedPolicy",
                summary = "Register a policy that should be accepted in EDC negotiation.",
-               security = @SecurityRequirement(name = "oAuth2", scopes = "profile email"),
+               security = @SecurityRequirement(name = "oAuth2"),
                tags = { "Item Relationship Service" },
                description = "Register a policy that should be accepted in EDC negotiation.")
     @ApiResponses(value = { @ApiResponse(responseCode = "201"),
@@ -106,7 +106,7 @@ public void registerAllowedPolicy(final @Valid @RequestBody CreatePolicyRequest
 
     @Operation(operationId = "getAllowedPolicies",
                summary = "Lists the registered policies that should be accepted in EDC negotiation.",
-               security = @SecurityRequirement(name = "oAuth2", scopes = "profile email"),
+               security = @SecurityRequirement(name = "oAuth2"),
                tags = { "Item Relationship Service" },
                description = "Lists the registered policies that should be accepted in EDC negotiation.")
     @ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Returns the policies.",
@@ -135,7 +135,7 @@ public List<Policy> getPolicies() {
 
     @Operation(operationId = "deleteAllowedPolicy",
                summary = "Removes a policy that should no longer be accepted in EDC negotiation.",
-               security = @SecurityRequirement(name = "oAuth2", scopes = "profile email"),
+               security = @SecurityRequirement(name = "oAuth2"),
                tags = { "Item Relationship Service" },
                description = "Removes a policy that should no longer be accepted in EDC negotiation.")
     @ApiResponses(value = { @ApiResponse(responseCode = "200"),
@@ -166,7 +166,7 @@ public void deleteAllowedPolicy(@PathVariable("policyId") final String policyId)
     }
 
     @Operation(operationId = "updateAllowedPolicy", summary = "Updates an existing policy with new validUntil value.",
-               security = @SecurityRequirement(name = "oAuth2", scopes = "profile email"),
+               security = @SecurityRequirement(name = "oAuth2"),
                tags = { "Item Relationship Service" },
                description = "Updates an existing policy with new validUntil value.")
     @ApiResponses(value = { @ApiResponse(responseCode = "200"),