feat: add search response type at root result

box · Jul 6, 2023 · 70197f8 · 70197f8
1 parent 728643e
commit 70197f8
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/content/responses/search_results.yml b/content/responses/search_results.yml
@@ -12,6 +12,14 @@ description: |-
 allOf:
   - $ref: "../attributes/search_result_collection.yml"
   - properties:
+      type:
+        description: |-
+          Specifies the response as search result items without shared links
+        type: string
+        example: search_results_items
+        enum:
+          - search_results_items
+        nullable: false
       entries:
         description: |-
           The search results for the query provided.

diff --git a/content/responses/search_results_with_shared_links.yml b/content/responses/search_results_with_shared_links.yml
@@ -17,6 +17,14 @@ description: |-
 allOf:
   - $ref: "../attributes/search_result_collection.yml"
   - properties:
+      type:
+        description: |-
+          Specifies the response as search result items with shared links
+        type: string
+        example: search_results_with_shared_links
+        enum:
+          - search_results_with_shared_links
+        nullable: false
       entries:
         description: |-
           The search results for the query provided, including the