diff --git a/docs/docs/API-docs/opensign.yaml b/docs/docs/API-docs/opensign.yaml index ebeca648d..3aea5b00c 100644 --- a/docs/docs/API-docs/opensign.yaml +++ b/docs/docs/API-docs/opensign.yaml @@ -69,7 +69,7 @@ paths: post: tags: - Contacts - summary: Create contact + summary: Create Contact description: The Create contact API allows you to effortlessly create new contacts that can act as signers for your important documents. operationId: createcontact requestBody: @@ -104,7 +104,7 @@ paths: get: tags: - Contacts - summary: Get contact + summary: Get Contact description: The Get Contact API allows you to retrieve details about a specific contact. operationId: getcontact parameters: @@ -142,7 +142,7 @@ paths: delete: tags: - Contacts - summary: Delete contact + summary: Delete Contact description: "The Delete Contact API allows you to remove a contact from your contactbook. If you no longer need a particular contact's information, this API makes it easy to delete their record." operationId: deletecontact parameters: @@ -181,7 +181,7 @@ paths: get: tags: - Contacts - summary: Get contact list + summary: Get Contact list description: "The Contact List API empowers you to retrieve a list of contacts, providing a comprehensive view of all available contacts in your contactbook." operationId: contactlist parameters: @@ -221,7 +221,7 @@ paths: post: tags: - Documents - summary: Create document + summary: Create Document description: "The Create Document API allows users to generate new documents by providing data with base64 encoded file. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios." operationId: createdocument requestBody: @@ -249,7 +249,7 @@ paths: post: tags: - Documents - summary: Create document with binary file type + summary: Create Document from binary description: "The Create Document API allows users to generate new documents by providing data through `multipart/form-data`. This flexible method allows for the inclusion of various data types, making it suitable for a wide range of document creation scenarios." operationId: createdocumentwithbinary requestBody: @@ -277,7 +277,7 @@ paths: post: tags: - Documents - summary: Create document by template_id + summary: Create Document from Template description: The Create Document API allows you to generate new documents by providing template_id. operationId: createdocumentwithtemplateid parameters: @@ -316,7 +316,7 @@ paths: get: tags: - Documents - summary: Get document by ID + summary: Get Document from ID description: The Get Document API enables you to retrieve details about a specific document. operationId: getdocument parameters: @@ -354,7 +354,7 @@ paths: put: tags: - Documents - summary: Update document by ID + summary: Update Document from ID description: The Update Document API allows users to modify and update the details of a specific document. operationId: updateDocument parameters: @@ -401,7 +401,7 @@ paths: delete: tags: - Documents - summary: Delete document by ID + summary: Delete Document from ID description: The Delete document API allows you to remove specific document from your documents. operationId: deletedocument parameters: @@ -440,7 +440,7 @@ paths: get: tags: - Documents - summary: Get document list by doctype + summary: Get Document list from status description: | ### Document Types: Retrieve a list of documents based on type @@ -521,7 +521,7 @@ paths: post: tags: - Templates - summary: Create template + summary: Create Template description: "The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template." operationId: createtemplate requestBody: @@ -547,7 +547,7 @@ paths: post: tags: - Templates - summary: Create template with binary file + summary: Create Template from binary description: "The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **template_id** that can be used to generate documents based on the specified template and **url** to edit template." operationId: createtemplatewithbinary requestBody: @@ -573,7 +573,7 @@ paths: get: tags: - Templates - summary: Get template by ID + summary: Get Template from ID description: The Get Template API allows you to retrieve details about a specific template. Templates serve as blueprints for creating documents with predefined structures. operationId: getTemplate parameters: @@ -608,7 +608,7 @@ paths: put: tags: - Templates - summary: Update template by ID + summary: Update Template from ID description: The Update Template API enables you to modify and update the details of a specific template. operationId: updateTemplate parameters: @@ -655,7 +655,7 @@ paths: delete: tags: - Templates - summary: Delete template by ID + summary: Delete Template from ID description: The Delete Template API provides you with the ability to remove a specific template from the templates. If a template is no longer needed operationId: deleteTemplate parameters: @@ -691,7 +691,7 @@ paths: get: tags: - Templates - summary: Get template list + summary: Get Template list description: "The Get Template List API allows you to retrieve a list of available templates. This functionality provides an overview of all templates, enabling users to choose from existing templates when creating documents." operationId: gettemplatelist parameters: @@ -979,20 +979,20 @@ components: example: User not found! createcontact_body: required: - - Email - - Name - - Phone + - email + - name + - phone type: object properties: - Name: + name: type: string format: string example: joe bee - Email: + email: type: string format: string example: joebee@example.com - Phone: + phone: type: string format: string example: "1232131321" @@ -1018,23 +1018,23 @@ components: createdocument_body: type: object properties: - File: + file: type: string format: base64 example: base64 encoded pdf - Title: + title: type: string format: string example: sample document - Description: + description: type: string format: string example: sample Description - Note: + note: type: string format: string example: sample Note - Signers: + signers: type: array items: type: string @@ -1057,35 +1057,35 @@ components: file: type: string format: binary - Title: + title: type: string - Description: + description: type: string - Note: + note: type: string - Signers: + signers: type: string format: array createdocumenttemplate_id_Signers: type: object properties: - Role: + role: type: string example: Accoutnant - Email: + email: type: string format: mail example: joe@example.com - Name: + name: type: string example: joe bee - Phone: + phone: type: string example: "123123131" createdocument_template_id_body: type: object properties: - Signers: + signers: type: array items: $ref: '#/components/schemas/createdocumenttemplate_id_Signers' @@ -1109,19 +1109,19 @@ components: document_document_id_body: type: object properties: - Name: + name: type: string format: string example: sample document - Note: + note: type: string format: string example: Please review and sign this document - Description: + description: type: string format: string example: document description - FolderId: + folderId: type: string format: string example: Bjsba2bhoP @@ -1163,23 +1163,23 @@ components: createtemplate_body: type: object properties: - File: + file: type: string format: base64 example: base64 encoded file - Title: + title: type: string format: string example: sample template - Note: + note: type: string format: string example: sample note - Description: + description: type: string format: string example: sample description - Signers: + signers: type: array items: type: string @@ -1198,13 +1198,13 @@ components: file: type: string format: binary - Title: + title: type: string - Description: + description: type: string - Note: + note: type: string - Signers: + signers: type: string format: array inline_response_404_6: @@ -1216,19 +1216,19 @@ components: template_template_id_body: type: object properties: - Name: + name: type: string format: string example: sample template - Note: + note: type: string format: string example: Please review and sign this document - Description: + description: type: string format: string example: template description - FolderId: + folderId: type: string format: string example: xjsba1GaxP @@ -1257,7 +1257,7 @@ components: - Url type: object properties: - Url: + url: type: string format: string example: https://your-webhook-url@example.com