->/specification

Author: JamesW1-NHS

Makefile

@@ -29,15 +29,15 @@ publish: clean
 	mkdir -p build
 	npm run publish 2> /dev/null
 	cp build/immunisation-fhir-api.json sandbox/
-	cp -r utilities/specification sandbox/specification
+	cp -r specification sandbox/specification
 
 #Runs build proxy script
 build-proxy:
 	utilities/scripts/build_proxy.sh
 
 #Files to loop over in release
 # VED-811: remove everything except for proxy related files as we move to Github Actions for backend deployment
-_dist_include="poetry.toml Makefile build/. utilities/specification sandbox infrastructure/terraform utilities/scripts"
+_dist_include="poetry.toml Makefile build/. specification sandbox infrastructure/terraform utilities/scripts"
 
 #Create /dist/ sub-directory and copy files into directory
 #Ensure full dir structure is preserved for Lambdas

README.specification.md

@@ -4,7 +4,7 @@
 
 This is a specification for the _immunisation-fhir-api_ API.
 
-- `utilities/specification/` This [Open API Specification](https://swagger.io/docs/specification/about/) describes the endpoints, methods and messages exchanged by the API. Use it to generate interactive documentation; the contract between the API and its consumers.
+- `specification/` This [Open API Specification](https://swagger.io/docs/specification/about/) describes the endpoints, methods and messages exchanged by the API. Use it to generate interactive documentation; the contract between the API and its consumers.
 - `sandbox/` This NodeJS application implements a mock implementation of the service. Use it as a back-end service to the interactive documentation to illustrate interactions and concepts. It is not intended to provide an exhaustive/faithful environment suitable for full development and testing.
 - `utilities/scripts/` Utilities helpful to developers of this specification.
 - `infrastructure/proxies/` Live (connecting to another service) and sandbox (using the sandbox container) Apigee API Proxy definitions.
@@ -155,7 +155,7 @@ For more information about building sandbox APIs see the [API Producer Zone conf
 
 Contains useful scripts that are used throughout the project, for example in Makefile and Github workflows
 
-#### `utilities/specification`:
+#### `specification`:
 
 Create an OpenAPI Specification to document your API. For more information about developing specifications see the [API Producer Zone confluence](https://nhsd-confluence.digital.nhs.uk/display/APM/Documenting+your+API).
 

package.json

@@ -3,10 +3,10 @@
   "version": "0.0.1",
   "description": "OAS (Swagger v3) API Definition for Template API",
   "scripts": {
-    "lint": "redocly lint --skip-rule=security-defined utilities/specification/immunisation-fhir-api.yaml",
+    "lint": "redocly lint --skip-rule=security-defined specification/immunisation-fhir-api.yaml",
     "format": "prettier --write .",
     "format-check": "prettier --check .",
-    "publish": "redocly bundle utilities/specification/immunisation-fhir-api.yaml --remove-unused-components --ext json -o build/immunisation-fhir-api.json",
+    "publish": "redocly bundle specification/immunisation-fhir-api.yaml --remove-unused-components --ext json -o build/immunisation-fhir-api.json",
     "check-licenses": "node_modules/.bin/license-checker --failOn GPL --failOn LGPL",
     "prepare": "husky"
   },