added phase 2 tagging to jsdoc

2023-04-04 14:33:10 +01:00
parent 53914bfe80
commit 98ed833a47
30 changed files with 36 additions and 4 deletions
@@ -5,7 +5,7 @@ import "swagger-ui-react/swagger-ui.css";
 const SwaggerUI = dynamic(import("swagger-ui-react"), { ssr: false });

 function ApiDoc({ spec }) {
-    return <SwaggerUI spec={spec} docExpansion={"none"} />;
+    return <SwaggerUI spec={spec} docExpansion={"list"} />;
 }

 let BASE_URL;
@@ -2,6 +2,7 @@
 * @swagger
 * /api/auth/[...nextauth]:
 *   get:
+ *     summary: Phase 2
 *     tags: [Login]
 *     description: NextAuth
 *     responses:
@@ -4,7 +4,7 @@
 *   post:
 *     tags:
 *      - Email
- *     summary: Email to user
+ *     summary: Email to user, Phase 2
 *     consumes:
 *     - application/json
 *     description: Send email via gov notify
@@ -3,6 +3,7 @@
 * /api/endpoint/createaccount_api:
 *   post:
 *     tags: [Account]
+ *     summary: Phase 2
 *     description: Create password
 *     responses:
 *       200:
@@ -4,6 +4,7 @@
 *   post:
 *     tags: [Case]
 *     description: Create case
+ *     summary: Phase 2
 *     parameters:
 *       - name: body
 *         in: requestbody
@@ -3,6 +3,7 @@
 * /api/endpoint/createmywatchedcases_api:
 *   post:
 *     tags: [Portal,Case]
+ *     summary: Phase 2
 *     description: Create my watched cases
 *     responses:
 *       200:
@@ -3,6 +3,7 @@
 * /api/endpoint/deleteawaitingsubmissions_api:
 *   delete:
 *     tags: [Case]
+ *     summary: Phase 2
 *     description: Delete awaiting case submission
 *     responses:
 *       200:
@@ -3,6 +3,7 @@
 * /api/endpoint/deleteamyrepresentations_api:
 *   delete:
 *     tags: [Portal,Representations]
+ *     summary: Phase 2
 *     description: Delete my representations
 *     responses:
 *       200:
@@ -3,6 +3,7 @@
 * /api/endpoint/deleteamywatchedcases_api:
 *   delete:
 *     tags: [Portal,Case]
+ *     summary: Phase 2
 *     description: Delete my watched cases
 *     responses:
 *       200:
@@ -3,6 +3,7 @@
 * /api/endpoint/getappealtypesfornewappeal_api:
 *   get:
 *     tags: [Misc]
+ *     summary: Phase 2
 *     description: Get Appeal Types for appeal
 *     responses:
 *       200:
@@ -3,6 +3,7 @@
 * /api/endpoint/getawaitingsubmission_api:
 *   get:
 *     tags: [Case]
+ *     summary: Phase 2
 *     description: get awaiting case submission
 *     responses:
 *       200:
@@ -3,6 +3,7 @@
 * /api/endpoint/getawaitingsubmissionproxy_api:
 *   get:
 *     tags: [Case]
+ *     summary: Phase 2
 *     description: get awaiting case submission proxy
 *     responses:
 *       200:
@@ -4,6 +4,7 @@
 *   get:
 *     tags: [Login]
 *     description: Returns the hello world
+ *     summary: Phase 2
 *     parameters:
 *       - name: emailaddress
 *         in: query
@@ -4,6 +4,7 @@
 *   get:
 *     tags: [Portal]
 *     description: Get My Cases
+ *     summary: Phase 2
 *     parameters:
 *       - name: loggedInUserId
 *         in: query
@@ -4,6 +4,7 @@
 *   get:
 *     tags: [Portal]
 *     description: Get My representations
+ *     summary: Phase 2
 *     parameters:
 *       - name: loggedInUserId
 *         in: query
@@ -4,6 +4,7 @@
 *   get:
 *     tags: [Portal]
 *     description: Get My representations
+ *     summary: Phase 2
 *     parameters:
 *       - name: loggedInUserId
 *         in: query
@@ -4,6 +4,7 @@
 *   get:
 *     tags: [Account]
 *     description: Get personal account
+ *     summary: Phase 2
 *     parameters:
 *       - name: contactid
 *         in: query
@@ -4,6 +4,7 @@
 *   get:
 *     tags: [Login]
 *     description: Returns portal login
+ *     summary: Phase 2
 *     parameters:
 *       - name: emailaddress
 *         in: query
@@ -4,6 +4,7 @@
 *   get:
 *     tags: [Portal]
 *     description: Get portal module details
+ *     summary: Phase 2
 *     parameters:
 *       - name: appealType
 *         in: query
@@ -4,6 +4,7 @@
 *   get:
 *     tags: [Portal]
 *     description: Get portal module details proxy
+ *     summary: Phase 2
 *     parameters:
 *       - name: appealType
 *         in: query
@@ -4,6 +4,7 @@
 *   get:
 *     tags: [Case]
 *     description: Get Representations for a Case
+ *     summary: Phase 2
 *     parameters:
 *       - name: incidentID
 *         in: query
@@ -4,6 +4,7 @@
 *   get:
 *     tags: [Case]
 *     description: Get Representations for a Case
+ *     summary: Phase 2
 *     parameters:
 *       - name: incidentID
 *         in: query
@@ -3,7 +3,8 @@
 * /api/endpoint/getwatchedcases_api:
 *   get:
 *     tags: [Portal]
- *     description: Get my watched cases s
+ *     description: Get my watched cases
+ *     summary: Phase 2
 *     parameters:
 *       - name: loggedInUserId
 *         in: query
@@ -3,7 +3,8 @@
 * /api/endpoint/getwatchedcasesproxy_api:
 *   get:
 *     tags: [Portal]
- *     description: Get my watched cases s
+ *     description: Get my watched cases
+ *     summary: Phase 2
 *     parameters:
 *       - name: loggedInUserId
 *         in: query
@@ -4,6 +4,7 @@
 *   patch:
 *     tags: [Case]
 *     description: Patch case
+ *     summary: Phase 2
 *     responses:
 *       200:
 *         description: Success
@@ -4,6 +4,7 @@
 *   patch:
 *     tags: [Account]
 *     description: Update account
+ *     summary: Phase 2
 *     responses:
 *       200:
 *         description: Success
@@ -4,6 +4,7 @@
 *   patch:
 *     tags: [Case]
 *     description: Update case
+ *     summary: Phase 2
 *     responses:
 *       200:
 *         description: Success
@@ -4,6 +4,7 @@
 *   patch:
 *     tags: [Account]
 *     description: Update password
+ *     summary: Phase 2
 *     responses:
 *       200:
 *         description: Success
@@ -3,6 +3,7 @@
 * /api/file/getbloblist:
 *   get:
 *     tags: [Azure Storage]
+ *     summary: Phase 2
 *     description: Basic search documents details
 *     parameters:
 *       - name: container
@@ -1,6 +1,11 @@
@import "leaflet/dist/leaflet.css";
@import "leaflet-defaulticon-compatibility/dist/leaflet-defaulticon-compatibility.css";
+
 // @import "leaflet-defaulticon-compatibility";
+.swagger-ui .opblock-summary-description {
+    text-align: right;
+    padding-right: 5px;
+}

 html {
    scroll-behavior: smooth;