ondc-code-generator 1.0.0 → 1.0.1

package/alpha/docs/rag-docs/init.md

@@ -0,0 +1,422 @@
+---
+action: init
+codeName: L1validations
+numTests: 49
+generated: 2026-03-10
+domain: ONDC:FIS12
+version: 2.3.0
+---
+
+# L1validations — `init` Validations
+
+These are the validation rules applied when processing the `init` API call in the L1validations flow.
+There are **49** validation rules organized into **7** top-level group(s).
+
+---
+## INIT_CONTEXT
+
+This group contains **3** sub-group(s)/validation(s): CONTEXT_REQUIRED, CONTEXT_ENUM, and CONTEXT_REGEX.
+
+---
+
+### CONTEXT_REQUIRED
+
+This is a group of **12** sub-validation(s) that all must pass: REQUIRED_CONTEXT_LOCATION_COUNTRY_CODE, REQUIRED_CONTEXT_LOCATION_CITY_CODE, REQUIRED_CONTEXT_DOMAIN, REQUIRED_CONTEXT_TIMESTAMP, REQUIRED_CONTEXT_BAP_ID, REQUIRED_CONTEXT_BAP_URI, REQUIRED_CONTEXT_TRANSACTION_ID, REQUIRED_CONTEXT_MESSAGE_ID, REQUIRED_CONTEXT_VERSION, REQUIRED_CONTEXT_TTL, REQUIRED_CONTEXT_BPP_ID, and REQUIRED_CONTEXT_BPP_URI.
+
+---
+
+**REQUIRED_CONTEXT_LOCATION_COUNTRY_CODE**
+`group: INIT_CONTEXT > CONTEXT_REQUIRED | type: leaf`
+
+- $.context.location.country.code must be present in the payload
+
+**REQUIRED_CONTEXT_LOCATION_CITY_CODE**
+`group: INIT_CONTEXT > CONTEXT_REQUIRED | type: leaf`
+
+- $.context.location.city.code must be present in the payload
+
+**REQUIRED_CONTEXT_DOMAIN**
+`group: INIT_CONTEXT > CONTEXT_REQUIRED | type: leaf`
+
+- $.context.domain must be present in the payload
+
+**REQUIRED_CONTEXT_TIMESTAMP**
+`group: INIT_CONTEXT > CONTEXT_REQUIRED | type: leaf`
+
+- $.context.timestamp must be present in the payload
+
+**REQUIRED_CONTEXT_BAP_ID**
+`group: INIT_CONTEXT > CONTEXT_REQUIRED | type: leaf`
+
+- $.context.bap_id must be present in the payload
+
+**REQUIRED_CONTEXT_BAP_URI**
+`group: INIT_CONTEXT > CONTEXT_REQUIRED | type: leaf`
+
+- $.context.bap_uri must be present in the payload
+
+**REQUIRED_CONTEXT_TRANSACTION_ID**
+`group: INIT_CONTEXT > CONTEXT_REQUIRED | type: leaf`
+
+- $.context.transaction_id must be present in the payload
+
+**REQUIRED_CONTEXT_MESSAGE_ID**
+`group: INIT_CONTEXT > CONTEXT_REQUIRED | type: leaf`
+
+- $.context.message_id must be present in the payload
+
+**REQUIRED_CONTEXT_VERSION**
+`group: INIT_CONTEXT > CONTEXT_REQUIRED | type: leaf`
+
+- $.context.version must be present in the payload
+
+**REQUIRED_CONTEXT_TTL**
+`group: INIT_CONTEXT > CONTEXT_REQUIRED | type: leaf`
+
+- $.context.ttl must be present in the payload
+
+**REQUIRED_CONTEXT_BPP_ID**
+`group: INIT_CONTEXT > CONTEXT_REQUIRED | type: leaf`
+
+- $.context.bpp_id must be present in the payload
+
+**REQUIRED_CONTEXT_BPP_URI**
+`group: INIT_CONTEXT > CONTEXT_REQUIRED | type: leaf`
+
+- $.context.bpp_uri must be present in the payload
+
+### CONTEXT_ENUM
+
+This is a group of **2** sub-validation(s) that all must pass: VALID_CONTEXT_LOCATION_COUNTRY_CODE and VALID_CONTEXT_DOMAIN.
+
+---
+
+**VALID_CONTEXT_LOCATION_COUNTRY_CODE**
+`group: INIT_CONTEXT > CONTEXT_ENUM | type: leaf`
+
+- All elements of $.context.location.country.code must be in ["IND"]
+
+> **Skip if:**
+>     - $.context.location.country.code is not in the payload
+
+**VALID_CONTEXT_DOMAIN**
+`group: INIT_CONTEXT > CONTEXT_ENUM | type: leaf`
+
+- All elements of $.context.domain must be in ["ONDC:FIS12"]
+
+> **Skip if:**
+>     - $.context.domain is not in the payload
+
+### CONTEXT_REGEX
+
+This is a group of **7** sub-validation(s) that all must pass: REGEX_CONTEXT_LOCATION_CITY_CODE, REGEX_CONTEXT_TIMESTAMP_1, REGEX_CONTEXT_BAP_ID, REGEX_CONTEXT_BAP_URI, REQUIRED_CONTEXT_TTL, REGEX_CONTEXT_BPP_ID, and REGEX_CONTEXT_BPP_URI.
+
+---
+
+**REGEX_CONTEXT_LOCATION_CITY_CODE**
+`group: INIT_CONTEXT > CONTEXT_REGEX | type: leaf`
+
+- All elements of $.context.location.city.code must follow every regex in ["(\\*)|(^std\\:[0-9]{2,4}$)"]
+
+> **Skip if:**
+>     - $.context.location.city.code is not in the payload
+
+**REGEX_CONTEXT_TIMESTAMP_1**
+`group: INIT_CONTEXT > CONTEXT_REGEX | type: leaf`
+
+- All elements of $.context.timestamp must follow every regex in ["^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})$"]
+
+> **Skip if:**
+>     - $.context.timestamp is not in the payload
+
+**REGEX_CONTEXT_BAP_ID**
+`group: INIT_CONTEXT > CONTEXT_REGEX | type: leaf`
+
+- All elements of $.context.bap_id must follow every regex in ["^(?!.*\b(?:http|https|www)\b)[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)+$"]
+
+> **Skip if:**
+>     - $.context.bap_id is not in the payload
+
+**REGEX_CONTEXT_BAP_URI**
+`group: INIT_CONTEXT > CONTEXT_REGEX | type: leaf`
+
+- All elements of $.context.bap_uri must follow every regex in ["^https:\/\/(www\.)?[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)+(/)?$"]
+
+> **Skip if:**
+>     - $.context.bap_uri is not in the payload
+
+**REQUIRED_CONTEXT_TTL**
+`group: INIT_CONTEXT > CONTEXT_REGEX | type: leaf`
+
+- All elements of $.context.ttl must follow every regex in ["^P(?=\\d|T\\d)(\\d+Y)?(\\d+M)?(\\d+D)?(T(\\d+H)?(\\d+M)?(\\d+S)?)?$"]
+
+> **Skip if:**
+>     - $.context.ttl is not in the payload
+
+**REGEX_CONTEXT_BPP_ID**
+`group: INIT_CONTEXT > CONTEXT_REGEX | type: leaf`
+
+- All elements of $.context.bpp_id must follow every regex in ["^(?!.*\b(?:http|https|www)\b)[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)+$"]
+
+> **Skip if:**
+>     - $.context.bpp_id is not in the payload
+
+**REGEX_CONTEXT_BPP_URI**
+`group: INIT_CONTEXT > CONTEXT_REGEX | type: leaf`
+
+- All elements of $.context.bpp_uri must follow every regex in ["^https:\/\/(www\.)?[a-zA-Z0-9-]+(\.[a-zA-Z0-9-]+)+(/)?$"]
+
+> **Skip if:**
+>     - $.context.bpp_uri is not in the payload
+
+---
+
+## REQUIRED_PROVIDER_ID
+
+`group: top-level | type: leaf`
+
+- $.message.order.provider.id must be present in the payload
+
+---
+
+## REQUIRED_ITEM_FIELDS
+
+This group contains **3** sub-group(s)/validation(s): REQUIRED_ITEM_ID, REQUIRED_PARENT_ITEM_ID, and REQUIRED_XINPUT_ITEMS.
+
+---
+
+**REQUIRED_ITEM_ID**
+`group: REQUIRED_ITEM_FIELDS | type: leaf`
+
+- $.message.order.items[*].id must be present in the payload
+
+**REQUIRED_PARENT_ITEM_ID**
+`group: REQUIRED_ITEM_FIELDS | type: leaf`
+
+- $.message.order.items[*].parent_item_id must be present in the payload
+
+### REQUIRED_XINPUT_ITEMS
+
+This is a group of **3** sub-validation(s) that all must pass: REQUIRED_HEAD_CODE, REQUIRED_FORM_ID, and REQUIRED_SUBMISSION_ID.
+
+> **Skip if:**
+> - $.message.order.items[*].xinput.form.id must **not** be present in the payload
+
+---
+
+**REQUIRED_HEAD_CODE**
+`group: REQUIRED_ITEM_FIELDS > REQUIRED_XINPUT_ITEMS | type: leaf`
+
+- $.message.order.items[*].xinput.head.descriptor.code must be present in the payload
+
+**REQUIRED_FORM_ID**
+`group: REQUIRED_ITEM_FIELDS > REQUIRED_XINPUT_ITEMS | type: leaf`
+
+- $.message.order.items[*].xinput.form.id must be present in the payload
+
+**REQUIRED_SUBMISSION_ID**
+`group: REQUIRED_ITEM_FIELDS > REQUIRED_XINPUT_ITEMS | type: leaf`
+
+- $.message.order.items[*].xinput.form_response.submission_id must be present in the payload
+
+> **Skip if:**
+>     - $.message.order.items[*].xinput.form_response.submission_id is not in the payload
+
+---
+
+## INIT_PAYMENT_ITEMS
+
+This group contains **2** sub-group(s)/validation(s): REQUIRED_PAYMENT_ITEMS and VALID_PAYMENT_ITEMS.
+
+---
+
+### REQUIRED_PAYMENT_ITEMS
+
+This is a group of **7** sub-validation(s) that all must pass: REQUIRED_PAYMENT_ITEMS, REQUIRED_PAYMENT_ID, REQUIRED_PAYMENT_STATUS, REQUIRED_PAYMENT_COLLECTED_BY, REQUIRED_PAYMENT_BANK_ACCOUNT_NUMBER, REQUIRED_PAYMENT_BANK_CODE, and REQUIRED_PAYMENT_LABEL.
+
+---
+
+**REQUIRED_PAYMENT_ITEMS**
+`group: INIT_PAYMENT_ITEMS > REQUIRED_PAYMENT_ITEMS | type: leaf`
+
+- $.message.order.payments[*].type must be present in the payload
+
+**REQUIRED_PAYMENT_ID**
+`group: INIT_PAYMENT_ITEMS > REQUIRED_PAYMENT_ITEMS | type: leaf`
+
+- $.message.order.payments[*].id must be present in the payload
+
+**REQUIRED_PAYMENT_STATUS**
+`group: INIT_PAYMENT_ITEMS > REQUIRED_PAYMENT_ITEMS | type: leaf`
+
+- $.message.order.payments[*].status must be present in the payload
+
+**REQUIRED_PAYMENT_COLLECTED_BY**
+`group: INIT_PAYMENT_ITEMS > REQUIRED_PAYMENT_ITEMS | type: leaf`
+
+- $.message.order.payments[*].collected_by must be present in the payload
+
+> **Skip if:**
+>     - not all elements of $.message.order.payments[*].time.label are in ["LOAN_DISBURSMENT"]
+
+**REQUIRED_PAYMENT_BANK_ACCOUNT_NUMBER**
+`group: INIT_PAYMENT_ITEMS > REQUIRED_PAYMENT_ITEMS | type: leaf`
+
+- $.message.order.payments[*].params.bank_account_number must be present in the payload
+
+> **Skip if:**
+>     - not all elements of $.message.order.payments[*].time.label are in ["LOAN_DISBURSMENT"]
+
+**REQUIRED_PAYMENT_BANK_CODE**
+`group: INIT_PAYMENT_ITEMS > REQUIRED_PAYMENT_ITEMS | type: leaf`
+
+- $.message.order.payments[*].params.bank_code must be present in the payload
+
+> **Skip if:**
+>     - not all elements of $.message.order.payments[*].time.label are in ["LOAN_DISBURSMENT"]
+
+**REQUIRED_PAYMENT_LABEL**
+`group: INIT_PAYMENT_ITEMS > REQUIRED_PAYMENT_ITEMS | type: leaf`
+
+- $.message.order.payments[*].time.label must be present in the payload
+
+### VALID_PAYMENT_ITEMS
+
+This is a group of **4** sub-validation(s) that all must pass: VALID_PAYMENT_TYPE, VALID_PAYMENT_STATUS, VALID_PAYMENT_COLLECTOR, and VALID_PAYMENT_LABEL.
+
+---
+
+**VALID_PAYMENT_TYPE**
+`group: INIT_PAYMENT_ITEMS > VALID_PAYMENT_ITEMS | type: leaf`
+
+- All elements of $.message.order.payments[*].type must be in ["ON_ORDER", "ON_FULFILLMENT", "POST_FULFILLMENT"]
+
+> **Skip if:**
+>     - $.message.order.payments[*].type is not in the payload
+
+**VALID_PAYMENT_STATUS**
+`group: INIT_PAYMENT_ITEMS > VALID_PAYMENT_ITEMS | type: leaf`
+
+- All elements of $.message.order.payments[*].status must be in ["NOT-PAID", "PAID", "DEFERRED", "DELAYED"]
+
+> **Skip if:**
+>     - $.message.order.payments[*].status is not in the payload
+
+**VALID_PAYMENT_COLLECTOR**
+`group: INIT_PAYMENT_ITEMS > VALID_PAYMENT_ITEMS | type: leaf`
+
+- All elements of $.message.order.payments[*].collected_by must be in ["BPP", "CONSUMER"]
+
+> **Skip if:**
+>     - $.message.order.payments[*].collected_by is not in the payload
+
+**VALID_PAYMENT_LABEL**
+`group: INIT_PAYMENT_ITEMS > VALID_PAYMENT_ITEMS | type: leaf`
+
+- All elements of $.message.order.payments[*].time.label must be in ["INSTALLMENT", "LOAN_DISBURSMENT"]
+
+> **Skip if:**
+>     - $.message.order.payments[*].time.label is not in the payload
+
+---
+
+## REQUIRED_FULFILMENT_ITEMS
+
+This group contains **2** sub-group(s)/validation(s): REQUIRED_FULFILLMENT_ID and REQUIRED_CUSTOMER_ITEMS.
+
+---
+
+**REQUIRED_FULFILLMENT_ID**
+`group: REQUIRED_FULFILMENT_ITEMS | type: leaf`
+
+- $.message.order.fulfillments[*].id must be present in the payload
+
+### REQUIRED_CUSTOMER_ITEMS
+
+This group contains **5** sub-group(s)/validation(s): REQUIRED_CUSTOMER_DOB, REQUIRED_CUSTOMER_GENDER, REQUIRED_CREDS, REQUIRED_CUSTOMER_CONTACT_EMAIL, and REQUIRED_CUSTOMER_CONTACT_PHONE.
+
+> **Skip if:**
+> - $.message.order.fulfillments[*].customer.person.name must **not** be present in the payload
+
+---
+
+**REQUIRED_CUSTOMER_DOB**
+`group: REQUIRED_FULFILMENT_ITEMS > REQUIRED_CUSTOMER_ITEMS | type: leaf`
+
+- $._EXTERNAL._SELF.message.order.fulfillments[*].customer.person.name must be present in the payload
+
+**REQUIRED_CUSTOMER_GENDER**
+`group: REQUIRED_FULFILMENT_ITEMS > REQUIRED_CUSTOMER_ITEMS | type: leaf`
+
+- $._EXTERNAL._SELF.message.order.fulfillments[*].customer.person.name must be present in the payload
+
+#### REQUIRED_CREDS
+
+This is a group of **2** sub-validation(s) that all must pass: REQUIRED_CUSTOMER_CREDS_ID and REQUIRED_CUSTOMER_CREDS_TYPE.
+
+> **Skip if:**
+> - $.message.order.fulfillments[*].customer.person.creds[*].id must **not** be present in the payload
+
+---
+
+**REQUIRED_CUSTOMER_CREDS_ID**
+`group: REQUIRED_FULFILMENT_ITEMS > REQUIRED_CUSTOMER_ITEMS > REQUIRED_CREDS | type: leaf`
+
+- $._EXTERNAL._SELF.message.order.fulfillments[*].customer.person.creds[*].id must be present in the payload
+
+**REQUIRED_CUSTOMER_CREDS_TYPE**
+`group: REQUIRED_FULFILMENT_ITEMS > REQUIRED_CUSTOMER_ITEMS > REQUIRED_CREDS | type: leaf`
+
+- $._EXTERNAL._SELF.message.order.fulfillments[*].customer.person.creds[*].id must be present in the payload
+
+**REQUIRED_CUSTOMER_CONTACT_EMAIL**
+`group: REQUIRED_FULFILMENT_ITEMS > REQUIRED_CUSTOMER_ITEMS | type: leaf`
+
+- $._EXTERNAL._SELF.message.order.fulfillments[*].customer.person.name must be present in the payload
+
+**REQUIRED_CUSTOMER_CONTACT_PHONE**
+`group: REQUIRED_FULFILMENT_ITEMS > REQUIRED_CUSTOMER_ITEMS | type: leaf`
+
+- $._EXTERNAL._SELF.message.order.fulfillments[*].customer.person.name must be present in the payload
+
+---
+
+## INIT_PAYMENT_TAGS
+
+This is a group of **2** sub-validation(s) that all must pass: VALID_PAYMENT_TAGS and REQUIRED_ACCOUNT_DETAILS.
+
+---
+
+**VALID_PAYMENT_TAGS**
+`group: INIT_PAYMENT_TAGS | type: leaf`
+
+- All elements of $.message.order.payments[*].tags[*].descriptor.code must be in ["ACCOUNT_DETAILS", "BREAKUP"]
+
+> **Skip if:**
+>     - $.message.order.payments[*].tags[*].descriptor.code is not in the payload
+
+**REQUIRED_ACCOUNT_DETAILS**
+`group: INIT_PAYMENT_TAGS | type: leaf | scope: $.message.order.payments[*].tags[?(@.descriptor.code == ACCOUNT_DETAILS)]`
+
+- All elements of $.message.order.payments[*].tags[?(@.descriptor.code == ACCOUNT_DETAILS)].list[*].descriptor.code must be in ["ACCOUNT_TYPE", "ACCOUNT_HOLDER_NAME"]
+
+---
+
+## INIT_BAP_TERM_TAGS
+
+This is a group of **2** sub-validation(s) that all must pass: REQUIRED_TLC_TAGS and REQUIRED_BAP_TERMS.
+
+---
+
+**REQUIRED_TLC_TAGS**
+`group: INIT_BAP_TERM_TAGS | type: leaf`
+
+- All elements of $.message.order.tags[*].descriptor.code must be in ["BAP_TERMS", "BPP_TERMS"]
+
+> **Skip if:**
+>     - $.message.order.tags[*].descriptor.code is not in the payload
+
+**REQUIRED_BAP_TERMS**
+`group: INIT_BAP_TERM_TAGS | type: leaf | scope: $.message.order.tags[?(@.descriptor.code == BAP_TERMS)]`
+
+- All elements of $.message.order.tags[?(@.descriptor.code == BAP_TERMS)].list[*].descriptor.code must be in ["STATIC_TERMS", "OFFLINE_CONTRACT"]