hiiretail-json-schema-registry

Hii Retail public JSON schema registry

Structure

• customer-config
• external-events

Each directory is representing a 'service-consumer' of schemas. For example external events schemas for event sources can be found in external-events

Each directory on top level has sub directories like:

• customer-config/cloud-core

Directories on 2nd level represent team names of owner of contained schemas.

Each directory on 2nd level contains schemas.

Schema file name has following structure:

{name-of-entity}      {extention}
che.receipt-layout.v1.json

A version name is encouraged. If it is not present in entity name please add it before {extention}

IMPORTANT

Keep schemas immutable. That makes it easier for consumers of schemas

Usage in configuration service

Guide for using schemas in Customer Controlled Configuration

Schema validation and synchronization

👉 Adding or modifying schema under customer-config will be validated and synchronized to CCC-API.

1. $schema MUST be draft/2020-12/schema (draft/07/schema is not supported at this time)
2. If the schema is not defined in CCC on any configuration definition validation will be skipped.
3. New schema value MUST be backwards-compatible.

If these conditions are not met the workflow will let you know what is wrong.