/
home
/
infinitibizsol
/
insurcrm.infinitibizsol.com
/
docs
/
common
/
File Upload :
llllll
Current File: /home/infinitibizsol/insurcrm.infinitibizsol.com/docs/common/notes.js
/** * @swagger * components: * schemas: * Note: * type: object * required: * - title * - comments * properties: * title: * type: string * description: The title of the note * comments: * type: string * description: The comments or body of the note * create_task: * type: boolean * description: Flag to create a task associated with the note * default: false * add_to_important_notes: * type: boolean * description: Flag to mark the note as important * default: false * contact_id: * type: string * nullable: true * description: The ID of the associated contact * policy_id: * type: string * nullable: true * description: The ID of the associated policy * example: * title: "Test1" * comments: "Just Testing1." * create_task: false * add_to_important_notes: false * contact_id: "66677bf804341e36908f1857" * policy_id: "703dcb2b9e0f4823aabb4a44" * UpdateResponse: * type: object * properties: * message: * type: string * example: "Data updated successfully" * DeleteResponse: * type: object * properties: * message: * type: string * example: "entry_name and related data deleted successfully" * securitySchemes: * bearerAuth: * type: http * scheme: bearer * bearerFormat: JWT */ /** * @swagger * tags: * - name: Notes * description: Operations related to note */ /** * @swagger * /note/list: * post: * summary: Add a new note * tags: [Notes] * security: * - bearerAuth: [] * requestBody: * required: true * content: * application/json: * schema: * type: object * properties: * contact_id: * type: string * policy_id: * type: string * required: * - contact_id * - policy_id * example: * contact_id: "66677bf804341e36908f1857" * policy_id: "703dcb2b9e0f4823aabb4a44" * responses: * 201: * description: Note created successfully * content: * application/json: * schema: * $ref: '#/components/schemas/Note' */ /** * @swagger * /note/add: * post: * summary: Create a new note entry * tags: [Notes] * security: * - bearerAuth: [] * requestBody: * required: true * content: * application/json: * schema: * $ref: '#/components/schemas/Note' * responses: * 201: * description: The note entry was successfully created * content: * application/json: * schema: * $ref: '#/components/schemas/Note' */ /** * @swagger * /note/edit/{id}: * put: * summary: Update the note entry by ID * tags: [Notes] * security: * - bearerAuth: [] * parameters: * - in: path * name: id * schema: * type: string * required: true * description: The ID of the note entry * requestBody: * required: true * content: * application/json: * schema: * $ref: '#/components/schemas/Note' * responses: * 200: * description: The note entry was successfully updated * content: * application/json: * schema: * $ref: '#/components/schemas/UpdateResponse' * 404: * description: Note not found */ /** * @swagger * /note/delete/{id}: * delete: * summary: Delete the note entry by ID * tags: [Notes] * security: * - bearerAuth: [] * parameters: * - in: path * name: id * schema: * type: string * required: true * description: The ID of the note entry * responses: * 200: * description: The note entry was successfully deleted * content: * application/json: * schema: * $ref: '#/components/schemas/DeleteResponse' * 404: * description: Note not found */ "use strict";
Copyright ©2k19 -
Hexid
|
Tex7ure