chore: added error UI & protocol feedback

ONDC-Official · Dec 3, 2024 · 3aabbb7 · 3aabbb7
1 parent af96a80
commit 3aabbb7
Show file tree

Hide file tree

Showing 35 changed files with 1,655 additions and 1,784 deletions.
diff --git a/api/build/build.yaml b/api/build/build.yaml
diff --git a/api/components/Examples/Services.yaml b/api/components/Examples/Services.yaml
@@ -1,12 +1,27 @@
 ONDC:ONEST10 - Work Opportunities:
   summary: ONDC:ONEST10 - Work Opportunities
-  description: >-
-   Job Hub is acting as provider platform(BPP) which hosts the jobs and Worker Hub is acting as seeker platform(BAP) which helps the workers to find jobs.
+  description: >
+    Job Hub is acting as provider platform (BPP) which hosts the jobs and Worker Hub is acting as seeker platform (BAP) which helps the workers to find jobs.
+    <br/><br/>
+        This document contains detailed specifications and requirements for the job platform, helping stakeholders understand the product in depth
+    (PRD): <a href="https://docs.google.com/document/d/1VydDAqtzjj1jDrJzX4hwZSlYyJsA_bSOJIKYTWxNSpQ">link</a>
+    <br/><br/>
+    his document provides an overview of the business requirements, with clear explanations about platform functionalities and workflows (Explainer & BRD is documented): <a href="https://docs.google.com/document/d/1cuvt_w9qSv7XpLXpY4KCq5gmrsQSqF8e3VLxOhpfO0g">link</a>
+    <br/><br/>
+    A detailed taxonomy of product categories and attributes is provided to ensure clarity and standardization across the platform (Product Taxonomy): <a href="https://docs.google.com/spreadsheets/d/1Go22ou013hE-fxpjMd_XuM111l8x8TuMsF_nsjvB3so">link</a>
   example_set:
     $ref: "./Services_Work_Opportunities_yaml/index.yaml"
+
 ONDC:ONEST10 - Work Opportunities(Commercials):
   summary: ONDC:ONEST10 - Work Opportunities(Commercials)
   description: >-
-   Job Hub is acting as provider platform(BPP) which hosts the jobs and Worker Hub is acting as seeker platform(BAP) which helps the workers to find jobs.
+    Job Hub is acting as provider platform (BPP) which hosts the jobs and Worker Hub is acting as seeker platform (BAP) which helps the workers to find jobs.
+    <br/><br/>
+        This document contains detailed specifications and requirements for the job platform, helping stakeholders understand the product in depth
+    (PRD): <a href="https://docs.google.com/document/d/1VydDAqtzjj1jDrJzX4hwZSlYyJsA_bSOJIKYTWxNSpQ">link</a>
+    <br/><br/>
+    his document provides an overview of the business requirements, with clear explanations about platform functionalities and workflows (Explainer & BRD is documented): <a href="https://docs.google.com/document/d/1cuvt_w9qSv7XpLXpY4KCq5gmrsQSqF8e3VLxOhpfO0g">link</a>
+    <br/><br/>
+    A detailed taxonomy of product categories and attributes is provided to ensure clarity and standardization across the platform (Product Taxonomy): <a href="https://docs.google.com/spreadsheets/d/1Go22ou013hE-fxpjMd_XuM111l8x8TuMsF_nsjvB3so">link</a>
   example_set:
-    $ref: "./Services_Work_Opportunities_yaml/index.yaml"
+    $ref: "./Services_Work_Opportunities_yaml/index.yaml"
diff --git a/api/components/Examples/Services_Work_Opportunities_yaml/confirm/confirm.yaml b/api/components/Examples/Services_Work_Opportunities_yaml/confirm/confirm.yaml
@@ -14,7 +14,7 @@ value:
         code: std:080
       country:
         code: IND
-    timestamp: "2023-02-23T08:09:02Z"
+    timestamp: "2023-02-23T08:09:021Z"
     ttl: PT30S
   message:
     order:
@@ -25,6 +25,12 @@ value:
         - id: 0253719F295521CED39EC9C2F3C8DCDE
           fulfillment_ids:
             - "1"
+          tags:
+          - descriptor:
+              code: NP_FEES
+            list:
+              - code: ID
+                value: "1"
       fulfillments:
         - id: "1"
           customer:
@@ -46,27 +52,27 @@ value:
                   name: Hindi
               tags:
                 - descriptor:
-                    code: CURRENT-EXPERIENCE
+                    code: CURRENT_EXPERIENCE
                     name: Current Experience
                   list:
                     - descriptor:
-                        code: EXP-YEARS
+                        code: EXP_YEARS
                         name: Experience
                       value: P4Y2M
                     - descriptor:
-                        code: CURRENT-COMPANY
+                        code: CURRENT_COMPANY
                         name: Current Company
                       value: ABC tech
                 - descriptor:
-                    code: SALARY-DETAILS
+                    code: SALARY_DETAILS
                     name: Salary Details
                   list:
                     - descriptor:
-                        code: EXPECTED-SALARY
+                        code: EXPECTED_SALARY
                         name: Expected Salary
                       value: "80000"
                     - descriptor:
-                        code: CURRENT-SALARY
+                        code: CURRENT_SALARY
                         name: Current Salary
                       value: "50000"
                 - descriptor:
@@ -82,31 +88,31 @@ value:
               email: abc@abc.bc
           tags:
             - descriptor:
-                code: DISTRIBUTOR-DETAILS
+                code: DISTRIBUTOR_DETAILS
                 name: Distributor Details
               list:
                 - descriptor:
-                    code: DISTRIBUTOR-ID
+                    code: DISTRIBUTOR_ID
                     name: Distributor Id
                   value: PNB
                 - descriptor:
-                    code: DISTRIBUTOR-NAME
+                    code: DISTRIBUTOR_NAME
                     name: Distributor Name
                   value: Pay Near By
                 - descriptor:
-                    code: DISTRIBUTOR-PHONE
+                    code: DISTRIBUTOR_PHONE
                     name: Distributor Phone
                   value: "9123456789"
                 - descriptor:
-                    code: DISTRIBUTOR-EMAIL
+                    code: DISTRIBUTOR_EMAIL
                     name: Distributor Email
                   value: support@pnb.com
                 - descriptor:
-                    code: AGENT-ID
+                    code: AGENT_ID
                     name: Agent Id
                   value: agent-123
                 - descriptor:
-                    code: AGENT-VERIFIED
+                    code: AGENT_VERIFIED
                     name: Agent Verified
                   value: "true"
       quote:
@@ -140,9 +146,8 @@ value:
                     value: item
               - descriptor:
                   code: NP_FEES
-                  name: np_fees
                 list:
-                  - code: id
+                  - code: ID
                     value: "1"
                   - code: COMMERCIAL_TYPE
                     value: percent
@@ -151,7 +156,7 @@ value:
                   - code: COMMERCIAL_NAME
                     value: qualified
                   - code: COMMERCIAL_TRIGGERING_STATE
-                    value: OFFER-EXTENDED
+                    value: OFFER_EXTENDED
               - descriptor:
                   code: TYPE
                 list:

diff --git a/api/components/Examples/Services_Work_Opportunities_yaml/init/init.yaml b/api/components/Examples/Services_Work_Opportunities_yaml/init/init.yaml
@@ -14,7 +14,7 @@ value:
         code: std:080
       country:
         code: IND
-    timestamp: "2023-02-14T12:12:46Z"
+    timestamp: "2023-02-14T12:12:461Z"
     ttl: PT30S
   message:
     order:
@@ -24,6 +24,12 @@ value:
         - id: 0253719F295521CED39EC9C2F3C8DCDE
           fulfillment_ids:
             - "1"
+          tags:
+          - descriptor:
+              code: NP_FEES
+            list:
+              - code: ID
+                value: "1"
       fulfillments:
         - id: "1"
           customer:
@@ -45,40 +51,42 @@ value:
                   name: Hindi
               tags:
                 - descriptor:
-                    code: emp-details
+                    code: EMP_DETAILS
                     name: Employee Details
                   list:
                     - descriptor:
-                        code: expected-salary
+                        code: EXPECTED_SALARY
                       value: "1000000"
                     - descriptor:
-                        code: total-experience
-                      value: "4"
+                        code: TOTAL_EXPERIENCE
+                        name: Total Experience
+                      value: "P4Y"
                 - descriptor:
                     code: documents
                     name: Documents
                   list:
                     - descriptor:
-                        code: doc-type
+                        code: DOC_TYPE
                       value: resume
                     - descriptor:
                         code: link
                       value: https://example.com/resume.pdf
                     - descriptor:
-                        code: file-format
+                        code: FILE_FORMAT
                       value: pdf
                 - descriptor:
                     code: NP_FEES
-                    name: np_fees
                   list:
+                    - code: ID
+                      value: "1"
                     - code: COMMERCIAL_TYPE
                       value: percent
                     - code: COMMERCIAL_VALUE
                       value: "0.2"
                     - code: COMMERCIAL_NAME
                       value: qualified
                     - code: COMMERCIAL_TRIGGERING_STATE
-                      value: OFFER-EXTENDED
+                      value: OFFER_EXTENDED
           contact:
             phone: "9999999999"
             email: abc@abc.bc
@@ -113,9 +121,8 @@ value:
                     value: item
               - descriptor:
                   code: NP_FEES
-                  name: np_fees
                 list:
-                  - code: id
+                  - code: ID
                     value: "1"
                   - code: COMMERCIAL_TYPE
                     value: percent
@@ -124,7 +131,7 @@ value:
                   - code: COMMERCIAL_NAME
                     value: qualified
                   - code: COMMERCIAL_TRIGGERING_STATE
-                    value: OFFER-EXTENDED
+                    value: OFFER_EXTENDED
               - descriptor:
                   code: TYPE
                 list:

diff --git a/api/components/Examples/Services_Work_Opportunities_yaml/on_cancel/on_cancel.yaml b/api/components/Examples/Services_Work_Opportunities_yaml/on_cancel/on_cancel.yaml
@@ -25,14 +25,6 @@ value:
           id: '1'
           descriptor:
             name: Affinidi
-          locations:
-            - id: L1
-              city:
-                name: Pune
-                code: std:020
-              state:
-                name: Maharastra
-                code: MH
         items:
           - id: 0253719F295521CED39EC9C2F3C8DCDE
             fulfillment_ids:
@@ -44,17 +36,22 @@ value:
                 end: '2023-02-03T13:23:01+00:00'
             tags:
               - descriptor:
-                  code: CANCEL REQUEST
+                  code: NP_FEES
+                  list:
+                    - code: ID
+                      value: "1"
+              - descriptor:
+                  code: CANCEL_REQUEST
                   name: Cancel request
                 list:
                   - descriptor:
-                      code: REASON-ID
+                      code: REASON_ID
                       name: Reason id
                     value: '001'
                   - descriptor:
-                      code: INITIATED BY
+                      code: INITIATED_BY
                       name: Initiated by
-                    value: Buyer
+                    value: Subscriber ID
         quote:
           price:
             currency: INR
@@ -97,7 +94,7 @@ value:
                     - code: COMMERCIAL_NAME
                       value: qualified
                     - code: COMMERCIAL_TRIGGERING_STATE
-                      value: OFFER-EXTENDED
+                      value: OFFER_EXTENDED
                 - descriptor:
                     code: TYPE
                   list:
@@ -130,27 +127,27 @@ value:
                     name: Hindi
                 tags:
                   - descriptor:
-                      code: CURRENT-EXPERIENCE
+                      code: CURRENT_EXPERIENCE
                       name: Current Experience
                     list:
                       - descriptor:
-                          code: EXP-YEARS
+                          code: EXP_YEARS
                           name: Experience
                         value: P4Y2M
                       - descriptor:
-                          code: CURRENT-COMPANY
+                          code: CURRENT_COMPANY
                           name: Current Company
                         value: ABC tech
                   - descriptor:
-                      code: SALARY-DETAILS
+                      code: SALARY_DETAILS
                       name: Salary Details
                     list:
                       - descriptor:
-                          code: EXPECTED-SALARY
+                          code: EXPECTED_SALARY
                           name: Expected Salary
                         value: '80000'
                       - descriptor:
-                          code: CURRENT-SALARY
+                          code: CURRENT_SALARY
                           name: Current Salary
                         value: '50000'
                   - descriptor:
@@ -166,31 +163,31 @@ value:
                 email: abc@abc.bc
             tags:
               - descriptor:
-                  code: DISTRIBUTOR-DETAILS
+                  code: DISTRIBUTOR_DETAILS
                   name: Distributor Details
                 list:
                   - descriptor:
-                      code: DISTRIBUTOR-ID
+                      code: DISTRIBUTOR_ID
                       name: Distributor Id
                     value: PNB
                   - descriptor:
-                      code: DISTRIBUTOR-NAME
+                      code: DISTRIBUTOR_NAME
                       name: Distributor Name
                     value: Pay Near By
                   - descriptor:
-                      code: DISTRIBUTOR-PHONE
+                      code: DISTRIBUTOR_PHONE
                       name: Distributor Phone
                     value: '9123456789'
                   - descriptor:
-                      code: DISTRIBUTOR-EMAIL
+                      code: DISTRIBUTOR_EMAIL
                       name: Distributor Email
                     value: support@pnb.com
                   - descriptor:
-                      code: AGENT-ID
+                      code: AGENT_ID
                       name: Agent Id
                     value: agent-123
                   - descriptor:
-                      code: AGENT-VERIFIED
+                      code: AGENT_VERIFIED
                       name: Agent Verified
                     value: 'true'
           - id: C1