From 83c816e2d1f2487ad6cb11aa9e13da4ec0128598 Mon Sep 17 00:00:00 2001 From: Manon Cassier <127942915+mcassier31@users.noreply.github.com> Date: Thu, 14 Sep 2023 15:02:57 +0200 Subject: [PATCH] details fields for query schema (#781) Co-authored-by: Divesh Pahuja --- .../01_Configuration/02_Schema_Settings.md | 33 ++++++++++++++++--- 1 file changed, 29 insertions(+), 4 deletions(-) diff --git a/doc/10_GraphQL/01_Configuration/02_Schema_Settings.md b/doc/10_GraphQL/01_Configuration/02_Schema_Settings.md index bcc84e61..e261438d 100644 --- a/doc/10_GraphQL/01_Configuration/02_Schema_Settings.md +++ b/doc/10_GraphQL/01_Configuration/02_Schema_Settings.md @@ -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. \ No newline at end of file +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. +