Add similar parameter to search/byterm

https://podcastindex.social/@dave/110548705233703606

Author: stevencrader

Postman Docs/PodcastIndex.postman_collection.json

@@ -109,6 +109,12 @@
 									"description": "If present, only non-explicit feeds will be returned. Meaning, feeds where the `itunes:explicit` flag is set to `false`.\n\nParameter shall not have a value\n",
 									"disabled": true
 								},
+								{
+									"key": "similar",
+									"value": "",
+									"description": "If present, include similar matches in search response. For `search/byterm`, prioritizes title matches.\n",
+									"disabled": true
+								},
 								{
 									"key": "fulltext",
 									"value": "",
@@ -124,7 +130,7 @@
 								{
 									"key": "similar",
 									"value": "",
-									"description": "If present, include similar matches in search response\n",
+									"description": "If present, include similar matches in search response. For `search/byterm`, prioritizes title matches.\n",
 									"disabled": true
 								}
 							]

api_src/components/parameters/similar.yaml

@@ -2,7 +2,7 @@ name: similar
 in: query
 # language=Markdown
 description: >
-  If present, include similar matches in search response
+  If present, include similar matches in search response. For `search/byterm`, prioritizes title matches.
 schema:
   type: boolean
 allowEmptyValue: true

api_src/paths/search/byterm.yaml

@@ -17,6 +17,7 @@ get:
     - $ref: '../../components/parameters/max.yaml'
     - $ref: '../../components/parameters/aponly.yaml'
     - $ref: '../../components/parameters/clean.yaml'
+    - $ref: '../../components/parameters/similar.yaml'
     - $ref: '../../components/parameters/fulltext.yaml'
     - $ref: '../../components/parameters/pretty.yaml'
   responses:

docs/pi_api.json

@@ -194,19 +194,19 @@
         },
         "allowEmptyValue": true
       },
-      "fulltext": {
-        "name": "fulltext",
+      "similar": {
+        "name": "similar",
         "in": "query",
-        "description": "If present, return the full text value of any text fields (ex: `description`). If not provided, field value is truncated to 100 words.\n\nParameter shall not have a value\n",
+        "description": "If present, include similar matches in search response. For `search/byterm`, prioritizes title matches.\n",
         "schema": {
           "type": "boolean"
         },
         "allowEmptyValue": true
       },
-      "similar": {
-        "name": "similar",
+      "fulltext": {
+        "name": "fulltext",
         "in": "query",
-        "description": "If present, include similar matches in search response\n",
+        "description": "If present, return the full text value of any text fields (ex: `description`). If not provided, field value is truncated to 100 words.\n\nParameter shall not have a value\n",
         "schema": {
           "type": "boolean"
         },
@@ -4057,6 +4057,9 @@
           {
             "$ref": "#/components/parameters/clean"
           },
+          {
+            "$ref": "#/components/parameters/similar"
+          },
           {
             "$ref": "#/components/parameters/fulltext"
           },

docs/pi_api.yaml

@@ -305,6 +305,15 @@ components:
       schema:
         type: boolean
       allowEmptyValue: true
+    similar:
+      name: similar
+      in: query
+      description: >
+        If present, include similar matches in search response. For
+        `search/byterm`, prioritizes title matches.
+      schema:
+        type: boolean
+      allowEmptyValue: true
     fulltext:
       name: fulltext
       in: query
@@ -317,14 +326,6 @@ components:
       schema:
         type: boolean
       allowEmptyValue: true
-    similar:
-      name: similar
-      in: query
-      description: |
-        If present, include similar matches in search response
-      schema:
-        type: boolean
-      allowEmptyValue: true
     q_person:
       name: q
       in: query
@@ -3568,6 +3569,7 @@ paths:
         - $ref: '#/components/parameters/max'
         - $ref: '#/components/parameters/aponly'
         - $ref: '#/components/parameters/clean'
+        - $ref: '#/components/parameters/similar'
         - $ref: '#/components/parameters/fulltext'
         - $ref: '#/components/parameters/pretty'
       responses: