Your schema is defined by the models you create, and fields you add. Inside the schema editor, you can add fields, create relationships between models, and much more.
All changes to your schema are immediately available via GraphQL.
#Create a model
All models have the following settings:
|Display name||The name displayed inside Hygraph, and content editors.|
|API ID||The name for fetching a single entry|
|Plural API ID||The name for fetching multiple entries|
|Description||Optional hint for content editors when interacting with fields.|
Hygraph will automatically scaffold default values for
API ID, and
Plural API ID based on the
Display name. These values will be available via the API as camel case.
For example, let's imagine we have the model
Post. The following queries, and mutations would be generated by the API automatically, as well as custom input types:
#Edit a model
You can at any time update the settings, and Preview URLs for your content models from within the schema editor.
#Delete a model
For each of the content models you have created, you can choose to update, or delete from the schema editor.
Deleting a model will also delete all of the content entries.
You can add fields to all custom models, and the system Asset model by selecting the field type from the fields list when viewing a model.
All models have system fields. You don't need to add an ID, created, or updated timestamp. These are managed by Hygraph automatically.
Learn more about system fields.
It's most common to create a preview URL for models that represent a page, and have a field such as a slug.
The fields on your model are available to use within the URL template. For example, a
Post model may have the following preview URLs:
|Preview name||URL template|
All models can be embedded into the Rich Text Field Type via a configuration setting. On the API side, we create a union relation that references the selected model.