From 98ed833a47cfcc70c3310e8fdf27bb15d1302769 Mon Sep 17 00:00:00 2001 From: rdbsolutions Date: Tue, 4 Apr 2023 14:33:10 +0100 Subject: [PATCH] added phase 2 tagging to jsdoc --- pages/api-doc.js | 2 +- pages/api/auth/[...nextauth].js | 1 + pages/api/email/notify.js | 2 +- pages/api/endpoint/createaccount_api.js | 1 + pages/api/endpoint/createcase_api.js | 1 + pages/api/endpoint/createwatchedcases_api.js | 1 + pages/api/endpoint/deleteawaitingsubmissions_api.js | 1 + pages/api/endpoint/deletemyrepresentations_api.js | 1 + pages/api/endpoint/deletewatchedcases_api.js | 1 + pages/api/endpoint/getappealtypesfornewappeal_api.js | 1 + pages/api/endpoint/getawaitingsubmission_api.js | 1 + pages/api/endpoint/getawaitingsubmissionproxy_api.js | 1 + pages/api/endpoint/getlogin_api.js | 1 + pages/api/endpoint/getmycases_api.js | 1 + pages/api/endpoint/getmyrepresentations_api.js | 1 + pages/api/endpoint/getmyrepresentationsproxy_api.js | 1 + pages/api/endpoint/getpersonalaccount_api.js | 1 + pages/api/endpoint/getportallogin_api.js | 1 + pages/api/endpoint/getportalmoduledetails_api.js | 1 + pages/api/endpoint/getportalmoduledetailsproxy_api.js | 1 + pages/api/endpoint/getrepresentations_api.js | 1 + pages/api/endpoint/getrepresentationsproxy_api.js | 1 + pages/api/endpoint/getwatchedcases_api.js | 3 ++- pages/api/endpoint/getwatchedcasesproxy_api.js | 3 ++- pages/api/endpoint/patchcase_api.js | 1 + pages/api/endpoint/updateaccount_api.js | 1 + pages/api/endpoint/updatecase_api.js | 1 + pages/api/endpoint/updatepassword_api.js | 1 + pages/api/file/getbloblist.js | 1 + styles/sass/welshgov/_application.scss | 5 +++++ 30 files changed, 36 insertions(+), 4 deletions(-) diff --git a/pages/api-doc.js b/pages/api-doc.js index 0649622b..cfd333bc 100644 --- a/pages/api-doc.js +++ b/pages/api-doc.js @@ -5,7 +5,7 @@ import "swagger-ui-react/swagger-ui.css"; const SwaggerUI = dynamic(import("swagger-ui-react"), { ssr: false }); function ApiDoc({ spec }) { - return ; + return ; } let BASE_URL; diff --git a/pages/api/auth/[...nextauth].js b/pages/api/auth/[...nextauth].js index e0648c67..bbb0603c 100644 --- a/pages/api/auth/[...nextauth].js +++ b/pages/api/auth/[...nextauth].js @@ -2,6 +2,7 @@ * @swagger * /api/auth/[...nextauth]: * get: + * summary: Phase 2 * tags: [Login] * description: NextAuth * responses: diff --git a/pages/api/email/notify.js b/pages/api/email/notify.js index 891e90df..a800e5ac 100644 --- a/pages/api/email/notify.js +++ b/pages/api/email/notify.js @@ -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 diff --git a/pages/api/endpoint/createaccount_api.js b/pages/api/endpoint/createaccount_api.js index 79ffa9e2..bf2f4d9d 100644 --- a/pages/api/endpoint/createaccount_api.js +++ b/pages/api/endpoint/createaccount_api.js @@ -3,6 +3,7 @@ * /api/endpoint/createaccount_api: * post: * tags: [Account] + * summary: Phase 2 * description: Create password * responses: * 200: diff --git a/pages/api/endpoint/createcase_api.js b/pages/api/endpoint/createcase_api.js index a6f39795..ae273e9b 100644 --- a/pages/api/endpoint/createcase_api.js +++ b/pages/api/endpoint/createcase_api.js @@ -4,6 +4,7 @@ * post: * tags: [Case] * description: Create case + * summary: Phase 2 * parameters: * - name: body * in: requestbody diff --git a/pages/api/endpoint/createwatchedcases_api.js b/pages/api/endpoint/createwatchedcases_api.js index e49a39f2..6ab10590 100644 --- a/pages/api/endpoint/createwatchedcases_api.js +++ b/pages/api/endpoint/createwatchedcases_api.js @@ -3,6 +3,7 @@ * /api/endpoint/createmywatchedcases_api: * post: * tags: [Portal,Case] + * summary: Phase 2 * description: Create my watched cases * responses: * 200: diff --git a/pages/api/endpoint/deleteawaitingsubmissions_api.js b/pages/api/endpoint/deleteawaitingsubmissions_api.js index 37530ead..5861de9b 100644 --- a/pages/api/endpoint/deleteawaitingsubmissions_api.js +++ b/pages/api/endpoint/deleteawaitingsubmissions_api.js @@ -3,6 +3,7 @@ * /api/endpoint/deleteawaitingsubmissions_api: * delete: * tags: [Case] + * summary: Phase 2 * description: Delete awaiting case submission * responses: * 200: diff --git a/pages/api/endpoint/deletemyrepresentations_api.js b/pages/api/endpoint/deletemyrepresentations_api.js index 7fb5872d..5298da38 100644 --- a/pages/api/endpoint/deletemyrepresentations_api.js +++ b/pages/api/endpoint/deletemyrepresentations_api.js @@ -3,6 +3,7 @@ * /api/endpoint/deleteamyrepresentations_api: * delete: * tags: [Portal,Representations] + * summary: Phase 2 * description: Delete my representations * responses: * 200: diff --git a/pages/api/endpoint/deletewatchedcases_api.js b/pages/api/endpoint/deletewatchedcases_api.js index 73ac01ef..b1b3a714 100644 --- a/pages/api/endpoint/deletewatchedcases_api.js +++ b/pages/api/endpoint/deletewatchedcases_api.js @@ -3,6 +3,7 @@ * /api/endpoint/deleteamywatchedcases_api: * delete: * tags: [Portal,Case] + * summary: Phase 2 * description: Delete my watched cases * responses: * 200: diff --git a/pages/api/endpoint/getappealtypesfornewappeal_api.js b/pages/api/endpoint/getappealtypesfornewappeal_api.js index 3960af97..1b44b1fe 100644 --- a/pages/api/endpoint/getappealtypesfornewappeal_api.js +++ b/pages/api/endpoint/getappealtypesfornewappeal_api.js @@ -3,6 +3,7 @@ * /api/endpoint/getappealtypesfornewappeal_api: * get: * tags: [Misc] + * summary: Phase 2 * description: Get Appeal Types for appeal * responses: * 200: diff --git a/pages/api/endpoint/getawaitingsubmission_api.js b/pages/api/endpoint/getawaitingsubmission_api.js index 69e4209f..69aa9d11 100644 --- a/pages/api/endpoint/getawaitingsubmission_api.js +++ b/pages/api/endpoint/getawaitingsubmission_api.js @@ -3,6 +3,7 @@ * /api/endpoint/getawaitingsubmission_api: * get: * tags: [Case] + * summary: Phase 2 * description: get awaiting case submission * responses: * 200: diff --git a/pages/api/endpoint/getawaitingsubmissionproxy_api.js b/pages/api/endpoint/getawaitingsubmissionproxy_api.js index ed7d5fc0..a4df9310 100644 --- a/pages/api/endpoint/getawaitingsubmissionproxy_api.js +++ b/pages/api/endpoint/getawaitingsubmissionproxy_api.js @@ -3,6 +3,7 @@ * /api/endpoint/getawaitingsubmissionproxy_api: * get: * tags: [Case] + * summary: Phase 2 * description: get awaiting case submission proxy * responses: * 200: diff --git a/pages/api/endpoint/getlogin_api.js b/pages/api/endpoint/getlogin_api.js index bad265c7..4aebd20a 100644 --- a/pages/api/endpoint/getlogin_api.js +++ b/pages/api/endpoint/getlogin_api.js @@ -4,6 +4,7 @@ * get: * tags: [Login] * description: Returns the hello world + * summary: Phase 2 * parameters: * - name: emailaddress * in: query diff --git a/pages/api/endpoint/getmycases_api.js b/pages/api/endpoint/getmycases_api.js index 0e23bf3a..1fea9f57 100644 --- a/pages/api/endpoint/getmycases_api.js +++ b/pages/api/endpoint/getmycases_api.js @@ -4,6 +4,7 @@ * get: * tags: [Portal] * description: Get My Cases + * summary: Phase 2 * parameters: * - name: loggedInUserId * in: query diff --git a/pages/api/endpoint/getmyrepresentations_api.js b/pages/api/endpoint/getmyrepresentations_api.js index 55c60120..cd109195 100644 --- a/pages/api/endpoint/getmyrepresentations_api.js +++ b/pages/api/endpoint/getmyrepresentations_api.js @@ -4,6 +4,7 @@ * get: * tags: [Portal] * description: Get My representations + * summary: Phase 2 * parameters: * - name: loggedInUserId * in: query diff --git a/pages/api/endpoint/getmyrepresentationsproxy_api.js b/pages/api/endpoint/getmyrepresentationsproxy_api.js index f85c7d92..7dfc7d11 100644 --- a/pages/api/endpoint/getmyrepresentationsproxy_api.js +++ b/pages/api/endpoint/getmyrepresentationsproxy_api.js @@ -4,6 +4,7 @@ * get: * tags: [Portal] * description: Get My representations + * summary: Phase 2 * parameters: * - name: loggedInUserId * in: query diff --git a/pages/api/endpoint/getpersonalaccount_api.js b/pages/api/endpoint/getpersonalaccount_api.js index 0584be9d..f4fb7941 100644 --- a/pages/api/endpoint/getpersonalaccount_api.js +++ b/pages/api/endpoint/getpersonalaccount_api.js @@ -4,6 +4,7 @@ * get: * tags: [Account] * description: Get personal account + * summary: Phase 2 * parameters: * - name: contactid * in: query diff --git a/pages/api/endpoint/getportallogin_api.js b/pages/api/endpoint/getportallogin_api.js index 11e3d70c..c9253574 100644 --- a/pages/api/endpoint/getportallogin_api.js +++ b/pages/api/endpoint/getportallogin_api.js @@ -4,6 +4,7 @@ * get: * tags: [Login] * description: Returns portal login + * summary: Phase 2 * parameters: * - name: emailaddress * in: query diff --git a/pages/api/endpoint/getportalmoduledetails_api.js b/pages/api/endpoint/getportalmoduledetails_api.js index 54a16944..f05def83 100644 --- a/pages/api/endpoint/getportalmoduledetails_api.js +++ b/pages/api/endpoint/getportalmoduledetails_api.js @@ -4,6 +4,7 @@ * get: * tags: [Portal] * description: Get portal module details + * summary: Phase 2 * parameters: * - name: appealType * in: query diff --git a/pages/api/endpoint/getportalmoduledetailsproxy_api.js b/pages/api/endpoint/getportalmoduledetailsproxy_api.js index b1ac5547..fe03d5c5 100644 --- a/pages/api/endpoint/getportalmoduledetailsproxy_api.js +++ b/pages/api/endpoint/getportalmoduledetailsproxy_api.js @@ -4,6 +4,7 @@ * get: * tags: [Portal] * description: Get portal module details proxy + * summary: Phase 2 * parameters: * - name: appealType * in: query diff --git a/pages/api/endpoint/getrepresentations_api.js b/pages/api/endpoint/getrepresentations_api.js index 290fb97d..395ec05d 100644 --- a/pages/api/endpoint/getrepresentations_api.js +++ b/pages/api/endpoint/getrepresentations_api.js @@ -4,6 +4,7 @@ * get: * tags: [Case] * description: Get Representations for a Case + * summary: Phase 2 * parameters: * - name: incidentID * in: query diff --git a/pages/api/endpoint/getrepresentationsproxy_api.js b/pages/api/endpoint/getrepresentationsproxy_api.js index 408a6402..0e393eb9 100644 --- a/pages/api/endpoint/getrepresentationsproxy_api.js +++ b/pages/api/endpoint/getrepresentationsproxy_api.js @@ -4,6 +4,7 @@ * get: * tags: [Case] * description: Get Representations for a Case + * summary: Phase 2 * parameters: * - name: incidentID * in: query diff --git a/pages/api/endpoint/getwatchedcases_api.js b/pages/api/endpoint/getwatchedcases_api.js index 5a277835..fa4363f7 100644 --- a/pages/api/endpoint/getwatchedcases_api.js +++ b/pages/api/endpoint/getwatchedcases_api.js @@ -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 diff --git a/pages/api/endpoint/getwatchedcasesproxy_api.js b/pages/api/endpoint/getwatchedcasesproxy_api.js index 347aeda7..1309a7de 100644 --- a/pages/api/endpoint/getwatchedcasesproxy_api.js +++ b/pages/api/endpoint/getwatchedcasesproxy_api.js @@ -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 diff --git a/pages/api/endpoint/patchcase_api.js b/pages/api/endpoint/patchcase_api.js index daed9e26..b27e9adf 100644 --- a/pages/api/endpoint/patchcase_api.js +++ b/pages/api/endpoint/patchcase_api.js @@ -4,6 +4,7 @@ * patch: * tags: [Case] * description: Patch case + * summary: Phase 2 * responses: * 200: * description: Success diff --git a/pages/api/endpoint/updateaccount_api.js b/pages/api/endpoint/updateaccount_api.js index 5a3f6334..a4a65ddb 100644 --- a/pages/api/endpoint/updateaccount_api.js +++ b/pages/api/endpoint/updateaccount_api.js @@ -4,6 +4,7 @@ * patch: * tags: [Account] * description: Update account + * summary: Phase 2 * responses: * 200: * description: Success diff --git a/pages/api/endpoint/updatecase_api.js b/pages/api/endpoint/updatecase_api.js index 3d76c575..63af0b5f 100644 --- a/pages/api/endpoint/updatecase_api.js +++ b/pages/api/endpoint/updatecase_api.js @@ -4,6 +4,7 @@ * patch: * tags: [Case] * description: Update case + * summary: Phase 2 * responses: * 200: * description: Success diff --git a/pages/api/endpoint/updatepassword_api.js b/pages/api/endpoint/updatepassword_api.js index d23ab1b6..71ed5fca 100644 --- a/pages/api/endpoint/updatepassword_api.js +++ b/pages/api/endpoint/updatepassword_api.js @@ -4,6 +4,7 @@ * patch: * tags: [Account] * description: Update password + * summary: Phase 2 * responses: * 200: * description: Success diff --git a/pages/api/file/getbloblist.js b/pages/api/file/getbloblist.js index cc455c1b..392d3a14 100644 --- a/pages/api/file/getbloblist.js +++ b/pages/api/file/getbloblist.js @@ -3,6 +3,7 @@ * /api/file/getbloblist: * get: * tags: [Azure Storage] + * summary: Phase 2 * description: Basic search documents details * parameters: * - name: container diff --git a/styles/sass/welshgov/_application.scss b/styles/sass/welshgov/_application.scss index 819d8736..0b5a70fc 100644 --- a/styles/sass/welshgov/_application.scss +++ b/styles/sass/welshgov/_application.scss @@ -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;