Hackathon: Unify & complete criteria reference

docs/search/criteria_reference/ancestor_criterion.md

@@ -10,12 +10,18 @@
 
 - `value` - array of location pathStrings
 
+## Limitations
+
+`Ancestor` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
-$query->query = new Criterion\Ancestor([$this->locationService->loadLocation(62)->pathString]);
+```php
+$query->query = new Criterion\Ancestor([
+    $this->locationService->loadLocation(62)->pathString
+]);
 ```
 
 ### REST API
@@ -33,9 +39,14 @@
 === "JSON"
 
     ```json
-    "Query": {
-        "Filter": {
-            "AncestorCriterion": "/81/82/"
+    {
+        "ViewInput": {
+            "identifier": "AncestorCriterionTest",
+            "Query": {
+                "Filter": {
+                    "AncestorCriterion": "/81/82/"
+                }
+            }
         }
     }
     ```
@@ -44,9 +55,11 @@
 
 You can use the Ancestor Search Criterion to create a list of breadcrumbs leading to the Location:
 
-``` php hl_lines="2"
+```php hl_lines="2-4"
 $query = new LocationQuery();
-$query->query = new Criterion\Ancestor([$this->locationService->loadLocation($locationId)->pathString]);
+$query->query = new Criterion\Ancestor([
+    $this->locationService->loadLocation($locationId)->pathString
+]);
 
 $results = $this->searchService->findLocations($query);
 $breadcrumbs = [];
@@ -59,7 +72,7 @@
 ]);
 ```
 
-``` html+twig
+```html+twig
 {% for breadcrumb in breadcrumbs %}
     {% if not loop.first %} -> {% endif %}
     {% if not loop.last %}

docs/search/criteria_reference/contentid_criterion.md

@@ -10,11 +10,15 @@
 
 - `value` - int(s) representing the Content ID(s)
 
+## Limitations
+
+`ContentId` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\ContentId([62, 64]);
 ```
 
@@ -33,9 +37,14 @@
 === "JSON"
 
     ```json
-    "Query": {
-        "Filter": {
-            "ContentIdCriterion": [69, 72]
+    {
+        "ViewInput": {
+            "identifier": "ContentIdCriterionTest",
+            "Query": {
+                "Filter": {
+                    "ContentIdCriterion": [69, 72]
+                }
+            }
         }
     }
     ```

docs/search/criteria_reference/contentname_criterion.md

@@ -10,11 +10,15 @@
 
 - `value` - string representing the content name, the wildcard character `*` can be used for partial search
 
+## Limitations
+
+`ContentName` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\ContentName('*phone');
 ```
 
@@ -33,9 +37,14 @@
 === "JSON"
 
     ```json
-    "Query": {
-        "Filter": {
-            "ContentNameCriterion": "*phone"
+    {
+        "ViewInput": {
+            "identifier": "ContentNameCriterionTest",
+            "Query": {
+                "Filter": {
+                    "ContentNameCriterion": "*phone"
+                }
+            }
         }
     }
-    ```
+    ```

docs/search/criteria_reference/contenttypegroupid_criterion.md

@@ -10,11 +10,15 @@
 
 - `value` - int(s) representing the content type group ID(s)
 
+## Limitations
+
+`ContentTypeGroupId` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\ContentTypeGroupId([1, 2]);
 ```
 
@@ -33,9 +37,14 @@
 === "JSON"
 
     ```json
-    "Query": {
-        "Filter": {
-            "ContentTypeGroupIdCriterion": [1, 2]
+    {
+        "ViewInput": {
+            "identifier": "ContentTypeGroupIdCriterionTest",
+            "Query": {
+                "Filter": {
+                    "ContentTypeGroupIdCriterion": [1, 2]
+                }
+            }
         }
     }
     ```
@@ -71,9 +80,14 @@
 === "JSON"
 
     ```json
-    "Query": {
-        "Filter": {
-            "ContentIdCriterion": [69, 72]
+    {
+        "ViewInput": {
+            "identifier": "ContentIdCriterionTest",
+            "Query": {
+                "Filter": {
+                    "ContentIdCriterion": [69, 72]
+                }
             }
         }
+    }
     ```

docs/search/criteria_reference/contenttypeid_criterion.md

@@ -10,11 +10,15 @@
 
 - `value` - int(s) representing the content type ID(s)
 
+## Limitations
+
+`ContentTypeId` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\ContentTypeId([44]);
 ```
 
@@ -33,9 +37,14 @@
 === "JSON"
 
     ```json
-    "Query": {
-        "Filter": {
-            "ContentTypeIdCriterion": 44
+    {
+        "ViewInput": {
+            "identifier": "ContentTypeIdCriterionTest",
+            "Query": {
+                "Filter": {
+                    "ContentTypeIdCriterion": 44
+                }
+            }
         }
     }
     ```

docs/search/criteria_reference/contenttypeidentifier_criterion.md

@@ -10,11 +10,15 @@
 
 - `value` - string(s) representing the content type identifier(s)
 
+## Limitations
+
+`ContentTypeIdentifier` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\ContentTypeIdentifier(['article', 'blog_post']);
 ```
 
@@ -33,9 +37,14 @@
 === "JSON"
 
     ```json
-    "Query": {
-        "Filter": {
-            "ContentTypeIdentifierCriterion": "article"
+    {
+        "ViewInput": {
+            "identifier": "ContentTypeIdentifierCriterionTest",
+            "Query": {
+                "Filter": {
+                    "ContentTypeIdentifierCriterion": "article"
+                }
+            }
         }
     }
     ```

docs/search/criteria_reference/currencycode_criterion.md

@@ -18,6 +18,6 @@ The `CurrencyCodeCriterion` Criterion isn't available in Solr or Elasticsearch e
 
 ### PHP
 
-``` php
+```php
 $query->query = new \Ibexa\Contracts\ProductCatalog\Values\Currency\Query\Criterion\CurrencyCodeCriterion('EUR');
 ```

docs/search/criteria_reference/customergroupid_criterion.md

@@ -10,10 +10,14 @@
 
 - `value` - int(s) representing the customer group ID(s)
 
+## Limitations
+
+`CustomerGroupId` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\CustomerGroupId(1);
 ```

docs/search/criteria_reference/datemetadata_criterion.md

@@ -12,11 +12,15 @@
 - `operator` - Operator constant (IN, EQ, GT, GTE, LT, LTE, BETWEEN)
 - `value` - indicating the date(s) that should be matched, provided as a UNIX timestamp (or array of timestamps)
 
+## Limitations
+
+`DateMetadata` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\DateMetadata(
     Criterion\DateMetadata::CREATED,
     Criterion\Operator::BETWEEN,
@@ -43,15 +47,20 @@
 === "JSON"
 
     ```json
-        "Query": {
-            "Filter": {
-                "DateMetadataCriterion": {
-                    "Target": "modified",
-                    "Value": 1675681020,
-                    "Operator": "gte"
+    {
+        "ViewInput": {
+            "identifier": "DateMetadataCriterionTest",
+            "Query": {
+                "Filter": {
+                    "DateMetadataCriterion": {
+                        "Target": "modified",
+                        "Value": 1675681020,
+                        "Operator": "gte"
+                    }
                 }
             }
         }
+    }
     ```
 
 

docs/search/criteria_reference/depth_criterion.md

@@ -19,10 +19,14 @@
 - exactly two ints for `Operator::BETWEEN`
 - a single int for other Operators
 
+## Limitations
+
+`Depth` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\Location\Depth(Criterion\Operator::LT, 3);
 ```

docs/search/criteria_reference/field_criterion.md

@@ -21,12 +21,11 @@ Querying for a collection with the `EQ` operator returns result only when the wh
 
 The `Field` Criterion isn't available in [Repository filtering](search_api.md#repository-filtering).
 
-
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\Field('name', Criterion\Operator::CONTAINS, 'Platform');
 ```
 
@@ -50,12 +49,15 @@ $query->query = new Criterion\Field('name', Criterion\Operator::CONTAINS, 'Platf
 
     ```json
     {
-        "Query": {
-            "Filter": {
-                "Field": {
-                    "name": "name",
-                    "operator": "CONTAINS",
-                    "value": "Platform"
+        "ViewInput": {
+            "identifier": "FieldTest",
+            "Query": {
+                "Filter": {
+                    "Field": {
+                        "name": "name",
+                        "operator": "CONTAINS",
+                        "value": "Platform"
+                    }
                 }
             }
         }

docs/search/criteria_reference/fieldrelation_criterion.md

@@ -22,6 +22,6 @@ The `FieldRelation` Criterion isn't available in [Repository filtering](search_a
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\FieldRelation('relations', Criterion\Operator::CONTAINS, [55, 63]);
 ```