Tweak specs examples and default

bloomreach · Apr 2, 2024 · 695f927 · 695f927
1 parent 3221ae0
commit 695f927
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 9 deletions.
diff --git a/discovery/bestseller.yaml b/discovery/bestseller.yaml
@@ -47,7 +47,6 @@ paths:
             private authorization key. If you include your valid auth_key value
             in client-side calls, then you inadvertently expose that private
             information to everybody.
-          required: true
           example: "{{ auth_key }}"
           schema:
             type: string
@@ -88,8 +87,10 @@ paths:
             from your product feed may be used as a value for fl. <br><br>
             Multiple values should be comma separated, such as **fl=pid,price**.
           required: true
+          example: pid,url,description
           schema:
             type: string
+            default: pid,url,description
         - name: fq
           in: query
           description:
@@ -123,7 +124,7 @@ paths:
             error message. However, using a unique value allows us to help you
             if you encounter a problem.
           required: true
-          example: 1703497216731
+          example: 1234567891234
           schema:
             type: string
             default: 1703497216731
@@ -147,6 +148,7 @@ paths:
             limit this value to the number of items that you think is reasonable
             for a single page of search results.
           required: true
+          example: 10
           schema:
             type: integer
             format: int32
@@ -169,9 +171,11 @@ paths:
             first item on the first page is 0, making the start value also 0.
             <br><br> The maximum value is 10000.
           required: true
+          example: 0
           schema:
             type: integer
             format: int32
+            default: 0
         - name: title
           in: query
           description: The title or name of the product.

diff --git a/discovery/content-search.yaml b/discovery/content-search.yaml
@@ -22,7 +22,7 @@ paths:
             for every browser or device. <br><br> Use the default value
             provided, which is already encoded.
           required: true
-          example: "{{ _br_uid_2 }}"
+          example: "{{ br_uid_2 }}"
           schema:
             type: string
             default: uid%3D7797686432023%3Av%3D11.5%3Ats%3D1428617911187%3Ahc%3D55
@@ -48,7 +48,6 @@ paths:
             authorization key. If you include your valid auth_key value in
             client-side calls, then you inadvertently expose that private
             information to everybody.
-          required: true
           example: "{{ auth_key }}"
           schema:
             type: string

diff --git a/discovery/email_spec.yaml → discovery/email-spec.yaml b/discovery/email_spec.yaml → discovery/email-spec.yaml
@@ -554,6 +554,7 @@ components:
         unique, random values of 13 digits to enable click-tracking. The
         request_id is also important for debugging.
       required: false
+      example: 1234567891234
       schema:
         type: string
     view_id:
@@ -618,6 +619,7 @@ components:
         first item on the first page is 0, making the start value also 0. The
         maximum value is 10000.
       required: false
+      example: 3
       schema:
         type: integer
         default: 3

diff --git a/discovery/recommendations-pathways.yaml b/discovery/recommendations-pathways.yaml
@@ -80,6 +80,7 @@ paths:
             unique, random values of 13 digits to enable click-tracking.  The
             request_id is also important for debugging.
           required: true
+          example: 1234567891234
           schema:
             type: string
         - name: url
@@ -243,6 +244,7 @@ paths:
             unique, random values of 13 digits to enable click-tracking.  The
             request_id is also important for debugging.
           required: true
+          example: 1234567891234
           schema:
             type: string
         - name: url
@@ -330,9 +332,11 @@ paths:
             The number of the first item on a page of results. For example, the
             first item on the first page is 0, making the start value also 0.
             The maximum value is 10000.
+          example: 0
           schema:
             type: integer
             format: int32
+            default: 0
         - name: user_id
           in: query
           description:
@@ -437,6 +441,7 @@ paths:
             unique, random values of 13 digits to enable click-tracking.  The
             request_id is also important for debugging.
           required: true
+          example: 1234567891234
           schema:
             type: string
         - name: url
@@ -633,6 +638,7 @@ paths:
             unique, random values of 13 digits to enable click-tracking.  The
             request_id is also important for debugging.
           required: true
+          example: 1234567891234
           schema:
             type: string
         - name: url
@@ -785,6 +791,7 @@ paths:
             unique, random values of 13 digits to enable click-tracking.  The
             request_id is also important for debugging.
           required: true
+          example: 1234567891234
           schema:
             type: string
         - name: url
@@ -973,6 +980,7 @@ paths:
             An ID to track site visitor clicks. We recommend that you generate
             unique, random values of 13 digits to enable click-tracking.  The
             request_id is also important for debugging.
+          example: 1234567891234
           schema:
             type: string
         - name: view_id
@@ -1014,9 +1022,11 @@ paths:
             The number of the first item on a page of results. For example, the
             first item on the first page is 0, making the start value also 0.
             The maximum value is 10000.
+          example: 0
           schema:
             type: integer
             format: int32
+            default: 0
         - name: filter
           in: query
           description:

diff --git a/discovery/search-category.yaml b/discovery/search-category.yaml
@@ -20,7 +20,7 @@ paths:
             for every browser or device. <br><br> Use the default value
             provided, which is already encoded.
           required: true
-          example: "{{ br_uid }}"
+          example: "{{ br_uid_2 }}"
           schema:
             type: string
             default: uid%3D7797686432023%3Av%3D11.5%3Ats%3D1428617911187%3Ahc%3D55
@@ -48,7 +48,6 @@ paths:
             private authorization key. If you include your valid auth_key value
             in client-side calls, then you inadvertently expose that private
             information to everybody.
-          required: true
           example: "{{ auth_key }}"
           schema:
             type: string
@@ -177,10 +176,10 @@ paths:
             for fl. <br><br> Multiple values should be comma separated, such as
             **fl=pid,price**.
           required: true
-          example: pid
+          example: pid,url,description
           schema:
             type: string
-            default: pid
+            default: pid,url,description
         - name: fq
           in: query
           description:
@@ -258,7 +257,7 @@ paths:
             error message. However, using a unique value allows us to help you
             if you encounter a problem.
           required: false
-          example: test
+          example: 1234567891234
           schema:
             type: string
         - name: rows