Schemas

PlanDesigner plandesigner

A class is a schema component of the version — in OpenAPI terms, an entry under components/schemas. It has properties, tags, a kind, and relationships to other classes through properties that reference them. Classes are edited in the workspace inspector and on the classic Data Designer canvas; both write the same model through the Apiome REST API.

Create a class

• Workspace: + in the tree ("Add a schema to this version") — name, kind, description, domain. Or Templates… in the Tools section to start from the class template library.
• Classic canvas: Add class in the sidebar footer, or Class templates, or drag + New Reference onto a class to add a referencing property.
• With the assistant: the class edit dialog's Create Class with AI mode ("Describe the class you want"), then Preview & create — "AI can make mistakes — use Preview & create to review the schema before it is saved." See AI assistant.

The Class Template Library groups templates by User & Auth, Products, Orders, Payments, Addresses, Common, Content, Security, Integrations and Notifications.

Properties

Each property has a name, a description, Required, and a type. In the workspace's property panel the type is a primitive with a Format, References another class, or List of these; the registry picker binds it to a type instead.

The classic canvas's Property dialog is the full form, in sections: Basics; Flags & Ownership (Required, Nullable, Read Only, Write Only, Deprecated, and an Owner written as x-owner); Defaults & Constants; Advanced Constraints. Its JSON tab shows the property as a JSON Schema 2020-12 definition. Bind to a Type opens the Select Type picker with tabs Standard, Core System Types, Tenant Types and Custom · Imported, with Apply Type and Clear type binding.

Edit Property in Class changes a property's name and constraints where it is used, and Extract to Class lifts an inline object out into a class of its own.

The Property Template Library offers Identifiers, Timestamps, Audit Fields, Status Fields, Contact Info, Address Fields, Money & Currency, Geolocation, Internationalization, Pagination and Search & Filter; the workspace's Property library tool opens the same set.

Relationships

A property that references another class draws an edge. On the classic canvas you create one by connecting a property's handle to the target class; the canvas warns "Missing class references detected. Connect property handles to target classes to resolve." when a reference points nowhere. Class cards flag Part of a circular dependency and breaking change where either applies.

Tags

Manage Tags (the Tags button in the classic header, Add a tag in the workspace) creates project tags with a name, a colour (Default, Primary, Secondary, Red, Orange, Blue, Green) and a description. The classic layout menu can Group classes with the same tag.

Import classes

Import classes (sidebar footer) or Import schemas… (workspace Tools) opens a three-step dialog — Source → Select Classes → Import:

Source	Takes
File Upload	.yaml, .yml, .json, .graphql, .gql, .raml, .proto, .avsc, .thrift
URL Import	A URL to the same
Clipboard Paste	Pasted text
Git Repository	GitHub or GitLab (needs the development fallback to the main app)
Paste Mermaid	A Mermaid class diagram

"OpenAPI 3.x, Swagger 2.x, and Arazzo specifications are supported." In the workspace an Import into picker files the imported schemas in a domain folder.

Delete a class

Delete in the inspector's Danger section, or Delete class in the sidebar's per-class menu. The confirmation lists the class's dependents first. A published version refuses the edit — see Versions, branches and tags.

Quality

The classic header's Schema quality pill computes a 0–100 score with an A–F grade; clicking it shows Contributions (Factor, Value, Weight, Pts) and a Score guide. The Schema Metrics panel adds classes, properties and relationships counts, complexity, documentation gaps and naming checks (PascalCase classes, camelCase properties), and Reference lint finds dangling references, cycles and orphaned classes. The score is also what the Suite home's quality chip shows.