added jsdoc definitions to apis

2023-03-10 12:21:10 +00:00
parent d8f0972170
commit 6dc71b894a
59 changed files with 2288 additions and 64 deletions
@@ -1,3 +1,47 @@
+/**
+ * @swagger
+ * /api/endpoint/getbasicdnssearchpaged_api:
+ *   get:
+ *     tags: [Search]
+ *     description: Basic DNS search paged
+ *     parameters:
+ *       - name: searchString
+ *         in: query
+ *         required: true
+ *         example: farm
+ *         schema:
+ *           type: string
+ *       - name: pageNumber
+ *         in: query
+ *         required: true
+ *         example: 1
+ *         schema:
+ *           type: string
+ *       - name: orderby
+ *         in: query
+ *         required: true
+ *         example: createdon
+ *         schema:
+ *           type: string
+ *       - name: fieldSort
+ *         in: query
+ *         required: true
+ *         description: asc or desc
+ *         example: asc
+ *         schema:
+ *           type: string
+ *       - name: showNumberOfRecords
+ *         in: query
+ *         required: true
+ *         description: number of records to return per page
+ *         example: 10
+ *         schema:
+ *           type: string
+ *     responses:
+ *       200:
+ *         description: Success
+ */
+
 import axios from "axios";
 import CryptoJS from "crypto-js";
 import _ from "lodash";