CCM-12523 - Updates after APIM Review (#205)

* CCM-12523 - Updates after APIM Review

* update md lint rule

* remove all references to 'DESTROYED' status

* Update endpoint statuses and patch returns 202

Author: nhsd-david-wass

docs/assets/diagrams/types.md

@@ -1,4 +1,4 @@
-## Data Store Schemas
+# Data Store Schemas
 
 This document contains the mermaid diagrams for the data store schemas used in the application.
 
@@ -10,7 +10,7 @@ The schemas are generated from Zod definitions and provide a visual representati
 erDiagram
     Letter {
         string id
-        string status "enum: PENDING, ACCEPTED, REJECTED, PRINTED, ENCLOSED, CANCELLED, DISPATCHED, FAILED, RETURNED, DESTROYED, FORWARDED, DELIVERED"
+        string status "enum: PENDING, ACCEPTED, REJECTED, PRINTED, ENCLOSED, CANCELLED, DISPATCHED, FAILED, RETURNED, FORWARDED, DELIVERED"
         string specificationId
         string groupId
         number reasonCode

docs/collections/_consumers/integration.md

@@ -105,7 +105,7 @@ The mandatory statuses are: **ACCEPTED**, **REJECTED**, **FORWARDED**, **DISPATC
 - **CANCELLED:** The letter was cancelled following a request from the NHS Notify team
 
 **Optional statuses** - additional, non-mandatory updates that can provide greater operational insight.
-The optional statuses are: **PRINTED**, **ENCLOSED**, **DELIVERED**, and **DESTROYED**.
+The optional statuses are: **PRINTED**, **ENCLOSED**, and **DELIVERED**.
 These can be used if your internal workflow supports more granular reporting.
 
 - **PRINTED:** The letter has been printed.

internal/datastore/src/types.md

@@ -10,7 +10,7 @@ The schemas are generated from Zod definitions and provide a visual representati
 erDiagram
     Letter {
         string id
-        string status "enum: PENDING, ACCEPTED, REJECTED, PRINTED, ENCLOSED, CANCELLED, DISPATCHED, FAILED, RETURNED, DESTROYED, FORWARDED, DELIVERED"
+        string status "enum: PENDING, ACCEPTED, REJECTED, PRINTED, ENCLOSED, CANCELLED, DISPATCHED, FAILED, RETURNED, FORWARDED, DELIVERED"
         string specificationId
         string groupId
         number reasonCode

internal/datastore/src/types.ts

@@ -15,7 +15,7 @@ export type Supplier = z.infer<typeof SupplierSchema>;
 export const LetterStatus = z.enum([
   'PENDING', 'ACCEPTED', 'REJECTED', 'PRINTED',
   'ENCLOSED', 'CANCELLED', 'DISPATCHED', 'FAILED',
-  'RETURNED', 'DESTROYED', 'FORWARDED', 'DELIVERED']);
+  'RETURNED', 'FORWARDED', 'DELIVERED']);
 
 export type LetterStatusType = z.infer<typeof LetterStatus>;
 

lambdas/api-handler/src/contracts/letters.ts

@@ -21,7 +21,6 @@ export const LetterStatusSchema = z.enum([
   'DISPATCHED',
   'FAILED',
   'RETURNED',
-  'DESTROYED',
   'FORWARDED',
   'DELIVERED'
 ]);

sandbox/HealthcheckEndpoint.json

@@ -8,7 +8,7 @@
           "description": "Service is healthy"
         }
       },
-      "summary": "Health check endpoint"
+      "summary": "Health check"
     }
   }
 }