Skip to content

croct-tech/schemas

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Croct JavaScript SDK
Croct Schemas
Schemas for Croct configurations, APIs, and more.

Introduction

This repository provides schemas to validate configurations, API payloads, and other structures used by Croct.

JSON schemas

To use a JSON schema in your JSON configuration, include the $schema keyword referencing the appropriate schema URL:

{
  "$schema": "https://schema.croct.com/v1/content.json",
  "type": "boolean",
  "value": {
    "type": "static",
    "value": true
  }
}

Available schemas

Below is a list of available JSON schemas:

Schema URL
Project https://schema.croct.com/json/v1/project.json
Content https://schema.croct.com/json/v1/content.json
Content schema https://schema.croct.com/json/v1/content-schema.json
Template https://schema.croct.com/json/v1/template.json
Web event https://schema.croct.com/json/v1/web-event.json

Documentation

Visit our official documentation.

Support

Join our official Slack channel to get help from the Croct team and other developers.

Contribution

Contributions are always welcome!

  • Report any bugs or issues on the issue tracker.
  • For major changes, please open an issue first to discuss what you would like to change.
  • Please make sure to update tests as appropriate. Run tests with npm test.

License

This library is licensed under the MIT license.