docs(scope): fix REST and GQL examples. Refs: #677

FgForrest · Dec 3, 2024 · 2c6d60c · 2c6d60c
1 parent d1db4fe
commit 2c6d60c
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 29 deletions.
diff --git a/documentation/user/en/get-started/example/define-schema-for-catalog.graphql b/documentation/user/en/get-started/example/define-schema-for-catalog.graphql
@@ -30,8 +30,8 @@ mutation {
                 name: "name"
                 type: String
                 description: "The apt brand name."
-                filterable: true
-                sortable: true
+                filterableInScopes: [LIVE]
+                sortableInScopes: [LIVE]
               }
             }
           ]
@@ -54,7 +54,8 @@ mutation {
                 withGeneratedPrimaryKey: false
               }
               setEntitySchemaWithHierarchyMutation: {
-                withHierarchy: true
+                withHierarchy: true,
+                indexedInScopes: [LIVE]
               }
               allowLocaleInEntitySchemaMutation: {
                 locales: ["en", "de"]
@@ -64,8 +65,8 @@ mutation {
                 type: String
                 description: "The apt category name."
                 localized: true
-                filterable: true
-                sortable: true
+                filterableInScopes: [LIVE]
+                sortableInScopes: [LIVE]
               }
             }
           ]
@@ -104,8 +105,8 @@ mutation {
                 type: String
                 description: "The apt brand name."
                 localized: true
-                filterable: true
-                sortable: true
+                filterableInScopes: [LIVE]
+                sortableInScopes: [LIVE]
                 nullable: true
               }
             },
@@ -114,8 +115,8 @@ mutation {
                 name: "catalogCode"
                 type: String
                 description: "Product designation in your sales catalogue."
-                filterable: true
-                sortable: true
+                filterableInScopes: [LIVE]
+                sortableInScopes: [LIVE]
                 nullable: true
               }
             },
@@ -124,8 +125,8 @@ mutation {
                 name: "stockQuantity"
                 type: Integer
                 description: "Number of pieces in stock."
-                filterable: true
-                sortable: true
+                filterableInScopes: [LIVE]
+                sortableInScopes: [LIVE]
                 defaultValue: 0
               }
             },
@@ -144,8 +145,8 @@ mutation {
                 referencedEntityTypeManaged: true
                 cardinality: ZERO_OR_ONE
                 description: "Reference to the brand or manufacturer of the product."
-                indexed: true
-                faceted: true
+                indexedInScopes: [LIVE]
+                facetedInScopes: [LIVE]
               }
             },
             {
@@ -155,7 +156,7 @@ mutation {
                 referencedEntityTypeManaged: true
                 cardinality: ZERO_OR_MORE
                 description: "Reference to one or more categories the product is listed in."
-                indexed: true
+                indexedInScopes: [LIVE]
               }
             }
           ]

diff --git a/documentation/user/en/get-started/example/define-schema-for-catalog.rest b/documentation/user/en/get-started/example/define-schema-for-catalog.rest
@@ -31,8 +31,8 @@ PUT /rest/evita/schema
               "name": "name",
               "type": "String",
               "description": "The apt brand name.",
-              "filterable": true,
-              "sortable": true
+              "filterableInScopes": ["LIVE"],
+              "sortableInScopes": ["LIVE"]
             }
           }
         ]
@@ -55,7 +55,8 @@ PUT /rest/evita/schema
               "withGeneratedPrimaryKey": false
             },
             "setEntitySchemaWithHierarchyMutation": {
-              "withHierarchy": true
+              "withHierarchy": true,
+              "indexedInScopes": ["LIVE"]
             },
             "allowLocaleInEntitySchemaMutation": {
               "locales": ["en", "de"]
@@ -65,8 +66,8 @@ PUT /rest/evita/schema
               "type": "String",
               "description": "The apt category name.",
               "localized": true,
-              "filterable": true,
-              "sortable": true
+              "filterableInScopes": ["LIVE"],
+              "sortableInScopes": ["LIVE"]
             }
           }
         ]
@@ -105,8 +106,8 @@ PUT /rest/evita/schema
               "type": "String",
               "description": "The apt brand name.",
               "localized": true,
-              "filterable": true,
-              "sortable": true,
+              "filterableInScopes": ["LIVE"],
+              "sortableInScopes": ["LIVE"],
               "nullable": true
             }
           },
@@ -115,8 +116,8 @@ PUT /rest/evita/schema
               "name": "catalogCode",
               "type": "String",
               "description": "Product designation in your sales catalogue.",
-              "filterable": true,
-              "sortable": true,
+              "filterableInScopes": ["LIVE"],
+              "sortableInScopes": ["LIVE"],
               "nullable": true
             }
           },
@@ -125,8 +126,8 @@ PUT /rest/evita/schema
               "name": "stockQuantity",
               "type": "Integer",
               "description": "Number of pieces in stock.",
-              "filterable": true,
-              "sortable": true,
+              "filterableInScopes": ["LIVE"],
+              "sortableInScopes": ["LIVE"],
               "defaultValue": 0
             }
           },
@@ -145,8 +146,8 @@ PUT /rest/evita/schema
               "referencedEntityTypeManaged": true,
               "cardinality": "ZERO_OR_ONE",
               "description": "Reference to the brand or manufacturer of the product.",
-              "indexed": true,
-              "faceted": true
+              "indexedInScopes": ["LIVE"],
+              "facetedInScopes": ["LIVE"]
             }
           },
           {
@@ -156,7 +157,7 @@ PUT /rest/evita/schema
               "referencedEntityTypeManaged": true,
               "cardinality": "ZERO_OR_MORE",
               "description": "Reference to one or more categories the product is listed in.",
-              "indexed": true
+              "indexedInScopes": ["LIVE"]
             }
           }
         ]

diff --git a/evita_functional_tests/src/test/java/io/evitadb/documentation/UserDocumentationTest.java b/evita_functional_tests/src/test/java/io/evitadb/documentation/UserDocumentationTest.java
@@ -451,7 +451,7 @@ Stream<DynamicNode> testDocumentation() throws IOException {
 	Stream<DynamicTest> testSingleFileDocumentation() {
 		return this.createTests(
 			Environment.DEMO_SERVER,
-			getRootDirectory().resolve("documentation/user/en/use/connectors/grpc.md"),
+			getRootDirectory().resolve("documentation/user/en/get-started/create-first-database.md"),
 			new ExampleFilter[]{
 				ExampleFilter.CSHARP,
 				ExampleFilter.JAVA,