docs: minor update to definitions, examples and enums (#72)

Signed-off-by: Amar Tumballi <[email protected]>

docs/api/components/build-attributes.js

@@ -4,7 +4,7 @@ const fs = require("fs");
 
 async function buildAttribiutes() {
   let attributes = {};
-  const workSheetsFromBuffer = xlsx.parse(`../../Attributesheet_IGM.xlsx`);
+  const workSheetsFromBuffer = xlsx.parse(`../../Attributesheet_scoring.xlsx`);
   for (let i = 0; i < workSheetsFromBuffer.length; i++) {
     const array = workSheetsFromBuffer[i];
     console.log("array",array)

docs/api/components/enums/index.yaml

@@ -1,21 +1,64 @@
 publish:
+  context: &context
+    location:
+      country:
+        code: 
+          - code: IND
+            description: Represents the country
+            reference: <PR/Issue/Discussion Links md format text>
+    action: 
+      - code: publish
+        description: Provider app indicate the publish intent
+        reference: <PR/Issue/Discussion Links md format text>
   message: &message
     rating:
-      entityType:
+      ratingType:
         - code: Overall
           description: Overall Experience
-          reference: <PR/Issue/Discussion Links md format text
+          reference: <PR/Issue/Discussion Links md format text>
         - code: Delivery
           description: Delivery Experience
-          reference: <PR/Issue/Discussion Links md format text  
+          reference: <PR/Issue/Discussion Links md format text>
 
 revise:
+  context:
+    <<: *context
+    action:
+      - code: revise
+        description: Provider app indicate the revise intent
+        reference: <PR/Issue/Discussion Links md format text>
   message: *message
 
 query:
+  context:
+    <<: *context
+    action: 
+      - code: query
+        description: Provider app indicate the query intent
+        reference: <PR/Issue/Discussion Links md format text>
   message: *message
 
 on_query:
+  context:
+    <<: *context
+    action: 
+      - code: on_query
+        description: Publisher app indicate the on_query intent
+        reference: <PR/Issue/Discussion Links md format text>
   message: *message
-
-
+
+on_publish:
+  context:
+    <<: *context
+    action: 
+      - code: on_publish
+        description: Publisher app indicate the on_publish intent
+        reference: <PR/Issue/Discussion Links md format text>
+
+on_revise:
+  context:
+    <<: *context
+    action: 
+      - code: on_revise
+        description: Publisher app indicate the on_revise intent
+        reference: <PR/Issue/Discussion Links md format text>

docs/api/components/examples/score/index.yaml

@@ -1,37 +1,37 @@
 publish:
   examples:
     - summary: publish
-      description: Publish Rating
+      description: Publish Rating of multiple entities from the provider.
       value:
         $ref: "./publish/publish.yaml"
 on_publish:
    examples:
     - summary: on_publish
-      description: On Publish
+      description: Update the status of rating publish on ledger.
       value:
         $ref: "./on_publish/on_publish.yaml"
 revise:
    examples:
     - summary: revise
-      description: TBD
+      description: Revise the previously published rating.
       value:
         $ref: "./revise/revise.yaml"
 on_revise:
    examples:
     - summary: on_revise
-      description: TBD
+      description: Callback of Revise call to get to know the status of the revise call.
       value:
         $ref: "./on_revise/on_revise.yaml"    
 on_query:
    examples:
     - summary: on_query
-      description: TBD
+      description: Callback of the query, which provides the latest aggregated score of the entity.
       value:
         $ref: "./on_query/on_query.yaml"   
 query:
    examples:
     - summary: query
-      description: TBD
+      description: Initiate the query to get the latest aggregated score of set of entitites.
       value:
         $ref: "./query/query.yaml"    
 

docs/api/components/examples/score/on_publish/on_publish.yaml

@@ -1,20 +1,18 @@
-{
-  "context": {
-    "domain": "ONDC:NTS12",
-    "action": "on_publish",
-    "version": "1.0.0",
-    "provider_id": "All in One - Market Place",
-    "provider_uri": "string",
-    "publisher_id": "bpp_id",
-    "publisher_uri": "bpp_uri",
-    "registry_id": "Confidex - Rating Provider Registry's ID",
-    "transaction_id": "string",
-    "message_id": "string",
-    "timestamp": "2021-06-29T10:52:01.620Z",
-    "ttl": "string",
-    "location": {"code":"IND"}
-  },
-  "message": {
-    "status": true
-  }
-}
+context:
+  domain: "ONDC:NTS12"
+  action: "on_publish"
+  version: "1.0.0"
+  provider_id: "All in One - Market Place"
+  provider_uri: "https://api.example.com/api/rating/v1"
+  publisher_id: "Rating Publisher on Ledger"
+  publisher_uri: "https://api.publisher-example.com/api/rating/v1"
+  registry_id: "Confidex - Rating Provider Registry's ID"
+  transaction_id: "226c67bd-9aa7-4aef-8d62-c69e3a669ce0"
+  message_id: "226c67bd-9aa7-4aef-8d62-c69e3a669c10"
+  timestamp: "2021-06-29T10:52:01.620Z"
+  ttl: "PT30S"
+  location:
+    country:
+      code: "IND"
+message:
+  status: true

docs/api/components/examples/score/on_query/on_query.yaml

@@ -3,19 +3,21 @@ context:
   action: "on_query"
   version: "1.0.0"
   provider_id: "All in One - Market Place"
-  provider_uri: "string"
-  publisher_id: "bpp_id"
-  publisher_uri: "bpp_uri"
+  provider_uri: "https://api.example.com/api/rating/v1"
+  publisher_id: "Rating Publisher on Ledger"
+  publisher_uri: "https://api.publisher-example.com/api/rating/v1"
   registry_id: "Confidex - Rating Provider Registry's ID"
-  transaction_id: "string"
-  message_id: "string"
+  transaction_id: "226c67bd-9aa7-4aef-8d62-c69e3a669ce1"
+  message_id: "226c67bd-9aa7-4aef-8d62-c69e3a669d10"
   timestamp: "2021-06-29T10:52:01.620Z"
-  ttl: "string"
-  location: {"code":"IND"}
+  ttl: "PT30S"
+  location:
+    country:
+      code: "IND"
 message:
   scores:
     - entity_id: "a250a6db99213211f333db7f328085ae277c680d2c7178c4bc65cab9cdab78aa"
-      entityName: "string"
+      entityName: "Gupta Kirana Store"
       score: 3.7
       totalRating: 280
       countOfTxn: 73

docs/api/components/examples/score/on_revise/on_revise.yaml

@@ -3,15 +3,16 @@ context:
   action: "on_revise"
   version: "1.0.0"
   provider_id: "All in One - Market Place"
-  provider_uri: "string"
-  publisher_id: "bpp_id"
-  publisher_uri: "bpp_uri"
+  provider_uri: "https://api.example.com/api/rating/v1"
+  publisher_id: "Rating Publisher on Ledger"
+  publisher_uri: "https://api.publisher-example.com/api/rating/v1"
   registry_id: "Confidex - Rating Provider Registry's ID"
-  transaction_id: "string"
-  message_id: "string"
+  transaction_id: "226c67bd-9aa7-4aef-8d62-c69e3a669ce0"
+  message_id: "226c67bd-9aa7-4aef-8d62-c69e3a669c11"
   timestamp: "2021-06-29T10:52:01.620Z"
-  ttl: "string"
-  location: {"code":"IND"}
+  ttl: "PT30S"
+  location:
+    country:
+      code: "IND"
 message:
   status: true
-

docs/api/components/examples/score/publish/publish.yaml

@@ -3,15 +3,17 @@ context:
   action: "publish"
   version: "1.0.0"
   provider_id: "All in One - Market Place"
-  provider_uri: "string"
-  publisher_id: "bpp_id"
-  publisher_uri: "bpp_uri"
+  provider_uri: "https://api.example.com/api/rating/v1"
+  publisher_id: "Rating Publisher on Ledger"
+  publisher_uri: "https://api.publisher-example.com/api/rating/v1"
   registry_id: "Confidex - Rating Provider Registry's ID"
-  transaction_id: "string"
-  message_id: "string"
+  transaction_id: "226c67bd-9aa7-4aef-8d62-c69e3a669ce0"
+  message_id: "226c67bd-9aa7-4aef-8d62-c69e3a669c10"
   timestamp: "2021-06-29T10:52:01.620Z"
-  ttl: "string"
-  location: { "code":"IND" }
+  ttl: "PT30S"
+  location:
+    country:
+      code: "IND"
 message:
   rating:
     - entity_id: "a250a6db99213211f333db7f328085ae277c680d2c7178c4bc65cab9cdab78aa"

docs/api/components/examples/score/query/query.yaml

@@ -1,17 +1,19 @@
 context:
   domain: "ONDC:NTS12"
-  action: "query"
+  action: "publish"
   version: "1.0.0"
   provider_id: "All in One - Market Place"
-  provider_uri: "string"
-  publisher_id: "bpp_id"
-  publisher_uri: "bpp_uri"
+  provider_uri: "https://api.example.com/api/rating/v1"
+  publisher_id: "Rating Publisher on Ledger"
+  publisher_uri: "https://api.publisher-example.com/api/rating/v1"
   registry_id: "Confidex - Rating Provider Registry's ID"
-  transaction_id: "string"
-  message_id: "string"
+  transaction_id: "226c67bd-9aa7-4aef-8d62-c69e3a669ce1"
+  message_id: "226c67bd-9aa7-4aef-8d62-c69e3a669d10"
   timestamp: "2021-06-29T10:52:01.620Z"
-  ttl: "string"
-  location: {"code":"IND"}
+  ttl: "PT30S"
+  location:
+    country:
+      code: "IND"
 message:
   entity_list:
     - entity_id: "a250a6db99213211f333db7f328085ae277c680d2c7178c4bc65cab9cdab78aa"

docs/api/components/examples/score/revise/revise.yaml

@@ -3,19 +3,20 @@ context:
   action: "revise"
   version: "1.0.0"
   provider_id: "All in One - Market Place"
-  provider_uri: "string"
-  publisher_id: "bpp_id"
-  publisher_uri: "bpp_uri"
+  provider_uri: "https://api.example.com/api/rating/v1"
+  publisher_id: "Rating Publisher on Ledger"
+  publisher_uri: "https://api.publisher-example.com/api/rating/v1"
   registry_id: "Confidex - Rating Provider Registry's ID"
-  transaction_id: "string"
-  message_id: "string"
+  transaction_id: "226c67bd-9aa7-4aef-8d62-c69e3a669ce0"
+  message_id: "226c67bd-9aa7-4aef-8d62-c69e3a669c11"
   timestamp: "2021-06-29T10:52:01.620Z"
-  ttl: "string"
-  location: {"code":"IND"}
-
+  ttl: "PT30S"
+  location:
+    country:
+      code: "IND"
 message:
   rating:
-    - ratingType: "Overall"
+    - entity_id: "a250a6db99213211f333db7f328085ae277c680d2c7178c4bc65cab9cdab78aa"
+      ratingType: "Overall"
       countOfTxn: 80
       totalRating: 280
-  transaction_id: "string"