Mention that nested fields are supported

ghga-de · Aug 5, 2024 · eb4d1db · eb4d1db
1 parent b046905
commit eb4d1db
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -317,11 +317,11 @@ The service requires the following configuration parameters:
 
   - **`description`** *(string, required)*: A brief description of the resource type.
 
-  - **`facetable_fields`** *(array)*: A list of the facetable fields for the resource type (leave empty to not use faceting). Default: `[]`.
+  - **`facetable_fields`** *(array)*: A list of the facetable fields for the resource type (leave empty to not use faceting, use dotted notation for nested fields). Default: `[]`.
 
     - **Items**: Refer to *[#/$defs/FieldLabel](#%24defs/FieldLabel)*.
 
-  - **`selected_fields`** *(array)*: A list of the returned fields for the resource type (leave empty to return all). Default: `[]`.
+  - **`selected_fields`** *(array)*: A list of the returned fields for the resource type (leave empty to return all, use dotted notation for nested fields). Default: `[]`.
 
     - **Items**: Refer to *[#/$defs/FieldLabel](#%24defs/FieldLabel)*.
 

diff --git a/config_schema.json b/config_schema.json
@@ -31,7 +31,7 @@
         },
         "facetable_fields": {
           "default": [],
-          "description": "A list of the facetable fields for the resource type (leave empty to not use faceting)",
+          "description": "A list of the facetable fields for the resource type (leave empty to not use faceting, use dotted notation for nested fields)",
           "items": {
             "$ref": "#/$defs/FieldLabel"
           },
@@ -40,7 +40,7 @@
         },
         "selected_fields": {
           "default": [],
-          "description": "A list of the returned fields for the resource type (leave empty to return all)",
+          "description": "A list of the returned fields for the resource type (leave empty to return all, use dotted notation for nested fields)",
           "items": {
             "$ref": "#/$defs/FieldLabel"
           },

diff --git a/openapi.yaml b/openapi.yaml
@@ -128,15 +128,15 @@ components:
         facetable_fields:
           default: []
           description: A list of the facetable fields for the resource type (leave
-            empty to not use faceting)
+            empty to not use faceting, use dotted notation for nested fields)
           items:
             $ref: '#/components/schemas/FieldLabel'
           title: Facetable Fields
           type: array
         selected_fields:
           default: []
           description: A list of the returned fields for the resource type (leave
-            empty to return all)
+            empty to return all, use dotted notation for nested fields)
           items:
             $ref: '#/components/schemas/FieldLabel'
           title: Selected Fields

diff --git a/src/mass/core/models.py b/src/mass/core/models.py
@@ -55,12 +55,12 @@ class SearchableClass(BaseModel):
     facetable_fields: list[FieldLabel] = Field(
         [],
         description="A list of the facetable fields for the resource type"
-        " (leave empty to not use faceting)",
+        " (leave empty to not use faceting, use dotted notation for nested fields)",
     )
     selected_fields: list[FieldLabel] = Field(
         [],
         description="A list of the returned fields for the resource type"
-        " (leave empty to return all)",
+        " (leave empty to return all, use dotted notation for nested fields)",
     )