Add podcast-valueTimeSplit parameter to /podcasts/bytag

stevencrader · stevencrader · commit 18a869eafec9 · 2023-10-22T22:38:55.000-07:00
https://podcastindex.social/@dave/111250186996313754
diff --git a/Postman Docs/PodcastIndex.postman_collection.json b/Postman Docs/PodcastIndex.postman_collection.json
@@ -397,7 +397,13 @@
 								{
 									"key": "podcast-value",
 									"value": "",
-									"description": "(Required) Get feeds supporting the `value` tag.\n\nParameter shall not have a value\n"
+									"description": "Get feeds supporting the [`podcast:value`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value) tag.\n\nParameter shall not have a value\n"
+								},
+								{
+									"key": "podcast-valueTimeSplit",
+									"value": "",
+									"description": "Get feeds supporting the [`podcast:valueTimeSplit`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value-time-split) tag.\n\nParameter shall not have a value\n",
+									"disabled": true
 								},
 								{
 									"key": "max",
@@ -418,7 +424,7 @@
 								}
 							]
 						},
-						"description": "This call returns all feeds that support the specified\n[podcast namespace](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md) tag.\n\nThe only supported tag is `podcast:value` using the `podcast-value` parameter.\n\nWhen called without a `start_at` value, the top 500 feeds sorted by popularity are returned in descending order.\n\n\nWhen called with a `start_at` value, the feeds are returned sorted by the `feedId` starting with the specified value\nup to the max number of feeds to return. The `nextStartAt` specifies the value to pass to the next `start_at`.\nRepeat this sequence until no items are returned.\n\n\nExamples:\n  - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-value&max=200&pretty\n  - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-value&max=200&start_at=1&pretty"
+						"description": "This call returns all feeds that support the specified\n[podcast namespace](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md) tag.\n\nThe only supported tags are:\n  - `podcast:value` using the `podcast-value` parameter\n  - `podcast:valueTimeSplit` using the `podcast-valueTimeSplit` parameter\n\nOnly the `podcast-value` or `podcast-valueTimeSplit` parameter should be used. If multiple are specified, the\nfirst parameter is used and the others are ignored.\n\nWhen called without a `start_at` value, the top 500 feeds sorted by popularity are returned in descending order.\n\nWhen called with a `start_at` value, the feeds are returned sorted by the `feedId` starting with the specified value\nup to the max number of feeds to return. The `nextStartAt` specifies the value to pass to the next `start_at`.\nRepeat this sequence until no items are returned.\n\nExamples:\n  - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-value&max=200&pretty\n  - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-value&max=200&start_at=1&pretty\n  - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-valueTimeSplit&pretty"
 					},
 					"response": []
 				},
diff --git a/api_src/components/parameters/podcast-value.yaml b/api_src/components/parameters/podcast-value.yaml
@@ -2,11 +2,11 @@ name: podcast-value
 in: query
 # language=Markdown
 description: |
-  Get feeds supporting the `value` tag.
+  Get feeds supporting the [`podcast:value`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value) tag.
 
 
   Parameter shall not have a value
 schema:
   type: boolean
 allowEmptyValue: true
-required: true
+required: false
diff --git a/api_src/components/parameters/podcast-valueTimeSplit.yaml b/api_src/components/parameters/podcast-valueTimeSplit.yaml
@@ -0,0 +1,12 @@
+name: podcast-valueTimeSplit
+in: query
+# language=Markdown
+description: |
+  Get feeds supporting the [`podcast:valueTimeSplit`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value-time-split) tag.
+
+
+  Parameter shall not have a value
+schema:
+  type: boolean
+allowEmptyValue: true
+required: false
diff --git a/api_src/paths/podcasts/bytag.yaml b/api_src/paths/podcasts/bytag.yaml
@@ -8,7 +8,13 @@ get:
     [podcast namespace](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md) tag.
 
 
-    The only supported tag is `podcast:value` using the `podcast-value` parameter.
+    The only supported tags are:
+      - `podcast:value` using the `podcast-value` parameter
+      - `podcast:valueTimeSplit` using the `podcast-valueTimeSplit` parameter
+
+
+    Only the `podcast-value` or `podcast-valueTimeSplit` parameter should be used. If multiple are specified, the
+    first parameter is used and the others are ignored.
 
 
     When called without a `start_at` value, the top 500 feeds sorted by popularity are returned in descending order.
@@ -22,11 +28,13 @@ get:
     Examples:
       - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-value&max=200&pretty
       - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-value&max=200&start_at=1&pretty
+      - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-valueTimeSplit&pretty
   operationId: podcasts/bytag
   security:
     - $ref: '../../components/security/security.yaml'
   parameters:
     - $ref: '../../components/parameters/podcast-value.yaml'
+    - $ref: '../../components/parameters/podcast-valueTimeSplit.yaml'
     - $ref: '../../components/parameters/max_5000.yaml'
     - $ref: '../../components/parameters/start_at.yaml'
     - $ref: '../../components/parameters/pretty.yaml'
diff --git a/api_src/root.yaml b/api_src/root.yaml
@@ -1,6 +1,6 @@
 openapi: 3.0.2
 info:
-  version: 1.11.0
+  version: 1.12.0
   title: PodcastIndex.org API
   termsOfService: 'https://github.com/Podcastindex-org/legal/blob/main/TermsOfService.md'
   contact:
diff --git a/docs/pi_api.json b/docs/pi_api.json
@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.2",
   "info": {
-    "version": "1.11.0",
+    "version": "1.12.0",
     "title": "PodcastIndex.org API",
     "termsOfService": "https://github.com/Podcastindex-org/legal/blob/main/TermsOfService.md",
     "contact": {
@@ -507,7 +507,7 @@
           "Podcasts"
         ],
         "summary": "By Tag",
-        "description": "This call returns all feeds that support the specified\n[podcast namespace](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md) tag.\n\n\nThe only supported tag is `podcast:value` using the `podcast-value` parameter.\n\n\nWhen called without a `start_at` value, the top 500 feeds sorted by popularity are returned in descending order.\n\n\nWhen called with a `start_at` value, the feeds are returned sorted by the `feedId` starting with the specified value\nup to the max number of feeds to return. The `nextStartAt` specifies the value to pass to the next `start_at`.\nRepeat this sequence until no items are returned.\n\n\nExamples:\n  - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-value&max=200&pretty\n  - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-value&max=200&start_at=1&pretty\n",
+        "description": "This call returns all feeds that support the specified\n[podcast namespace](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md) tag.\n\n\nThe only supported tags are:\n  - `podcast:value` using the `podcast-value` parameter\n  - `podcast:valueTimeSplit` using the `podcast-valueTimeSplit` parameter\n\n\nOnly the `podcast-value` or `podcast-valueTimeSplit` parameter should be used. If multiple are specified, the\nfirst parameter is used and the others are ignored.\n\n\nWhen called without a `start_at` value, the top 500 feeds sorted by popularity are returned in descending order.\n\n\nWhen called with a `start_at` value, the feeds are returned sorted by the `feedId` starting with the specified value\nup to the max number of feeds to return. The `nextStartAt` specifies the value to pass to the next `start_at`.\nRepeat this sequence until no items are returned.\n\n\nExamples:\n  - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-value&max=200&pretty\n  - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-value&max=200&start_at=1&pretty\n  - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-valueTimeSplit&pretty\n",
         "operationId": "podcasts/bytag",
         "security": [
           {
@@ -521,6 +521,9 @@
           {
             "$ref": "#/components/parameters/podcast-value"
           },
+          {
+            "$ref": "#/components/parameters/podcast-valueTimeSplit"
+          },
           {
             "$ref": "#/components/parameters/max_5000"
           },
@@ -1913,12 +1916,22 @@
       "podcast-value": {
         "name": "podcast-value",
         "in": "query",
-        "description": "Get feeds supporting the `value` tag.\n\n\nParameter shall not have a value\n",
+        "description": "Get feeds supporting the [`podcast:value`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value) tag.\n\n\nParameter shall not have a value\n",
+        "schema": {
+          "type": "boolean"
+        },
+        "allowEmptyValue": true,
+        "required": false
+      },
+      "podcast-valueTimeSplit": {
+        "name": "podcast-valueTimeSplit",
+        "in": "query",
+        "description": "Get feeds supporting the [`podcast:valueTimeSplit`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value-time-split) tag.\n\n\nParameter shall not have a value\n",
         "schema": {
           "type": "boolean"
         },
         "allowEmptyValue": true,
-        "required": true
+        "required": false
       },
       "max_5000": {
         "name": "max",
diff --git a/docs/pi_api.yaml b/docs/pi_api.yaml
@@ -1,6 +1,6 @@
 openapi: 3.0.2
 info:
-  version: 1.11.0
+  version: 1.12.0
   title: PodcastIndex.org API
   termsOfService: https://github.com/Podcastindex-org/legal/blob/main/TermsOfService.md
   contact:
@@ -589,7 +589,13 @@ paths:
         [podcast namespace](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md) tag.
 
 
-        The only supported tag is `podcast:value` using the `podcast-value` parameter.
+        The only supported tags are:
+          - `podcast:value` using the `podcast-value` parameter
+          - `podcast:valueTimeSplit` using the `podcast-valueTimeSplit` parameter
+
+
+        Only the `podcast-value` or `podcast-valueTimeSplit` parameter should be used. If multiple are specified, the
+        first parameter is used and the others are ignored.
 
 
         When called without a `start_at` value, the top 500 feeds sorted by popularity are returned in descending order.
@@ -603,6 +609,7 @@ paths:
         Examples:
           - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-value&max=200&pretty
           - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-value&max=200&start_at=1&pretty
+          - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-valueTimeSplit&pretty
       operationId: podcasts/bytag
       security:
         - API-Key: []
@@ -611,6 +618,7 @@ paths:
           Authorization: []
       parameters:
         - $ref: '#/components/parameters/podcast-value'
+        - $ref: '#/components/parameters/podcast-valueTimeSplit'
         - $ref: '#/components/parameters/max_5000'
         - $ref: '#/components/parameters/start_at'
         - $ref: '#/components/parameters/pretty'
@@ -1759,14 +1767,26 @@ components:
       name: podcast-value
       in: query
       description: |
-        Get feeds supporting the `value` tag.
+        Get feeds supporting the [`podcast:value`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value) tag.
 
 
         Parameter shall not have a value
       schema:
         type: boolean
       allowEmptyValue: true
-      required: true
+      required: false
+    podcast-valueTimeSplit:
+      name: podcast-valueTimeSplit
+      in: query
+      description: |
+        Get feeds supporting the [`podcast:valueTimeSplit`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value-time-split) tag.
+
+
+        Parameter shall not have a value
+      schema:
+        type: boolean
+      allowEmptyValue: true
+      required: false
     max_5000:
       name: max
       in: query
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "pi_api_docs",
-  "version": "1.11.0",
+  "version": "1.12.0",
   "private": true,
   "devDependencies": {
     "@redocly/cli": "^1.3.0",

Original file line number	Diff line number	Diff line change
`@@ -397,7 +397,13 @@`
`397`	`397`	`{`
`398`	`398`	`"key": "podcast-value",`
`399`	`399`	`"value": "",`
`400`		- "description": "(Required) Get feeds supporting the `value` tag.\n\nParameter shall not have a value\n"
	`400`	+ "description": "Get feeds supporting the [`podcast:value`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value) tag.\n\nParameter shall not have a value\n"
	`401`	`+ },`
	`402`	`+ {`
	`403`	`+ "key": "podcast-valueTimeSplit",`
	`404`	`+ "value": "",`
	`405`	+ "description": "Get feeds supporting the [`podcast:valueTimeSplit`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value-time-split) tag.\n\nParameter shall not have a value\n",
	`406`	`+ "disabled": true`
`401`	`407`	`},`
`402`	`408`	`{`
`403`	`409`	`"key": "max",`
`@@ -418,7 +424,7 @@`
`418`	`424`	`}`
`419`	`425`	`]`
`420`	`426`	`},`
`421`		- "description": "This call returns all feeds that support the specified\n[podcast namespace](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md) tag.\n\nThe only supported tag is `podcast:value` using the `podcast-value` parameter.\n\nWhen called without a `start_at` value, the top 500 feeds sorted by popularity are returned in descending order.\n\n\nWhen called with a `start_at` value, the feeds are returned sorted by the `feedId` starting with the specified value\nup to the max number of feeds to return. The `nextStartAt` specifies the value to pass to the next `start_at`.\nRepeat this sequence until no items are returned.\n\n\nExamples:\n - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-value&max=200&pretty\n - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-value&max=200&start_at=1&pretty"
	`427`	+ "description": "This call returns all feeds that support the specified\n[podcast namespace](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md) tag.\n\nThe only supported tags are:\n - `podcast:value` using the `podcast-value` parameter\n - `podcast:valueTimeSplit` using the `podcast-valueTimeSplit` parameter\n\nOnly the `podcast-value` or `podcast-valueTimeSplit` parameter should be used. If multiple are specified, the\nfirst parameter is used and the others are ignored.\n\nWhen called without a `start_at` value, the top 500 feeds sorted by popularity are returned in descending order.\n\nWhen called with a `start_at` value, the feeds are returned sorted by the `feedId` starting with the specified value\nup to the max number of feeds to return. The `nextStartAt` specifies the value to pass to the next `start_at`.\nRepeat this sequence until no items are returned.\n\nExamples:\n - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-value&max=200&pretty\n - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-value&max=200&start_at=1&pretty\n - https://api.podcastindex.org/api/1.0/podcasts/bytag?podcast-valueTimeSplit&pretty"
`422`	`428`	`},`
`423`	`429`	`"response": []`
`424`	`430`	`},`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "pi_api_docs",`
`3`		`- "version": "1.11.0",`
	`3`	`+ "version": "1.12.0",`
`4`	`4`	`"private": true,`
`5`	`5`	`"devDependencies": {`
`6`	`6`	`"@redocly/cli": "^1.3.0",`