#30 - Move OPA and other configuration options into /sites resource

formkiq · Mar 15, 2024 · 8d54c2e · 8d54c2e
1 parent bfbd108
commit 8d54c2e
Show file tree

Hide file tree

Showing 19 changed files with 117 additions and 115 deletions.
diff --git a/docs/openapi/openapi-iam.yaml b/docs/openapi/openapi-iam.yaml
@@ -258,15 +258,15 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200'
-          /configuration:
+          /sites/{siteId}/configuration:
             get:
               operationId: GetConfiguration
               description: Returns the list of sites that the user has access to
               summary: Get site configuration
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               responses:
                 "200":
                   description: 200 OK
@@ -295,7 +295,7 @@
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               requestBody:
                 required: true
                 content:
@@ -334,15 +334,15 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
-          /configuration/apiKeys:
+          /sites/{siteId}/apiKeys:
             get:
               operationId: GetApiKeys
               description: Returns the list of ApiKeys
               summary: Get API Keys
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               responses:
                 "200":
                   description: 200 OK
@@ -371,7 +371,7 @@
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               requestBody:
                 required: true
                 content:
@@ -400,15 +400,15 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
-          /configuration/apiKeys/{apiKey}:
+          /sites/{siteId}/apiKeys/{apiKey}:
             delete:
               operationId: DeleteApiKey
               description: Adds a new API Key
               summary: Delete API Key
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               - $ref: '#/components/parameters/apiKeyParam'
               responses:
                 "200":
@@ -428,7 +428,7 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
-          /configuration/opa:
+          /sites/opa/accessPolicies:
             get:
               operationId: GetOpaConfigurations
               description: Returns a list of OPA Configuration, can only be requested with ADMIN privileges
@@ -486,7 +486,7 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
-          /configuration/opa/{siteId}:
+          /sites/{siteId}/opa/accessPolicy:
             get:
               operationId: GetOpaConfiguration
               description: Returns OPA Configuration, can only be requested with ADMIN privileges

diff --git a/docs/openapi/openapi-jwt.yaml b/docs/openapi/openapi-jwt.yaml
@@ -258,15 +258,15 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200'
-          /configuration:
+          /sites/{siteId}/configuration:
             get:
               operationId: GetConfiguration
               description: Returns the list of sites that the user has access to
               summary: Get site configuration
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               responses:
                 "200":
                   description: 200 OK
@@ -295,7 +295,7 @@
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               requestBody:
                 required: true
                 content:
@@ -334,15 +334,15 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
-          /configuration/apiKeys:
+          /sites/{siteId}/apiKeys:
             get:
               operationId: GetApiKeys
               description: Returns the list of ApiKeys
               summary: Get API Keys
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               responses:
                 "200":
                   description: 200 OK
@@ -371,7 +371,7 @@
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               requestBody:
                 required: true
                 content:
@@ -400,15 +400,15 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
-          /configuration/apiKeys/{apiKey}:
+          /sites/{siteId}/apiKeys/{apiKey}:
             delete:
               operationId: DeleteApiKey
               description: Adds a new API Key
               summary: Delete API Key
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               - $ref: '#/components/parameters/apiKeyParam'
               responses:
                 "200":
@@ -428,7 +428,7 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
-          /configuration/opa:
+          /sites/opa/accessPolicies:
             get:
               operationId: GetOpaConfigurations
               description: Returns a list of OPA Configuration, can only be requested with ADMIN privileges
@@ -486,7 +486,7 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
-          /configuration/opa/{siteId}:
+          /sites/{siteId}/opa/accessPolicy:
             get:
               operationId: GetOpaConfiguration
               description: Returns OPA Configuration, can only be requested with ADMIN privileges

diff --git a/docs/openapi/openapi-key.yaml b/docs/openapi/openapi-key.yaml
@@ -258,15 +258,15 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200'
-          /configuration:
+          /sites/{siteId}/configuration:
             get:
               operationId: GetConfiguration
               description: Returns the list of sites that the user has access to
               summary: Get site configuration
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               responses:
                 "200":
                   description: 200 OK
@@ -295,7 +295,7 @@
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               requestBody:
                 required: true
                 content:
@@ -334,15 +334,15 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
-          /configuration/apiKeys:
+          /sites/{siteId}/apiKeys:
             get:
               operationId: GetApiKeys
               description: Returns the list of ApiKeys
               summary: Get API Keys
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               responses:
                 "200":
                   description: 200 OK
@@ -371,7 +371,7 @@
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               requestBody:
                 required: true
                 content:
@@ -400,15 +400,15 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
-          /configuration/apiKeys/{apiKey}:
+          /sites/{siteId}/apiKeys/{apiKey}:
             delete:
               operationId: DeleteApiKey
               description: Adds a new API Key
               summary: Delete API Key
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               - $ref: '#/components/parameters/apiKeyParam'
               responses:
                 "200":
@@ -428,7 +428,7 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
-          /configuration/opa:
+          /sites/opa/accessPolicies:
             get:
               operationId: GetOpaConfigurations
               description: Returns a list of OPA Configuration, can only be requested with ADMIN privileges
@@ -486,7 +486,7 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
-          /configuration/opa/{siteId}:
+          /sites/{siteId}/opa/accessPolicy:
             get:
               operationId: GetOpaConfiguration
               description: Returns OPA Configuration, can only be requested with ADMIN privileges

diff --git a/fkq-test-utils/src/main/java/com/formkiq/testutils/aws/AbstractAwsIntegrationTest.java b/fkq-test-utils/src/main/java/com/formkiq/testutils/aws/AbstractAwsIntegrationTest.java
@@ -191,7 +191,7 @@ private static String getApiKey(final ApiClient client, final String siteId) thr
       List<PermissionsEnum> permissions =
           Arrays.asList(PermissionsEnum.READ, PermissionsEnum.DELETE, PermissionsEnum.WRITE);
       AddApiKeyRequest req = new AddApiKeyRequest().name("My Api Key").permissions(permissions);
-      String apiKey = api.addApiKey(req, siteId).getApiKey();
+      String apiKey = api.addApiKey(siteId, req).getApiKey();
 
       apiKeys.put(site, apiKey);
     }

diff --git a/lambda-api-graalvm/src/main/resources/cloudformation/openapi-iam.yaml b/lambda-api-graalvm/src/main/resources/cloudformation/openapi-iam.yaml
@@ -271,15 +271,15 @@ Resources:
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: "#/components/x-amazon-apigateway-integrations/fulltextLambdaApi200"
-          /configuration:
+          /sites/{siteId}/configuration:
             get:
               operationId: GetConfiguration
               description: Returns the list of sites that the user has access to
               summary: Get site configuration
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               responses:
                 '200':
                   description: "200 OK"
@@ -308,7 +308,7 @@ Resources:
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               requestBody:
                 required: true
                 content:
@@ -347,15 +347,15 @@ Resources:
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: "#/components/x-amazon-apigateway-integrations/lambdaApi200"
-          /configuration/apiKeys:
+          /sites/{siteId}/apiKeys:
             get:
               operationId: GetApiKeys
               description: Returns the list of ApiKeys
               summary: Get API Keys
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               responses:
                 '200':
                   description: "200 OK"
@@ -384,7 +384,7 @@ Resources:
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               requestBody:
                 required: true
                 content:
@@ -413,15 +413,15 @@ Resources:
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: "#/components/x-amazon-apigateway-integrations/lambdaApi200"
-          /configuration/apiKeys/{apiKey}:
+          /sites/{siteId}/apiKeys/{apiKey}:
             delete:
               operationId: DeleteApiKey
               description: Adds a new API Key
               summary: Delete API Key
               tags:
               - System Management
               parameters:
-              - $ref: '#/components/parameters/siteIdParam'
+              - $ref: '#/components/parameters/siteIdPathParam'
               - $ref: '#/components/parameters/apiKeyParam'
               responses:
                 '200':
@@ -441,7 +441,7 @@ Resources:
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: "#/components/x-amazon-apigateway-integrations/lambdaApi200"
-          /configuration/opa:
+          /sites/opa/accessPolicies:
             get:
               operationId: GetOpaConfigurations
               description: Returns a list of OPA Configuration, can only be requested with ADMIN privileges
@@ -499,7 +499,7 @@ Resources:
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: "#/components/x-amazon-apigateway-integrations/lambdaApi200"
-          /configuration/opa/{siteId}:
+          /sites/{siteId}/opa/accessPolicy:
             get:
               operationId: GetOpaConfiguration
               description: Returns OPA Configuration, can only be requested with ADMIN privileges