https://github.com/croct-tech/schemas
Schemas for Croct configurations, APIs, and more.
https://github.com/croct-tech/schemas
croct json-schema schema validation
Last synced: about 2 months ago
JSON representation
Schemas for Croct configurations, APIs, and more.
- Host: GitHub
- URL: https://github.com/croct-tech/schemas
- Owner: croct-tech
- License: mit
- Created: 2025-03-21T18:31:11.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2025-04-10T22:52:23.000Z (about 2 months ago)
- Last Synced: 2025-04-12T04:06:49.443Z (about 2 months ago)
- Topics: croct, json-schema, schema, validation
- Language: TypeScript
- Homepage: https://schema.croct.com
- Size: 237 KB
- Stars: 11
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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:
```json
{
"$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`](https://schema.croct.com/json/v1/project.json) |
| Content | [`https://schema.croct.com/json/v1/content.json`](https://schema.croct.com/json/v1/content.json) |
| Content schema | [`https://schema.croct.com/json/v1/content-schema.json`](https://schema.croct.com/json/v1/content-schema.json) |
| Template | [`https://schema.croct.com/json/v1/template.json`](https://schema.croct.com/json/v1/template.json) |
| Web event | [`https://schema.croct.com/json/v1/web-event.json`](https://schema.croct.com/json/v1/web-event.json) |
## Documentation
Visit our [official documentation](https://docs.croct.com).
## Support
Join our official [Slack channel](https://croct.link/community) to get help from the Croct team and other developers.
## Contribution
Contributions are always welcome!
- Report any bugs or issues on the [issue tracker](https://github.com/croct-tech/plug-js/issues).
- For major changes, please [open an issue](https://github.com/croct-tech/plug-js/issues) 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](LICENSE).