From 722b1d44d986a8e8dde5312b2e2099b8e18555f5 Mon Sep 17 00:00:00 2001 From: Raimundo Henriques Date: Tue, 19 Dec 2023 15:03:57 +0000 Subject: [PATCH 1/3] feat: update Makefile --- spec/v2/Makefile | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/spec/v2/Makefile b/spec/v2/Makefile index ab9bca8..a145da0 100644 --- a/spec/v2/Makefile +++ b/spec/v2/Makefile @@ -1,12 +1,13 @@ DIAGRAMS := $(patsubst %.mmd,%.svg,$(wildcard diagrams/*.mmd)) OUTDIR := ../upload/v2 -MMDC := ./node_modules/.bin/mmdc +MMDC := mmdc +FILES := $(shell ls) 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 +24,8 @@ serve: $(DIAGRAMS) bikeshed serve index.bs $(MMDC): - npm install @mermaid-js/mermaid-cli + npm install -g @mermaid-js/mermaid-cli + +# $(DIAGRAMS): $(MMDC) .PHONY: publish clean serve From aad798ba7fc57b0dd9d576ef2a49868de0aaf368 Mon Sep 17 00:00:00 2001 From: Raimundo Henriques Date: Tue, 19 Dec 2023 17:11:49 +0000 Subject: [PATCH 2/3] feat: use text macro for current version --- spec/v2/index.bs | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/spec/v2/index.bs b/spec/v2/index.bs index 7e00c67..e7a8398 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
+
 {
-  "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"
   }
 }
-```
+

 

 
 
@@ -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.
 
 

   
@@ -1993,7 +1994,7 @@ The PF Update Event is defined as a JSON-encoded CloudEvent event wit
 
 {
   "type": "org.wbcsd.pathfinder.ProductFootprint.Published.v1",
-  "specversion": "1.0",
+  "specversion": "[VERSION]",
   "id": "[=EventId=]",
   "source": "//[=EventHostname=]/[=EventSubpath=]",
   "time": "2022-05-31T17:31:00Z",
@@ -2049,7 +2050,7 @@ The [=PF Request Event=] is defined as a JSON-encoded CloudEvent event with the
 
 {
   "type": "org.wbcsd.pathfinder.ProductFootprintRequest.Created.v1",
-  "specversion": "1.0",
+  "specversion": "[VERSION]",
   "id": "[=EventId=]",
   "source": "//[=EventHostname=]/[=EventSubpath=]",
   "time": "2022-05-31T17:31:00Z",
@@ -2080,7 +2081,7 @@ The [=PF Response Event=] is defined as a JSON-encoded CloudEvent event with the
 
 {
   "type": "org.wbcsd.pathfinder.ProductFootprintRequest.Fulfilled.v1",
-  "specversion": "1.0",
+  "specversion": "[VERSION]",
   "id": "[=EventId=]",
   "source": "//[=EventHostname=]/[=EventSubpath=]",
   "data": {
@@ -2113,7 +2114,7 @@ The [=PF Response Event=] is defined as a JSON-encoded CloudEvent event with the
 
 {
   "type": "org.wbcsd.pathfinder.ProductFootprintRequest.Rejected.v1",
-  "specversion": "1.0",
+  "specversion": "[VERSION]",
   "id": "[=EventId=]",
   "source": "...",
   "data": {
@@ -2237,7 +2238,7 @@ date: Mon, 23 May 2022 19:33:16 GMT
 content-type: application/json
 content-length: 1831
 server: Pathfinder
-link: <https://api.pathfinder.sine.dev/2/footprints?limit=10&offset=10>; rel="next"
+link: <https://api.pathfinder.sine.dev/2/footprints?limit=10&offset=10>; rel="next"
 

 
 Example response body:

From 1c74b4761f936e5ad8bf01facfdec2cf06427c87 Mon Sep 17 00:00:00 2001
From: Raimundo Henriques 
Date: Tue, 19 Dec 2023 17:54:06 +0000
Subject: [PATCH 3/3] fix: unnecessary commands and wrong [VERSION] macro calls

---
 spec/v2/Makefile |  3 ---
 spec/v2/index.bs | 10 +++++-----
 2 files changed, 5 insertions(+), 8 deletions(-)

diff --git a/spec/v2/Makefile b/spec/v2/Makefile
index a145da0..1aa03db 100644
--- a/spec/v2/Makefile
+++ b/spec/v2/Makefile
@@ -1,7 +1,6 @@
 DIAGRAMS := $(patsubst %.mmd,%.svg,$(wildcard diagrams/*.mmd))
 OUTDIR := ../upload/v2
 MMDC := mmdc
-FILES := $(shell ls)
 
 all: index.html
 
@@ -26,6 +25,4 @@ serve: $(DIAGRAMS)
 $(MMDC):
 	npm install -g @mermaid-js/mermaid-cli
 
-# $(DIAGRAMS): $(MMDC)
-
 .PHONY: publish clean serve
diff --git a/spec/v2/index.bs b/spec/v2/index.bs
index e7a8398..7c01874 100644
--- a/spec/v2/index.bs
+++ b/spec/v2/index.bs
@@ -1994,7 +1994,7 @@ The PF Update Event is defined as a JSON-encoded CloudEvent event wit
 
 {
   "type": "org.wbcsd.pathfinder.ProductFootprint.Published.v1",
-  "specversion": "[VERSION]",
+  "specversion": "1.0",
   "id": "[=EventId=]",
   "source": "//[=EventHostname=]/[=EventSubpath=]",
   "time": "2022-05-31T17:31:00Z",
@@ -2050,7 +2050,7 @@ The [=PF Request Event=] is defined as a JSON-encoded CloudEvent event with the
 
 {
   "type": "org.wbcsd.pathfinder.ProductFootprintRequest.Created.v1",
-  "specversion": "[VERSION]",
+  "specversion": "1.0",
   "id": "[=EventId=]",
   "source": "//[=EventHostname=]/[=EventSubpath=]",
   "time": "2022-05-31T17:31:00Z",
@@ -2081,7 +2081,7 @@ The [=PF Response Event=] is defined as a JSON-encoded CloudEvent event with the
 
 {
   "type": "org.wbcsd.pathfinder.ProductFootprintRequest.Fulfilled.v1",
-  "specversion": "[VERSION]",
+  "specversion": "1.0",
   "id": "[=EventId=]",
   "source": "//[=EventHostname=]/[=EventSubpath=]",
   "data": {
@@ -2114,7 +2114,7 @@ The [=PF Response Event=] is defined as a JSON-encoded CloudEvent event with the
 
 {
   "type": "org.wbcsd.pathfinder.ProductFootprintRequest.Rejected.v1",
-  "specversion": "[VERSION]",
+  "specversion": "1.0",
   "id": "[=EventId=]",
   "source": "...",
   "data": {
@@ -2238,7 +2238,7 @@ date: Mon, 23 May 2022 19:33:16 GMT
 content-type: application/json
 content-length: 1831
 server: Pathfinder
-link: <https://api.pathfinder.sine.dev/2/footprints?limit=10&offset=10>; rel="next"
+link: <https://api.pathfinder.sine.dev/2/footprints?limit=10&offset=10>; rel="next"
 

 
 Example response body: