Steps to ingest schema

Note:

To see the API documentation please go to this link https://editor.swagger.io/ and paste the contents of the github links provided below. The example data provided in the request body is for understanding purposes and it is not the actual data.

The API endpoint specified in the below document is for public mode of installation.

Steps to add the schema for events

Step 1:

Create a postman request and add details

API Endpoint: <domain_name> /api/spec/event

HTTP Method: POST

Step 2:

Build the request body with reference to YAML file. The request body for the above API is attached here for yaml: https://github.com/Sunbird-cQube/spec-ms/blob/dev/spec.yaml Provide valid input details for the parameters shown below.

Step 3:

Click on the send button for request and if the request is successful the user should see a response message. Please refer to the below screenshot.

Once the API response is successful then the schema is stored in the spec.”EventGrammar” table.

Steps to add the schema for dimensions

Step 1:

Create a postman request and add details

API Endpoint: <domain_name> /api/spec/dimension

HTTP Method: POST

Step 2:

Build the request body with reference to YAML file. The request body for the above API is attached here for yaml: https://github.com/Sunbird-cQube/spec-ms/blob/dev/spec.yaml Provide valid input details for the parameters shown below.

Step 3:

Click on the send button for request and if the request is successful the user should see a response message. Please refer to the below screenshot. Once the API response is successful then the schema is stored in the spec.”DimensionGrammar” table.