tweaked API spec

formkiq · Jul 31, 2023 · acac8d6 · acac8d6
1 parent 5ec3caf
commit acac8d6
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 42 deletions.
diff --git a/docs/openapi/openapi-iam.yaml b/docs/openapi/openapi-iam.yaml
@@ -1465,15 +1465,15 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201'
-          /shares/folders/{shareKey}:
+          /shares/folders/{documentId}:
             patch:
               operationId: UpdateFolderShare
               description: Updates a folder share; ONLY available with FormKiQ Enterprise
               tags:
               - Document Shares
               parameters:
               - $ref: '#/components/parameters/siteIdParam'
-              - $ref: '#/components/parameters/shareKey'
+              - $ref: '#/components/parameters/documentIdParam'
               requestBody:
                 required: true
                 content:
@@ -1504,14 +1504,14 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
-          /shares/{shareKey}:
+          /shares/{documentId}:
             delete:
               operationId: DeleteShare
               description: Delete a specific document share; ONLY available with FormKiQ Enterprise
               tags:
               - Document Shares
               parameters:
-              - $ref: '#/components/parameters/shareKey'
+              - $ref: '#/components/parameters/documentIdParam'
               responses:
                 "200":
                   description: 200 OK
@@ -2808,9 +2808,6 @@
                 documentId:
                   type: string
                   description: Document/Folder Identifier
-                shareKey:
-                  type: string
-                  description: Share Key Identifier
                 type:
                   type: string
                   enum:
@@ -2838,6 +2835,11 @@
                 userId:
                   type: string
                   description: User who created share
+                permissionType:
+                  type: string
+                  description: Type of share
+                  enum:
+                  - GROUP
             GetDocumentTagsResponse:
               type: object
               properties:

diff --git a/docs/openapi/openapi-jwt.yaml b/docs/openapi/openapi-jwt.yaml
@@ -1465,15 +1465,15 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201'
-          /shares/folders/{shareKey}:
+          /shares/folders/{documentId}:
             patch:
               operationId: UpdateFolderShare
               description: Updates a folder share; ONLY available with FormKiQ Enterprise
               tags:
               - Document Shares
               parameters:
               - $ref: '#/components/parameters/siteIdParam'
-              - $ref: '#/components/parameters/shareKey'
+              - $ref: '#/components/parameters/documentIdParam'
               requestBody:
                 required: true
                 content:
@@ -1504,14 +1504,14 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
-          /shares/{shareKey}:
+          /shares/{documentId}:
             delete:
               operationId: DeleteShare
               description: Delete a specific document share; ONLY available with FormKiQ Enterprise
               tags:
               - Document Shares
               parameters:
-              - $ref: '#/components/parameters/shareKey'
+              - $ref: '#/components/parameters/documentIdParam'
               responses:
                 "200":
                   description: 200 OK
@@ -2808,9 +2808,6 @@
                 documentId:
                   type: string
                   description: Document/Folder Identifier
-                shareKey:
-                  type: string
-                  description: Share Key Identifier
                 type:
                   type: string
                   enum:
@@ -2838,6 +2835,11 @@
                 userId:
                   type: string
                   description: User who created share
+                permissionType:
+                  type: string
+                  description: Type of share
+                  enum:
+                  - GROUP
             GetDocumentTagsResponse:
               type: object
               properties:

diff --git a/docs/openapi/openapi-key.yaml b/docs/openapi/openapi-key.yaml
@@ -1465,15 +1465,15 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201'
-          /shares/folders/{shareKey}:
+          /shares/folders/{documentId}:
             patch:
               operationId: UpdateFolderShare
               description: Updates a folder share; ONLY available with FormKiQ Enterprise
               tags:
               - Document Shares
               parameters:
               - $ref: '#/components/parameters/siteIdParam'
-              - $ref: '#/components/parameters/shareKey'
+              - $ref: '#/components/parameters/documentIdParam'
               requestBody:
                 required: true
                 content:
@@ -1504,14 +1504,14 @@
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
-          /shares/{shareKey}:
+          /shares/{documentId}:
             delete:
               operationId: DeleteShare
               description: Delete a specific document share; ONLY available with FormKiQ Enterprise
               tags:
               - Document Shares
               parameters:
-              - $ref: '#/components/parameters/shareKey'
+              - $ref: '#/components/parameters/documentIdParam'
               responses:
                 "200":
                   description: 200 OK
@@ -2808,9 +2808,6 @@
                 documentId:
                   type: string
                   description: Document/Folder Identifier
-                shareKey:
-                  type: string
-                  description: Share Key Identifier
                 type:
                   type: string
                   enum:
@@ -2838,6 +2835,11 @@
                 userId:
                   type: string
                   description: User who created share
+                permissionType:
+                  type: string
+                  description: Type of share
+                  enum:
+                  - GROUP
             GetDocumentTagsResponse:
               type: object
               properties:

diff --git a/lambda-api/src/main/resources/cloudformation/api-apikey.yaml b/lambda-api/src/main/resources/cloudformation/api-apikey.yaml
@@ -1467,15 +1467,15 @@ Resources:
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: "#/components/x-amazon-apigateway-integrations/lambdaApi201"
-          /shares/folders/{shareKey}:
+          /shares/folders/{documentId}:
             patch:
               operationId: UpdateFolderShare
               description: Updates a folder share; ONLY available with FormKiQ Enterprise
               tags:
               - Document Shares
               parameters:
               - $ref: '#/components/parameters/siteIdParam'
-              - $ref: '#/components/parameters/shareKey'
+              - $ref: '#/components/parameters/documentIdParam'
               requestBody:
                 required: true
                 content:
@@ -1506,14 +1506,14 @@ Resources:
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: "#/components/x-amazon-apigateway-integrations/lambdaApi200"
-          /shares/{shareKey}:
+          /shares/{documentId}:
             delete:
               operationId: DeleteShare
               description: Delete a specific document share; ONLY available with FormKiQ Enterprise
               tags:
               - Document Shares
               parameters:
-              - $ref: '#/components/parameters/shareKey'
+              - $ref: '#/components/parameters/documentIdParam'
               responses:
                 '200':
                   description: 200 OK
@@ -2810,9 +2810,6 @@ Resources:
                 documentId:
                   type: "string"
                   description: "Document/Folder Identifier"
-                shareKey:
-                  type: "string"
-                  description: "Share Key Identifier"
                 type:
                   type: "string"
                   enum:
@@ -2840,6 +2837,11 @@ Resources:
                 userId:
                   type: "string"
                   description: "User who created share"
+                permissionType:
+                  type: "string"
+                  description: "Type of share"
+                  enum:
+                    - GROUP
             GetDocumentTagsResponse:
               type: "object"
               properties:

diff --git a/lambda-api/src/main/resources/cloudformation/api-iam.yaml b/lambda-api/src/main/resources/cloudformation/api-iam.yaml
@@ -1467,15 +1467,15 @@ Resources:
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: "#/components/x-amazon-apigateway-integrations/lambdaApi201"
-          /shares/folders/{shareKey}:
+          /shares/folders/{documentId}:
             patch:
               operationId: UpdateFolderShare
               description: Updates a folder share; ONLY available with FormKiQ Enterprise
               tags:
               - Document Shares
               parameters:
               - $ref: '#/components/parameters/siteIdParam'
-              - $ref: '#/components/parameters/shareKey'
+              - $ref: '#/components/parameters/documentIdParam'
               requestBody:
                 required: true
                 content:
@@ -1506,14 +1506,14 @@ Resources:
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: "#/components/x-amazon-apigateway-integrations/lambdaApi200"
-          /shares/{shareKey}:
+          /shares/{documentId}:
             delete:
               operationId: DeleteShare
               description: Delete a specific document share; ONLY available with FormKiQ Enterprise
               tags:
               - Document Shares
               parameters:
-              - $ref: '#/components/parameters/shareKey'
+              - $ref: '#/components/parameters/documentIdParam'
               responses:
                 '200':
                   description: 200 OK
@@ -2810,9 +2810,6 @@ Resources:
                 documentId:
                   type: "string"
                   description: "Document/Folder Identifier"
-                shareKey:
-                  type: "string"
-                  description: "Share Key Identifier"
                 type:
                   type: "string"
                   enum:
@@ -2840,6 +2837,11 @@ Resources:
                 userId:
                   type: "string"
                   description: "User who created share"
+                permissionType:
+                  type: "string"
+                  description: "Type of share"
+                  enum:
+                    - GROUP
             GetDocumentTagsResponse:
               type: "object"
               properties:

diff --git a/lambda-api/src/main/resources/cloudformation/api.yaml b/lambda-api/src/main/resources/cloudformation/api.yaml
@@ -1467,15 +1467,15 @@ Resources:
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: "#/components/x-amazon-apigateway-integrations/lambdaApi201"
-          /shares/folders/{shareKey}:
+          /shares/folders/{documentId}:
             patch:
               operationId: UpdateFolderShare
               description: Updates a folder share; ONLY available with FormKiQ Enterprise
               tags:
               - Document Shares
               parameters:
               - $ref: '#/components/parameters/siteIdParam'
-              - $ref: '#/components/parameters/shareKey'
+              - $ref: '#/components/parameters/documentIdParam'
               requestBody:
                 required: true
                 content:
@@ -1506,14 +1506,14 @@ Resources:
               - ApiAuthorization: []
               x-amazon-apigateway-integration:
                 $ref: "#/components/x-amazon-apigateway-integrations/lambdaApi200"
-          /shares/{shareKey}:
+          /shares/{documentId}:
             delete:
               operationId: DeleteShare
               description: Delete a specific document share; ONLY available with FormKiQ Enterprise
               tags:
               - Document Shares
               parameters:
-              - $ref: '#/components/parameters/shareKey'
+              - $ref: '#/components/parameters/documentIdParam'
               responses:
                 '200':
                   description: 200 OK
@@ -2810,9 +2810,6 @@ Resources:
                 documentId:
                   type: "string"
                   description: "Document/Folder Identifier"
-                shareKey:
-                  type: "string"
-                  description: "Share Key Identifier"
                 type:
                   type: "string"
                   enum:
@@ -2840,6 +2837,11 @@ Resources:
                 userId:
                   type: "string"
                   description: "User who created share"
+                permissionType:
+                  type: "string"
+                  description: "Type of share"
+                  enum:
+                    - GROUP
             GetDocumentTagsResponse:
               type: "object"
               properties: