Sindbad~EG File Manager

Current Path : /home/infinitibizsol/.trash/docs.2/common/
Upload File :
Current File : /home/infinitibizsol/.trash/docs.2/common/notes.js

/**
 * @swagger
 * components:
 *   schemas:
 *     Note:
 *       type: object
 *       required:
 *         - title
 *         - comments
 *         - contact_id
 *         - created_by
 *       properties:
 *         title:
 *           type: string
 *           description: The title of the note
 *         comments:
 *           type: string
 *           description: The comments or body of the note
 *         contact_id:
 *           type: string
 *           description: The ID of the associated contact
 *         created_by:
 *           type: string
 *           description: The ID of the user who created the note
 *       example:
 *         title: "Test1"
 *         comments: "Just Testing1."
 *         contact_id: "66677bf804341e36908f1857"
 *         created_by: "64d5bd3aca0be228afc9e267"
 *     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:
 *   get:
 *     summary: Returns the list of note
 *     tags: [Notes]
 *     security:
 *       - bearerAuth: []
 *     responses:
 *       200:
 *         description: The list of note
 *         content:
 *           application/json:
 *             schema:
 *               type: array
 *               items:
 *                 $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";

Sindbad File Manager Version 1.0, Coded By Sindbad EG ~ The Terrorists