review

Author: JamesW1-NHS

Makefile

@@ -32,11 +32,12 @@ publish: clean
 	cp build/immunisation-fhir-api.json sandbox/
 	cp -r specification sandbox/specification
 
-#Creates a versioned, minified OAS spec in JSON for sending to APIM
+#Creates a minified OAS spec in JSON for sending to APIM
 oas: publish
-	rm -f specification/immunisation-fhir-api.oas.json
-	( cd utilities/scripts && python -m set_version < ../../build/immunisation-fhir-api.json | jq -c > ../../specification/immunisation-fhir-api.oas.json )
-	chmod -w specification/immunisation-fhir-api.oas.json
+	mkdir -p oas
+	rm -f specification/immunisation-fhir-api.json
+	jq -c . build/immunisation-fhir-api.json > oas/immunisation-fhir-api.json
+	chmod -w oas/immunisation-fhir-api.json
 
 #Runs build proxy script
 build-proxy:

README.specification.md

@@ -56,8 +56,6 @@ There are `make` commands that alias some of this functionality:
 - `lint` -- Lints the spec and code
 - `publish` -- Outputs the specification as a **single** JSON file into the `build/` directory
 
-Note: the npm scripts are no longer based on Speccy.
-
 ### Modifying the OAS file
 
 Note that the master OAS file is now the **YAML** version, as it is far easier to maintain than the JSON.
@@ -68,12 +66,9 @@ To review your modifications, use Swagger Editor (https://editor.swagger.io).
 
 Note that this is currently a **manual** process.
 
-After modifying the OAS YAML file, run `make oas` on your local machine. This will output the specification into `specification/immunisation-fhir-api.oas.json`. This is a **minified, versioned** JSON file suitable for sending to APIM
+After modifying the OAS YAML file, run `make oas` on your local machine. This will output the specification into `oas/immunisation-fhir-api.json`. This is a **minified** JSON file suitable for sending to APIM
 for uploading to the pubic website.
 
-Please push the minified JSON file to GitHub to along with the YAML file to keep the two in sync, and so that the JSON file can be
-re-submitted to APIM without re-processing if need be.
-
 ### Testing
 
 Each API and team is unique. We encourage you to use a `test/` folder in the root of the project, and use whatever testing frameworks or apps your team feels comfortable with. It is important that the URL your test points to be configurable. We have included some stubs in the Makefile for running tests.