> For the complete documentation index, see [llms.txt](https://docs.brigge.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.brigge.ai/documentation/brigge-for-transformers/schemas.md).
# Schemas
## Introduction
A schema describes the expected structure of data for a given [system](/documentation/brigge-for-engineers/systems.md). It describes which fields are expected, where they are expected, and their associated data types.
Throughout Brigge, schemas are used wherever field selections are required. When you use a schema, field selection is much easier - the schema structure is displayed and you simply select the required field(s). For example, when [mapping nodes](/documentation/brigge-for-transformers/pipelines/pipeline-nodes/map-node.md), you start by selecting schemas for `inputs` and `outputs`. All fields in these schemas are listed so mappings can be made visually:
{% hint style="info" %}
Typically, schemas are optional - if preferred you can enter dot notation paths directly.
{% endhint %}
## Working with schemas
Accessing your schemas
To view, edit, create, and manage schemas for your organisation, select `settings` ➥ `schemas` from the navigation menu. Here, you'll find all schemas listed:
From here you can: click any schema name to view/edit content; search for schemas by name (or partial name); create a new schema; delete a schema.
{% hint style="info" %}
The `schemable type` reflects where the schema was created (i.e. the schema parent). For example, if a schema is created from a [system endpoint](/documentation/brigge-for-engineers/systems.md), the type is `operation`. If a schema is created from the schemas page, there is no type. The `schemable id` is an internal id correlating to the `schemable type`.
{% endhint %}
Viewing & editing schema content
Click the name of any schema to view the associated content - for example:
Key items are summarised below:
{% stepper %}
{% step %}
**Renaming a schema**
If you update the schema name and save changes, the change takes effect wherever the schema is currently used.
{% endstep %}
{% step %}
**Searching for schema elements**
Enter the name (or partial name) of a schema element that you want to find. Any matched items are highlighted (if needed, you can use `prev` / `next` buttons to step through each one in turn). For example:
{% endstep %}
{% step %}
**Toggle schema view**
By default, the selected schema is displayed in form view. For advanced editing, use the toggle option and switch to raw view. For example:
{% endstep %}
{% step %}
**Element details & options**
In form view, elements are listed so you can see the element name and data type, at a glance. Hover your cursor over any element for [update options](#updating-a-schema):
{% endstep %}
{% endstepper %}
Creating a schema
You can create schemas in different places throughout Brigge. For example:
Irrespective of where you choose to create a schema, the same setup principles apply: enter a name for the schema, paste schema content into the editor, then click the `next` button:
Your schema content might be an 'official' schema (for example, one that you've copied and pasted from elsewhere) or you can paste a sample output from your system.
{% hint style="info" %}
If you're working with a pipeline and need to create a schema 'on the fly': access the logs, find an output payload, then use the `create schema` option.
{% endhint %}
{% hint style="info" %}
Schemas can be as simple or as complex as you need. With advanced knowledge, you can create nested schemas, link to external schemas, etc. If this is something you'd like to explore, the following website may be useful: .
{% endhint %}
After pasting your content and confirming with the `next` button, the schema is displayed in form view. Click the `save` button to confirm settings and make this schema available for use throughout Brigge.
Updating a schema
When viewing a schema in form view, hover your cursor over any element for update options:
These options are summarised below:
{% stepper %}
{% step %}
**Add array element**
Click the `plus` icon to add a new element to an array object (only applicable if an array is selected). When prompted, choose a data type for this element:
Then enter details for this element. For example:
{% hint style="info" %}
Element details vary, depending on the selected data type.
{% endhint %}
{% endstep %}
{% step %}
**Edit element**
Click the `pencil` icon to edit an existing element (of any type) to view and update details. For example:
{% hint style="info" %}
Element details vary, depending on the selected data type.
{% endhint %}
{% endstep %}
{% step %}
**Delete element**
Click the `trash` icon to remove an existing element. The item is removed immediately.
{% endstep %}
{% endstepper %}
Deleting a schema
To delete a schema that's no longer in use, click the associated `delete` button from the [schema list](#accessing-your-schemas). For example:
{% hint style="danger" %}
A schema cannot be restored if deleted.
{% endhint %}
{% hint style="info" %}
You can't delete a schema if it's currently configured in pipelines.
In this scenario, you'll see a warning that lists relevant pipelines. You should remove the schema from any nodes where it's used in these pipelines and then try the `delete` action again.
{% endhint %}
