Skip to content

Commit

Permalink
added PATCH /shares/folders/{documentId}
Browse files Browse the repository at this point in the history
  • Loading branch information
@mfriesen
mfriesen committed Jul 31, 2023
1 parent 1a245b0 commit af9ad6d
Show file tree
Hide file tree
Showing 6 changed files with 474 additions and 192 deletions.
111 changes: 79 additions & 32 deletions docs/openapi/openapi-iam.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1455,18 +1455,63 @@
application/json:
schema:
$ref: '#/components/schemas/AddFolderShareResponse'
"400":
description: 400 OK
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorsResponse'
security:
- ApiAuthorization: []
x-amazon-apigateway-integration:
$ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201'
/shares/{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/documentIdParam'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFolderShareRequest'
responses:
"200":
description: 200 CREATED
headers:
Access-Control-Allow-Origin:
$ref: '#/components/headers/AccessControlAllowOrigin'
Access-Control-Allow-Methods:
$ref: '#/components/headers/AccessControlAllowMethods'
Access-Control-Allow-Headers:
$ref: '#/components/headers/AccessControlAllowHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFolderShareResponse'
"400":
description: 400 OK
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorsResponse'
security:
- ApiAuthorization: []
x-amazon-apigateway-integration:
$ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
/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
Expand Down Expand Up @@ -3137,56 +3182,58 @@
description: List of child documents
items:
$ref: '#/components/schemas/AddChildDocument'
permissions:
$ref: '#/components/schemas/AddPermissions'
AddFolderShareRequest:
type: object
properties:
permissions:
$ref: '#/components/schemas/AddPermissions'
AddPermissions:
type: object
properties:
groups:
$ref: '#/components/schemas/AddPermission'
AddPermission:
share:
$ref: '#/components/schemas/AddShare'
AddShare:
type: object
properties:
read:
type: array
description: List of Groups with Read permission
items:
type: string
write:
group:
type: string
description: Share with Group
permissions:
type: array
description: List of Groups with Write permission
description: List of share permissions
items:
type: string
delete:
enum:
- READ
- WRITE
- DELETE
UpdateFolderShareRequest:
type: object
properties:
share:
$ref: '#/components/schemas/UpdateShare'
UpdateShare:
type: object
properties:
permissions:
type: array
description: List of Groups with Delete permission
description: List of share permissions
items:
type: string
AddFolderShareResponse:
enum:
- READ
- WRITE
- DELETE
UpdateFolderShareResponse:
type: object
properties:
message:
type: string
description: API Response message
shares:
type: array
description: List of created shares
items:
$ref: '#/components/schemas/AddFolderShare'
AddFolderShare:
AddFolderShareResponse:
type: object
properties:
shareKey:
message:
type: string
description: Share Key Identifier
path:
description: API Response message
documentId:
type: string
description: Path or Name of document
description: Share Identifier
DeleteFolderResponse:
type: object
properties:
Expand Down
111 changes: 79 additions & 32 deletions docs/openapi/openapi-jwt.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1455,18 +1455,63 @@
application/json:
schema:
$ref: '#/components/schemas/AddFolderShareResponse'
"400":
description: 400 OK
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorsResponse'
security:
- ApiAuthorization: []
x-amazon-apigateway-integration:
$ref: '#/components/x-amazon-apigateway-integrations/lambdaApi201'
/shares/{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/documentIdParam'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFolderShareRequest'
responses:
"200":
description: 200 CREATED
headers:
Access-Control-Allow-Origin:
$ref: '#/components/headers/AccessControlAllowOrigin'
Access-Control-Allow-Methods:
$ref: '#/components/headers/AccessControlAllowMethods'
Access-Control-Allow-Headers:
$ref: '#/components/headers/AccessControlAllowHeaders'
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFolderShareResponse'
"400":
description: 400 OK
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorsResponse'
security:
- ApiAuthorization: []
x-amazon-apigateway-integration:
$ref: '#/components/x-amazon-apigateway-integrations/lambdaApi200'
/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
Expand Down Expand Up @@ -3137,56 +3182,58 @@
description: List of child documents
items:
$ref: '#/components/schemas/AddChildDocument'
permissions:
$ref: '#/components/schemas/AddPermissions'
AddFolderShareRequest:
type: object
properties:
permissions:
$ref: '#/components/schemas/AddPermissions'
AddPermissions:
type: object
properties:
groups:
$ref: '#/components/schemas/AddPermission'
AddPermission:
share:
$ref: '#/components/schemas/AddShare'
AddShare:
type: object
properties:
read:
type: array
description: List of Groups with Read permission
items:
type: string
write:
group:
type: string
description: Share with Group
permissions:
type: array
description: List of Groups with Write permission
description: List of share permissions
items:
type: string
delete:
enum:
- READ
- WRITE
- DELETE
UpdateFolderShareRequest:
type: object
properties:
share:
$ref: '#/components/schemas/UpdateShare'
UpdateShare:
type: object
properties:
permissions:
type: array
description: List of Groups with Delete permission
description: List of share permissions
items:
type: string
AddFolderShareResponse:
enum:
- READ
- WRITE
- DELETE
UpdateFolderShareResponse:
type: object
properties:
message:
type: string
description: API Response message
shares:
type: array
description: List of created shares
items:
$ref: '#/components/schemas/AddFolderShare'
AddFolderShare:
AddFolderShareResponse:
type: object
properties:
shareKey:
message:
type: string
description: Share Key Identifier
path:
description: API Response message
documentId:
type: string
description: Path or Name of document
description: Share Identifier
DeleteFolderResponse:
type: object
properties:
Expand Down
Loading

0 comments on commit af9ad6d

Please sign in to comment.