robbond/pedwfrontend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added phase 2 tagging to jsdoc

Browse Source
This commit is contained in:
robbond
2023-04-04 14:33:10 +01:00
parent 53914bfe80
commit 98ed833a47
30 changed files with 36 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
pages/api-doc.js
+1 -1
View File
@@ -5,7 +5,7 @@ import "swagger-ui-react/swagger-ui.css";
const SwaggerUI = dynamic(import("swagger-ui-react"), { ssr: false }); const SwaggerUI = dynamic(import("swagger-ui-react"), { ssr: false });
function ApiDoc({ spec }) { function ApiDoc({ spec }) {
return <SwaggerUI spec={spec} docExpansion={"none"} />; return <SwaggerUI spec={spec} docExpansion={"list"} />;
} }
let BASE_URL; let BASE_URL;
pages/api/auth/[...nextauth].js
+1
View File
@@ -2,6 +2,7 @@
* @swagger * @swagger
* /api/auth/[...nextauth]: * /api/auth/[...nextauth]:
* get: * get:
* summary: Phase 2
* tags: [Login] * tags: [Login]
* description: NextAuth * description: NextAuth
* responses: * responses:
pages/api/email/notify.js
+1 -1
View File
@@ -4,7 +4,7 @@
* post: * post:
* tags: * tags:
* - Email * - Email
* summary: Email to user * summary: Email to user, Phase 2
* consumes: * consumes:
* - application/json * - application/json
* description: Send email via gov notify * description: Send email via gov notify
pages/api/endpoint/createaccount_api.js
+1
View File
@@ -3,6 +3,7 @@
* /api/endpoint/createaccount_api: * /api/endpoint/createaccount_api:
* post: * post:
* tags: [Account] * tags: [Account]
* summary: Phase 2
* description: Create password * description: Create password
* responses: * responses:
* 200: * 200:
pages/api/endpoint/createcase_api.js
+1
View File
@@ -4,6 +4,7 @@
* post: * post:
* tags: [Case] * tags: [Case]
* description: Create case * description: Create case
* summary: Phase 2
* parameters: * parameters:
* - name: body * - name: body
* in: requestbody * in: requestbody
pages/api/endpoint/createwatchedcases_api.js
+1
View File
@@ -3,6 +3,7 @@
* /api/endpoint/createmywatchedcases_api: * /api/endpoint/createmywatchedcases_api:
* post: * post:
* tags: [Portal,Case] * tags: [Portal,Case]
* summary: Phase 2
* description: Create my watched cases * description: Create my watched cases
* responses: * responses:
* 200: * 200:
pages/api/endpoint/deleteawaitingsubmissions_api.js
+1
View File
@@ -3,6 +3,7 @@
* /api/endpoint/deleteawaitingsubmissions_api: * /api/endpoint/deleteawaitingsubmissions_api:
* delete: * delete:
* tags: [Case] * tags: [Case]
* summary: Phase 2
* description: Delete awaiting case submission * description: Delete awaiting case submission
* responses: * responses:
* 200: * 200:
pages/api/endpoint/deletemyrepresentations_api.js
+1
View File
@@ -3,6 +3,7 @@
* /api/endpoint/deleteamyrepresentations_api: * /api/endpoint/deleteamyrepresentations_api:
* delete: * delete:
* tags: [Portal,Representations] * tags: [Portal,Representations]
* summary: Phase 2
* description: Delete my representations * description: Delete my representations
* responses: * responses:
* 200: * 200:
pages/api/endpoint/deletewatchedcases_api.js
+1
View File
@@ -3,6 +3,7 @@
* /api/endpoint/deleteamywatchedcases_api: * /api/endpoint/deleteamywatchedcases_api:
* delete: * delete:
* tags: [Portal,Case] * tags: [Portal,Case]
* summary: Phase 2
* description: Delete my watched cases * description: Delete my watched cases
* responses: * responses:
* 200: * 200:
pages/api/endpoint/getappealtypesfornewappeal_api.js
+1
View File
@@ -3,6 +3,7 @@
* /api/endpoint/getappealtypesfornewappeal_api: * /api/endpoint/getappealtypesfornewappeal_api:
* get: * get:
* tags: [Misc] * tags: [Misc]
* summary: Phase 2
* description: Get Appeal Types for appeal * description: Get Appeal Types for appeal
* responses: * responses:
* 200: * 200:
pages/api/endpoint/getawaitingsubmission_api.js
+1
View File
@@ -3,6 +3,7 @@
* /api/endpoint/getawaitingsubmission_api: * /api/endpoint/getawaitingsubmission_api:
* get: * get:
* tags: [Case] * tags: [Case]
* summary: Phase 2
* description: get awaiting case submission * description: get awaiting case submission
* responses: * responses:
* 200: * 200:
pages/api/endpoint/getawaitingsubmissionproxy_api.js
+1
View File
@@ -3,6 +3,7 @@
* /api/endpoint/getawaitingsubmissionproxy_api: * /api/endpoint/getawaitingsubmissionproxy_api:
* get: * get:
* tags: [Case] * tags: [Case]
* summary: Phase 2
* description: get awaiting case submission proxy * description: get awaiting case submission proxy
* responses: * responses:
* 200: * 200:
pages/api/endpoint/getlogin_api.js
+1
View File
@@ -4,6 +4,7 @@
* get: * get:
* tags: [Login] * tags: [Login]
* description: Returns the hello world * description: Returns the hello world
* summary: Phase 2
* parameters: * parameters:
* - name: emailaddress * - name: emailaddress
* in: query * in: query
pages/api/endpoint/getmycases_api.js
+1
View File
@@ -4,6 +4,7 @@
* get: * get:
* tags: [Portal] * tags: [Portal]
* description: Get My Cases * description: Get My Cases
* summary: Phase 2
* parameters: * parameters:
* - name: loggedInUserId * - name: loggedInUserId
* in: query * in: query
pages/api/endpoint/getmyrepresentations_api.js
+1
View File
@@ -4,6 +4,7 @@
* get: * get:
* tags: [Portal] * tags: [Portal]
* description: Get My representations * description: Get My representations
* summary: Phase 2
* parameters: * parameters:
* - name: loggedInUserId * - name: loggedInUserId
* in: query * in: query
pages/api/endpoint/getmyrepresentationsproxy_api.js
+1
View File
@@ -4,6 +4,7 @@
* get: * get:
* tags: [Portal] * tags: [Portal]
* description: Get My representations * description: Get My representations
* summary: Phase 2
* parameters: * parameters:
* - name: loggedInUserId * - name: loggedInUserId
* in: query * in: query
pages/api/endpoint/getpersonalaccount_api.js
+1
View File
@@ -4,6 +4,7 @@
* get: * get:
* tags: [Account] * tags: [Account]
* description: Get personal account * description: Get personal account
* summary: Phase 2
* parameters: * parameters:
* - name: contactid * - name: contactid
* in: query * in: query
pages/api/endpoint/getportallogin_api.js
+1
View File
@@ -4,6 +4,7 @@
* get: * get:
* tags: [Login] * tags: [Login]
* description: Returns portal login * description: Returns portal login
* summary: Phase 2
* parameters: * parameters:
* - name: emailaddress * - name: emailaddress
* in: query * in: query
pages/api/endpoint/getportalmoduledetails_api.js
+1
View File
@@ -4,6 +4,7 @@
* get: * get:
* tags: [Portal] * tags: [Portal]
* description: Get portal module details * description: Get portal module details
* summary: Phase 2
* parameters: * parameters:
* - name: appealType * - name: appealType
* in: query * in: query
pages/api/endpoint/getportalmoduledetailsproxy_api.js
+1
View File
@@ -4,6 +4,7 @@
* get: * get:
* tags: [Portal] * tags: [Portal]
* description: Get portal module details proxy * description: Get portal module details proxy
* summary: Phase 2
* parameters: * parameters:
* - name: appealType * - name: appealType
* in: query * in: query
pages/api/endpoint/getrepresentations_api.js
+1
View File
@@ -4,6 +4,7 @@
* get: * get:
* tags: [Case] * tags: [Case]
* description: Get Representations for a Case * description: Get Representations for a Case
* summary: Phase 2
* parameters: * parameters:
* - name: incidentID * - name: incidentID
* in: query * in: query
pages/api/endpoint/getrepresentationsproxy_api.js
+1
View File
@@ -4,6 +4,7 @@
* get: * get:
* tags: [Case] * tags: [Case]
* description: Get Representations for a Case * description: Get Representations for a Case
* summary: Phase 2
* parameters: * parameters:
* - name: incidentID * - name: incidentID
* in: query * in: query
pages/api/endpoint/getwatchedcases_api.js
+2 -1
View File
@@ -3,7 +3,8 @@
* /api/endpoint/getwatchedcases_api: * /api/endpoint/getwatchedcases_api:
* get: * get:
* tags: [Portal] * tags: [Portal]
* description: Get my watched cases s * description: Get my watched cases
* summary: Phase 2
* parameters: * parameters:
* - name: loggedInUserId * - name: loggedInUserId
* in: query * in: query
pages/api/endpoint/getwatchedcasesproxy_api.js
+2 -1
View File
@@ -3,7 +3,8 @@
* /api/endpoint/getwatchedcasesproxy_api: * /api/endpoint/getwatchedcasesproxy_api:
* get: * get:
* tags: [Portal] * tags: [Portal]
* description: Get my watched cases s * description: Get my watched cases
* summary: Phase 2
* parameters: * parameters:
* - name: loggedInUserId * - name: loggedInUserId
* in: query * in: query
pages/api/endpoint/patchcase_api.js
+1
View File
@@ -4,6 +4,7 @@
* patch: * patch:
* tags: [Case] * tags: [Case]
* description: Patch case * description: Patch case
* summary: Phase 2
* responses: * responses:
* 200: * 200:
* description: Success * description: Success
pages/api/endpoint/updateaccount_api.js
+1
View File
@@ -4,6 +4,7 @@
* patch: * patch:
* tags: [Account] * tags: [Account]
* description: Update account * description: Update account
* summary: Phase 2
* responses: * responses:
* 200: * 200:
* description: Success * description: Success
pages/api/endpoint/updatecase_api.js
+1
View File
@@ -4,6 +4,7 @@
* patch: * patch:
* tags: [Case] * tags: [Case]
* description: Update case * description: Update case
* summary: Phase 2
* responses: * responses:
* 200: * 200:
* description: Success * description: Success
pages/api/endpoint/updatepassword_api.js
+1
View File
@@ -4,6 +4,7 @@
* patch: * patch:
* tags: [Account] * tags: [Account]
* description: Update password * description: Update password
* summary: Phase 2
* responses: * responses:
* 200: * 200:
* description: Success * description: Success
pages/api/file/getbloblist.js
+1
View File
@@ -3,6 +3,7 @@
* /api/file/getbloblist: * /api/file/getbloblist:
* get: * get:
* tags: [Azure Storage] * tags: [Azure Storage]
* summary: Phase 2
* description: Basic search documents details * description: Basic search documents details
* parameters: * parameters:
* - name: container * - name: container
styles/sass/welshgov/_application.scss
+5
View File
@@ -1,6 +1,11 @@
@import "leaflet/dist/leaflet.css"; @import "leaflet/dist/leaflet.css";
@import "leaflet-defaulticon-compatibility/dist/leaflet-defaulticon-compatibility.css"; @import "leaflet-defaulticon-compatibility/dist/leaflet-defaulticon-compatibility.css";
// @import "leaflet-defaulticon-compatibility"; // @import "leaflet-defaulticon-compatibility";
.swagger-ui .opblock-summary-description {
text-align: right;
padding-right: 5px;
}
html { html {
scroll-behavior: smooth; scroll-behavior: smooth;