diff --git a/docs/docs/API-docs/opensign.yaml b/docs/docs/API-docs/opensign.yaml index 50d4151dc..8cbb02672 100644 --- a/docs/docs/API-docs/opensign.yaml +++ b/docs/docs/API-docs/opensign.yaml @@ -1063,6 +1063,52 @@ paths: $ref: '#/components/schemas/invalidtoken' security: - x-api-token: [] + delete: + tags: + - Folder + summary: Delete Folder + description: The delete Folder API allows you to delete folder. + operationId: deletefolder + parameters: + - name: folder_id + in: path + description: objectId of folder + required: true + style: simple + explode: false + schema: + type: string + format: string + example: bK1cfd2hpb + responses: + "200": + description: successful operation + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_200_12' + "400": + description: | + - folder is not empty, contains document or folder. + - Something went wrong, please try again later! + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_400_3' + "404": + description: folder not found. + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_404_8' + "405": + description: Invalid API token! + content: + application/json: + schema: + $ref: '#/components/schemas/invalidtoken' + security: + - x-api-token: [] /folderlist: get: tags: @@ -1104,7 +1150,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/inline_response_200_12' + $ref: '#/components/schemas/inline_response_200_13' "400": description: "Something went wrong, please try again later!" content: @@ -1979,6 +2025,26 @@ components: updatedAt: $ref: '#/components/schemas/date' inline_response_200_12: + type: object + properties: + objectId: + type: string + format: string + example: Hks2JpewIp + deletedAt: + $ref: '#/components/schemas/date' + inline_response_400_3: + type: object + oneOf: + - properties: + error: + type: string + example: "folder is not empty, contains document or folder." + - properties: + error: + type: string + example: "Something went wrong, please try again later!" + inline_response_200_13: type: object properties: result: