Skip to content

Commit

Permalink
details fields for query schema (#781)
Browse files Browse the repository at this point in the history
Co-authored-by: Divesh Pahuja <divesh.pahuja@pimcore.com>
  • Loading branch information
mcassier31 and dvesh3 committed Sep 14, 2023
1 parent e5c4ee1 commit 83c816e
Showing 1 changed file with 29 additions and 4 deletions.
33 changes: 29 additions & 4 deletions doc/10_GraphQL/01_Configuration/02_Schema_Settings.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,39 @@
# Schema Settings

Schema settings define which data entities (Data Object classes, Assets, Documents) should be exposed via the endpoint. For Assets and Documents, default schemas are provided, for Data Object classes the schema can be defined in the field configuration.
Schema settings define which data entities (Data Object classes, Assets, Documents) should be exposed via the endpoint. For Assets and Documents, default schemas are provided, for Data Object classes the schema can be defined in the field configuration.

![Add](../../img/graphql/schema_add.png)

### Field Configuration
## Query Schema

Define all the fields that you want to make available. In addition, you can employ a set of operators.
Here you can configure which Data Objects Classes can be exposed.

### Available Fields Configuration

When adding a new entity with the `Add` button, you can access the `Available Fields Configuration` window with a right-click on the `Settings` icon. You can then define all the target Data Object Class fields you want to make available.

In addition, you can employ a set of operators.

![Schema Settings](../../img/graphql/schema.png)

Please note that not all data types are supported yet!
You will get a notice if you try to add an unsupported data type.
You will get a notice if you try to add an unsupported data type.

## Mutation Schema

Here you can decide if Data Objects for the selected class can be created, updated or deleted from the endpoint.

:::caution

Be aware that a Data Object deleted from an endpoint will be definitively deleted of Pimcore.

:::

### Available Fields Configuration

As for the `Query Schema` field, you can select the fields you want to expose and/or make available for changes in the `Available Fields Configuration` you can open by clicking on the `Settings` icon.

## Generic Types

Here you can define which data types can be created, read, updated or deleted from an endpoint.

0 comments on commit 83c816e

Please sign in to comment.