JSON Schema

CoreModels makes it easy to work with JSON Schema, a powerful vocabulary for ensuring JSON data consistency and validation. Our platform supports full integration with JSON Schema, transforming the technical process of schema management into a collaborative and visual experience.

CoreModels enables you to:

  • Import and Export JSON Schema files.

  • Visualize and edit complex schemas through a user-friendly interface.

  • Collaborate with your team on a single source of truth.

  • Validate data against your schemas.


Importing JSON Schemas

You can import an existing JSON Schema into CoreModels using one of three simple methods:

  • Upload a file: Attach a local JSON Schema file.

  • Provide a URL: Paste a URL to a publicly accessible schema.

  • Connect to GitHub: Link your GitHub account and fetch schemas from your repositories.

We support two different import types to suit your workflow:

Dynamic import is a one-time process that creates a new schema in CoreModels from a JSON Schema file. It's best used when you are importing a new schema for the first time.

Merge import is designed for updating an existing schema. This process detects new changes in the imported file, allows you to review them in a grid, and prompts you to accept or reject them before applying them to your schema. This is ideal for managing ongoing changes and collaborative workflows.


Limitations

While CoreModels supports the vast majority of standard JSON Schemas, there are a few edge cases that may be challenging to import:

  • The JSON Schema keyword ‘items’ has a special handler in CoreModels, since it’s only meaningful when the ‘type’ has the ‘array’ value, we have decided to omit it inside CoreModels, and auto add it in the export when necessary.

  • Having both '$ref' and 'items' in a JSON Schema is not supported.

  • Other edge cases: Some other complex or non-standard structures may have unexpected behavior.

Please contact us if you encounter any issues during import


To try the importer, login to CoreModels, create a project and continue to our Step By Step Guide on importing a JSON Schema

Last updated