Documentation

Importing Schemas

Import data structures from a JSON Schema file

2 min read

If you already have a data structure defined as a JSON Schema, you can import it instead of building it by hand.

Supported formats

  • JSON Schema Draft-07 / 2019-09 / 2020-12
  • JSON or YAML files

How to import

In the Data Scheme tab's add menu, choose Import JSON Schema… and pick the file. The imported content is added in a single operation, and you can Undo it if needed.

What gets imported

  • Data Schema — the defined object structures. Named types defined under $defs, definitions, and similar are imported, and $ref references and allOf/oneOf/anyOf are merged appropriately.
  • Data Enum — string and integer enumerations. Identical value sets are deduplicated.
  • Field metadata — descriptions (description), required status (required), default values (default), and validation constraints (min/max length, minimum/maximum, pattern, format, etc.) are imported and preserved.

Imported validation constraints and descriptions are preserved as documentation only. The field editor shows the required marker (*), the description, the constraint summary, and the default value as read-only, but nothing is enforced at runtime.

If you have a spec for a server API, use Importing OpenAPI / Swagger instead of JSON Schema. It builds not only the data structures but the API endpoints too, all at once.