Merge pull request #341 from beckn/release-1.x

Merging Core Version 1.0 release branch

CHANGELOG.md

@@ -1,5 +1,91 @@
 # Changelog
 
+## Core v1.0 - 31st December 2022
+###  API Changes
+
+| API Endpoint | 0.9.3 | 1.0 |
+|---------|-------|-------|
+| rating | Sends a single rating | Allows multiple ratings to be sent  |
+| support| Returns a ref_id | Returns a **Support** object |
+| on_select| Returns a few fields from **Order** object | Returns the complete **Order** object | 
+| on_init | Returns a few fields from **Order** object | Returns the complete **Order** object  |
+| on_rating | Returned **RatingAck** object | Returns an **XInput** object |
+| on_support | Returned phone, email and url | Returns a **Support** object |
+
+
+### Schema Changes
+
+| Schema | Added  | Removed | Modified |
+|--------|--------|---------|----------|
+| Ack| tags| - | - | - |
+| Address| - | all named fields | Changed to string ,  entities enclosing Address have address as string and also have named city , state , area_code fields pointing to corresponding object types.|
+| Agent| person , contact , organization , rating|all attributes that originally existed|
+| Billing | state , city , *country*  ,  *area_code*  | created_at ,  updated_at | address | 
+| Cancellation|reason , addtional_description|type , ref_id , policies , reasons , selected_reason|
+| Catalog| ttl | - | Removed "bpp/" prefix from attrbutes that had them  
+| Category| ttl | - | tags datatype changed to TagGroup| 
+| Context|location , version|core_version , city , country|
+| Descriptor||symbol , audio , 3d_render|media , additional_desc|
+| Domain|name , code , additional_info|-|type changed from String to object
+| Error|||type - Enum restriction removed|
+| Fulfillment||provider_id , person , customer.person ,  customer.contact , start , end|rateable , stops(array of FulfillmentStop) , path , tags (TagGroup)|customer type changed to point to (Customer) |
+| Image|-|-|Schema changed from string to set of properties|
+| Intent|-|-|tags changed from (Tags)  to array of (TagGroup)
+| ItemQuantity|unitized|-|-|
+| Item|parent_item_quantity ,  manufacturer , quantity , category_ids ,  fulfillment_ids ,  location_ids ,  payment_id ,  add_ons , cancellation_terms ,  refund_terms , replacement_terms ,  return_terms , xinput ,  ttl|category_id ,  location_id ,  fulfillent_id ,  |tags 
+| Location|map_url , district ,  state , area_code ,  rating|station_code|
+| Offer|tags|-|-|
+| Order|ref_order_ids , status ,  type , fulfillments , cancellation , cancellation_terms ,  refund_terms ,  replacement_terms ,  return_terms ,  payments ,  xinput ,  tags|state , documents , fulfillment ,  payment| items  , add_ons , offers 
+| Organization|descriptor , address , city , state , contact|name , cred|
+| Payment|id ,  collected_by , url , params.bank_code ,  params.bank_account_number , virtual_payment_address ,  source_bank_code ,  source_bank_account_number ,  source_virtual_payment_address , tags  | tl_method , uri , params.transaction_status| type enum changed ON_ORDER to PRE_ORDER| 
+| Person | id , url , age , creds , languages , skills|cred|tags
+| Provider| ttl|locations.rateable | tags
+| Quotation| id  , breakup[].item| |
+| Rating|| feedback_form , feedback_id|
+| Scalar||| value , estimated_value ,  computed_value ,  range.min , range.max - > number to DecimalValue|
+| Tracking| id , location| | |
+| Vehicle| wheels_count , cargo_volumne , wheelchair_access ,  code , emmission_standard| 
+
+### New Schemas
+|Name|
+|-|
+|CancellationTerm| 
+|Credential|
+|Customer|
+|Fee|
+|Form|
+|FulfillmentState|
+|MediaFile|
+|Region|
+|ReplacementTerm|
+|ReturnTerm|
+|Stop|
+|Subscription|
+|Support |
+|Tag|
+|TagGroup|
+|XInput|
+
+### Removed Schemas
+|Schema|
+|-|
+|Dimensions| 
+|Document|
+|Feedback|
+|FeedbackForm|
+|FeedbackFormElement|
+|FeedbackUrl|
+|Language|
+|Subscriber|
+|Operator|
+|Page|
+|Policy|
+|Rateable|
+|RatingAck|
+|Tags|
+|TrackingData|
+
+
 ## Core v0.9.3
 
 ### 13 July, 2021

MAINTAINERS.md

@@ -1,7 +1,8 @@
 # Ravi Prakash  
-* __Email__ : [email protected]
-* __Github__ : [core-wg-admin](https://github.com/core-wg-admin)
+* __Github__ : [ravi-prakash-v](https://github.com/ravi-prakash-v)
 
 # Pramod Varma 
-* __Email__ : [email protected]
 * __Github__ : [pramodkvarma](https://github.com/pramodkvarma)
+
+# Venkataraman Mahadevan
+* __Github__ : [venkatramanm](https://github.com/venkatramanm)

README.md

@@ -8,6 +8,7 @@ metaDescription: "Domain agnostic transaction specification for e-commerce"
 
 | Domain                | Version   |    Release Date       |
 |-----------------------|-----------|-----------------------|
+|   Core   |    1.0.0      | 31 December 2022       |
 |   Core   |    0.9.3      | 22 December 2021       |
 |   Core   |    0.9.2      | 27 July, 2021        |
 |   Core   |    0.9.1  | 09 November, 2020        |

api/meta/components/index.yaml

@@ -0,0 +1,97 @@
+openapi: 3.0.0
+info:
+  title: Beckn Protocol Meta API
+  description: This document contains all the meta API endpoints that are implemented by the network participants. The information returned from these endpoints typically contain cacheable information. 
+  version: "1.0.0"
+security:
+  - SubscriberAuth: []
+paths:
+  /get_cancellation_reasons:
+    post:
+      tags:
+        - Beckn Provider Platform (BPP)
+      description: BAP fetches the list of cancellation reasons from BPP
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "./io/GetCancellationReasons.yaml"
+      responses:
+        default:
+          $ref: "./io/Response.yaml"
+  /cancellation_reasons:
+    post:
+      tags:
+        - Beckn Application Platform (BPP)
+      description: BPP sends cancellation reasons to BAP
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "./io/CancellationReasons.yaml"
+      responses:
+        default:
+          $ref: "./io/Response.yaml"
+  /get_return_reasons:
+    post:
+      tags:
+        - Beckn Provider Platform (BPP)
+      description: BAP requests BPP to provide the list of return reasons
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "./io/GetReturnReasons.yaml"
+      responses:
+        default:
+          $ref: "./io/Response.yaml"
+
+  /return_reasons:
+    post:
+      tags:
+        - Beckn Application Platform (BPP)
+      description: BPP provides the list of return reasons to the BAP
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "./io/ReturnReasons.yaml"
+      responses:
+        default:
+          $ref: "./io/Response.yaml"
+  /get_rating_categories:
+    post:
+      tags:
+        - Beckn Provider Platform (BPP)
+      description: BAP requests BPP to provide the list of entities that can be rated on its system
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "./io/GetRatingCategories.yaml"
+      responses:
+        default:
+          $ref: "./io/Response.yaml"
+  /rating_categories:
+    post:
+      tags:
+        - Beckn Application Platform (BPP)
+      description: BPP provides the list of entities that can be rated in its system to the BAP
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "./io/RatingCategories.yaml"
+      responses:
+        default:
+          $ref: "./io/Response.yaml"
+components:
+  securitySchemes:
+    SubscriberAuth:
+      type: apiKey
+      in: header
+      name: Authorization
+      description: 'Signature of message body using signing public key of the caller. <br/><br/>Format:<br/><br/><code>Authorization : Signature keyId="{subscriber_id}|{key_id}|{algorithm}",algorithm="ed25519",created="1606970629",expires="1607030629",headers="(created) (expires) digest",signature="Base64(signing string)"</code>'
+  schemas:
+    $ref: "./schema/index.yaml"
+

api/meta/components/io/CancellationReasons.yaml

@@ -0,0 +1,23 @@
+type: object
+properties:
+  context:
+    allOf:
+      - $ref: "../../../../schema/Context.yaml"
+      - properties:
+          action:
+            enum:
+              - cancellation_reasons
+        required:
+          - action
+  message:
+    type: object
+    properties:
+      cancellation_reasons:
+        type: array
+        items:
+            $ref: '../../../../schema/Option.yaml'
+    required:
+      - cancellation_reasons
+required:
+  - context
+  - message

api/meta/components/io/GetCancellationReasons.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  context:
+    allOf:
+      - $ref: "../../../../schema/Context.yaml"
+      - properties:
+          action:
+            enum:
+              - get_cancellation_reasons
+        required:
+          - action
+required:
+  - context

api/meta/components/io/GetRatingCategories.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  context:
+    allOf:
+      - $ref: "../../../../schema/Context.yaml"
+      - properties:
+          action:
+            enum:
+              - get_rating_categories
+        required:
+          - action
+required:
+  - context

api/meta/components/io/GetReturnReasons.yaml

@@ -0,0 +1,13 @@
+type: object
+properties:
+  context:
+    allOf:
+      - $ref: "../../../../schema/Context.yaml"
+      - properties:
+          action:
+            enum:
+              - get_return_reasons
+        required:
+          - action
+required:
+  - context

api/meta/components/io/RatingCategories.yaml

@@ -0,0 +1,23 @@
+type: object
+properties:
+  context:
+    allOf:
+      - $ref: "../../../../schema/Context.yaml"
+      - properties:
+          action:
+            enum:
+              - rating_categories
+        required:
+          - action
+  message:
+    type: object
+    properties:
+      rating_categories:
+        type: array
+        items:
+            $ref: '../../../../schema/Rating.yaml#/properties/rating_category'
+    required:
+      - return_reasons
+required:
+  - context
+  - message

api/meta/components/io/Response.yaml

@@ -0,0 +1,23 @@
+description: Acknowledgement of message received after successful validation of schema and signature
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        message:
+          type: object
+          properties:
+            ack:
+              allOf:
+                - $ref: "../../../../schema/Ack.yaml"
+                - properties:
+                    status:
+                      enum:
+                        - ACK
+                        - NACK
+          required:
+            - ack
+        error:
+          $ref: "../../../../schema/Error.yaml"
+      required:
+        - message

api/meta/components/io/ReturnReasons.yaml

@@ -0,0 +1,23 @@
+type: object
+properties:
+  context:
+    allOf:
+      - $ref: "../../../../schema/Context.yaml"
+      - properties:
+          action:
+            enum:
+              - return_reasons
+        required:
+          - action
+  message:
+    type: object
+    properties:
+      return_reasons:
+        type: array
+        items:
+            $ref: '../../../../schema/Option.yaml'
+    required:
+      - return_reasons
+required:
+  - context
+  - message

api/meta/components/schema/index.yaml

@@ -0,0 +1,8 @@
+Context:
+  $ref: "../../../../schema/Context.yaml"
+
+Option:
+  $ref: "../../../../schema/Option.yaml"
+
+Rating:
+  $ref: "../../../../schema/Rating.yaml"