diff --git a/spec/v2/Makefile b/spec/v2/Makefile index ab9bca8..1aa03db 100644 --- a/spec/v2/Makefile +++ b/spec/v2/Makefile @@ -1,12 +1,12 @@ DIAGRAMS := $(patsubst %.mmd,%.svg,$(wildcard diagrams/*.mmd)) OUTDIR := ../upload/v2 -MMDC := ./node_modules/.bin/mmdc +MMDC := mmdc all: index.html clean: rm -f docs/index.html docs/diagrams/*.svg index.html $(DIAGRAMS) - rm -rf node_modules + rm -rf node_modules/ publish: index.html mkdir -p $(OUTDIR)/diagrams @@ -23,6 +23,6 @@ serve: $(DIAGRAMS) bikeshed serve index.bs $(MMDC): - npm install @mermaid-js/mermaid-cli + npm install -g @mermaid-js/mermaid-cli .PHONY: publish clean serve diff --git a/spec/v2/index.bs b/spec/v2/index.bs index 7e00c67..7c01874 100644 --- a/spec/v2/index.bs +++ b/spec/v2/index.bs @@ -1,5 +1,6 @@
Title: Technical Specifications for PCF Data Exchange (Version 2.1.0) +Text Macro: VERSION 2.1.0 Shortname: data-exchange-protocol Level: 1 Status: LD @@ -206,7 +207,7 @@ A ProductFootprint has the following properties:String M - The version of the ProductFootprint data specification with value `2.1.0`. + The version of the ProductFootprint data specification with value [VERSION]
. Advisement: Subsequent revisions will update this value according to [Semantic Versioning 2.0.0](https://semver.org/lang/en/).@@ -836,9 +837,9 @@ See [[!DATA-MODEL-EXTENSIONS]] for technical details and [[!EXTENSIONS-GUIDANCE] Example imaginary Data Model Extension for encoding shipment-related data, encoded in JSON: -```json +@@ -1546,7 +1547,7 @@ A [=host system=] requires a [=data recipient=] to first authenticate before suc 2. otherwise, data recipient using [=AuthHostname=]`/`[=AuthSubpath=]`/auth/token` as the [=AuthEndpoint=] in the next step. 3. data recipient retrieving the [=access token=] from [=AuthEndpoint=] (see [[#api-action-auth-request]]). -Note: The [=authentication flow=] is defined such that a Version 2.1 data recipient can authenticate against host versions irrespective of their support for OpenID-Connect. +Note: The [=authentication flow=] is defined such that a Version [VERSION] data recipient can authenticate against host versions irrespective of their support for OpenID-Connect.{ - "specVersion": "2.0.0", + "specVersion": "[VERSION]", "dataSchema": "https://catalog.carbon-transparency.com/shipment/1.0.0/data-model.json", "data": { "shipmentId": "S1234567890", @@ -848,7 +849,7 @@ Example imaginary Data Model Extension for encoding shipment-related data, encod "transportChainElementId": "ABCDEFGHI" } } -``` +