588 lines
19 KiB
JSON
588 lines
19 KiB
JSON
{
|
|
"apiFolder": "pages/api",
|
|
"schemaFolders": [
|
|
"models"
|
|
],
|
|
"definition": {
|
|
"openapi": "3.0.3",
|
|
"info": {
|
|
"title": "PEDW API",
|
|
"version": "1.0"
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"emailBody": {
|
|
"type": "object",
|
|
"properties": {
|
|
"reference": {
|
|
"type": "string",
|
|
"example": "PEDW-COMPLETE"
|
|
},
|
|
"templateId": {
|
|
"type": "string",
|
|
"example": "618e0463-b092-4733-a024-bf8a3bbde808"
|
|
},
|
|
"emailAddress": {
|
|
"type": "string",
|
|
"example": "rob@rdbtech.co.uk"
|
|
},
|
|
"personalisation": {
|
|
"type": "object",
|
|
"example": {
|
|
"caseReference": "CAS-TEST-TEST",
|
|
"emailAddress": "rob@rdbtech.co.uk",
|
|
"linkExpiry": "10 * 60"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"securitySchemes": {
|
|
"pedw_auth": {
|
|
"type": "oauth2",
|
|
"flows": {
|
|
"clientCredentials": {
|
|
"tokenUrl": "https://login.microsoftonline.com/9ac1a5ab-cd58-409e-a1b6-6b10422a68f5/oauth2/v2.0/token",
|
|
"scopes": "https://dev-pedw-ns.servicebus.windows.net/.default"
|
|
}
|
|
}
|
|
},
|
|
"api_key": {
|
|
"type": "apiKey",
|
|
"name": "api_key",
|
|
"in": "header"
|
|
}
|
|
}
|
|
},
|
|
"paths": {
|
|
"/api/auth/[...nextauth]": {
|
|
"get": {
|
|
"tags": [
|
|
"Login"
|
|
],
|
|
"description": "NextAuth",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/documents/download/{id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Documents"
|
|
],
|
|
"description": "Get document",
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"description": "iShare ID",
|
|
"type": "string",
|
|
"required": true,
|
|
"default": "A41567436"
|
|
},
|
|
{
|
|
"name": "hash",
|
|
"in": "query",
|
|
"description": "Hash string",
|
|
"default": "e0a1c9cd2817826a25bca67e60b807eae747cbed769e3ec42cf997541c32be71"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/email/notify": {
|
|
"post": {
|
|
"tags": [
|
|
"Email"
|
|
],
|
|
"summary": "Email to user",
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"description": "Send email via gov notify",
|
|
"produces": [
|
|
"application/json",
|
|
"application/xml"
|
|
],
|
|
"requestBody": {
|
|
"name": "Email",
|
|
"description": "Email body",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/emailBody"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"405": {
|
|
"description": "Failed"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/createaccount_api": {
|
|
"post": {
|
|
"tags": [
|
|
"Account"
|
|
],
|
|
"description": "Create password",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/createcase_api": {
|
|
"post": {
|
|
"tags": [
|
|
"Case"
|
|
],
|
|
"description": "Create case",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/createmywatchedcases_api": {
|
|
"post": {
|
|
"tags": [
|
|
"Portal",
|
|
"Case"
|
|
],
|
|
"description": "Create my watched cases",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/deleteawaitingsubmissions_api": {
|
|
"delete": {
|
|
"tags": [
|
|
"Case"
|
|
],
|
|
"description": "Delete awaiting case submission",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/deleteamyrepresentations_api": {
|
|
"delete": {
|
|
"tags": [
|
|
"Portal",
|
|
"Representations"
|
|
],
|
|
"description": "Delete my representations",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/deleteamywatchedcases_api": {
|
|
"delete": {
|
|
"tags": [
|
|
"Portal",
|
|
"Case"
|
|
],
|
|
"description": "Delete my watched cases",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getadvancedsearch_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Search"
|
|
],
|
|
"description": "Advanced search",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getadvancedsearchpaged_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Search"
|
|
],
|
|
"description": "Advanced search paged",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getappealid_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Misc"
|
|
],
|
|
"description": "Get Appeal ID",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getappealtypes_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Misc"
|
|
],
|
|
"description": "Get Appeal Types",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getappealtypesfornewappeal_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Misc"
|
|
],
|
|
"description": "Get Appeal Types for appeal",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getawaitingsubmission_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Case"
|
|
],
|
|
"description": "get awaiting case submission",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getawaitingsubmissionproxy_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Case"
|
|
],
|
|
"description": "get awaiting case submission proxy",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getbasicdnssearch_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Search"
|
|
],
|
|
"description": "Basic DNS search",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getbasicdnssearchdetails_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Search"
|
|
],
|
|
"description": "Basic DNS search details",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getbasicdnssearchdetailspaged_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Search"
|
|
],
|
|
"description": "Basic DNS search details paged",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getbasicdnssearchpaged_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Search"
|
|
],
|
|
"description": "Basic DNS search paged",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getbasicdnsurlsearch_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Search"
|
|
],
|
|
"description": "Basic DNS search URL",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getbasicsearch_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Search"
|
|
],
|
|
"description": "Basic search",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getbasicsearchdetails_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Search"
|
|
],
|
|
"description": "Basic search details",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getbasicsearchdetailspaged_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Search"
|
|
],
|
|
"description": "Basic search details paged",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getbasicsearchpaged_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Search"
|
|
],
|
|
"description": "Basic search paged",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getcase_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Case"
|
|
],
|
|
"summary": "Not used",
|
|
"description": "Get case",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getlogin_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Login"
|
|
],
|
|
"description": "Returns the hello world",
|
|
"responses": {
|
|
"200": {
|
|
"description": "hello world"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getlpa_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Search"
|
|
],
|
|
"description": "Get list of LPA's",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"relay_auth": []
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"/api/endpoint/getsearchdocumentdetails_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Search",
|
|
"Documents"
|
|
],
|
|
"description": "Basic search documents details",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getsearchdocumentdetailspaged_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Search"
|
|
],
|
|
"description": "Basic search documents details paged",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getsearchdocumenthistory_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Search"
|
|
],
|
|
"description": "Basic search documents history",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getsearchdocumenthistorypaged_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Search"
|
|
],
|
|
"description": "Basic search documents history paged",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/getsearchdocumentTypes_api": {
|
|
"get": {
|
|
"tags": [
|
|
"Search"
|
|
],
|
|
"description": "Basic search documents history paged",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/patchcase_api": {
|
|
"patch": {
|
|
"tags": [
|
|
"Case"
|
|
],
|
|
"description": "Patch case",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/updateaccount_api": {
|
|
"patch": {
|
|
"tags": [
|
|
"Account"
|
|
],
|
|
"description": "Update account",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/updatecase_api": {
|
|
"patch": {
|
|
"tags": [
|
|
"Case"
|
|
],
|
|
"description": "Update case",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/endpoint/updatepassword_api": {
|
|
"patch": {
|
|
"tags": [
|
|
"Account"
|
|
],
|
|
"description": "Update password",
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"tags": []
|
|
}
|
|
} |