Add podcastguid option to episodes/byguid

Also adds `podcastGuid` to response for `episodes/byguid`

Author: stevencrader

Postman Docs/PodcastIndex.postman_collection.json

@@ -830,6 +830,12 @@
 									"description": "The Feed URL\n",
 									"disabled": true
 								},
+								{
+									"key": "podcastguid",
+									"value": "917393e3-1b1e-5cef-ace4-edaa54e1f810",
+									"description": "The GUID from the `podcast:guid` tag in the feed. This value is a unique, global identifier for the podcast.\n\nSee the namespace spec for\n[guid](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid) for details.",
+									"disabled": true
+								},
 								{
 									"key": "fulltext",
 									"value": "",

api_src/components/parameters/podcastguid_optional.yaml

@@ -0,0 +1,12 @@
+name: podcastguid
+in: query
+# language=Markdown
+description: |
+  The GUID from the `podcast:guid` tag in the feed. This value is a unique, global identifier for the podcast.
+
+
+  See the namespace spec for
+  [guid](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid) for details.
+schema:
+  type: string
+example: "917393e3-1b1e-5cef-ace4-edaa54e1f810"

api_src/components/responses/episodes_byguid.yaml

@@ -10,6 +10,8 @@ content:
           $ref: '../properties/feedid_query.yaml'
         url:
           $ref: '../properties/feedurl_query.yaml'
+        podcastGuid:
+          $ref: '../properties/podcastguid.yaml'
         guid:
           $ref: '../properties/guid_query.yaml'
         episode:

api_src/paths/episodes/byguid.yaml

@@ -7,7 +7,7 @@ get:
     Get all the metadata for a single episode by passing its guid and the feed id or URL.
 
 
-    The `feedid` or the `feedurl` is required.
+    The `feedid`, `feedurl`, or `podcastguid` is required.
 
 
     Examples: 
@@ -21,6 +21,7 @@ get:
     - $ref: '../../components/parameters/guid_episode.yaml'
     - $ref: '../../components/parameters/feedurl.yaml'
     - $ref: '../../components/parameters/feedid.yaml'
+    - $ref: '../../components/parameters/podcastguid_optional.yaml'
     - $ref: '../../components/parameters/fulltext.yaml'
     - $ref: '../../components/parameters/pretty.yaml'
   responses:

docs/pi_api.json

@@ -903,7 +903,7 @@
           "Episodes"
         ],
         "summary": "By GUID",
-        "description": "Get all the metadata for a single episode by passing its guid and the feed id or URL.\n\n\nThe `feedid` or the `feedurl` is required.\n\n\nExamples: \n\n  - Search using Podcast Index feed ID: https://api.podcastindex.org/api/1.0/episodes/byguid?guid=PC2084&feedid=920666&pretty\n  - Search using feed URL: https://api.podcastindex.org/api/1.0/episodes/byguid?guid=PC2084&feedurl=http://mp3s.nashownotes.com/pc20rss.xml&pretty\n",
+        "description": "Get all the metadata for a single episode by passing its guid and the feed id or URL.\n\n\nThe `feedid`, `feedurl`, or `podcastguid` is required.\n\n\nExamples: \n\n  - Search using Podcast Index feed ID: https://api.podcastindex.org/api/1.0/episodes/byguid?guid=PC2084&feedid=920666&pretty\n  - Search using feed URL: https://api.podcastindex.org/api/1.0/episodes/byguid?guid=PC2084&feedurl=http://mp3s.nashownotes.com/pc20rss.xml&pretty\n",
         "operationId": "episodes/byguid",
         "security": [
           {
@@ -923,6 +923,9 @@
           {
             "$ref": "#/components/parameters/feedid"
           },
+          {
+            "$ref": "#/components/parameters/podcastguid_optional"
+          },
           {
             "$ref": "#/components/parameters/fulltext"
           },
@@ -2112,6 +2115,15 @@
         },
         "example": "920666"
       },
+      "podcastguid_optional": {
+        "name": "podcastguid",
+        "in": "query",
+        "description": "The GUID from the `podcast:guid` tag in the feed. This value is a unique, global identifier for the podcast.\n\n\nSee the namespace spec for\n[guid](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid) for details.\n",
+        "schema": {
+          "type": "string"
+        },
+        "example": "917393e3-1b1e-5cef-ace4-edaa54e1f810"
+      },
       "max_random": {
         "name": "max",
         "in": "query",
@@ -5465,6 +5477,9 @@
                 "url": {
                   "$ref": "#/components/schemas/feedurl_query"
                 },
+                "podcastGuid": {
+                  "$ref": "#/components/schemas/podcastguid"
+                },
                 "guid": {
                   "$ref": "#/components/schemas/guid_query"
                 },

docs/pi_api.yaml

@@ -884,7 +884,7 @@ paths:
         Get all the metadata for a single episode by passing its guid and the feed id or URL.
 
 
-        The `feedid` or the `feedurl` is required.
+        The `feedid`, `feedurl`, or `podcastguid` is required.
 
 
         Examples: 
@@ -901,6 +901,7 @@ paths:
         - $ref: '#/components/parameters/guid_episode'
         - $ref: '#/components/parameters/feedurl'
         - $ref: '#/components/parameters/feedid'
+        - $ref: '#/components/parameters/podcastguid_optional'
         - $ref: '#/components/parameters/fulltext'
         - $ref: '#/components/parameters/pretty'
       responses:
@@ -1980,6 +1981,18 @@ components:
       schema:
         type: string
       example: '920666'
+    podcastguid_optional:
+      name: podcastguid
+      in: query
+      description: |
+        The GUID from the `podcast:guid` tag in the feed. This value is a unique, global identifier for the podcast.
+
+
+        See the namespace spec for
+        [guid](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#guid) for details.
+      schema:
+        type: string
+      example: 917393e3-1b1e-5cef-ace4-edaa54e1f810
     max_random:
       name: max
       in: query
@@ -4762,6 +4775,8 @@ components:
                 $ref: '#/components/schemas/feedid_query'
               url:
                 $ref: '#/components/schemas/feedurl_query'
+              podcastGuid:
+                $ref: '#/components/schemas/podcastguid'
               guid:
                 $ref: '#/components/schemas/guid_query'
               episode:

package.json

@@ -3,7 +3,7 @@
   "version": "1.11.0",
   "private": true,
   "devDependencies": {
-    "@redocly/cli": "^1.0.2",
+    "@redocly/cli": "^1.1.0",
     "copyfiles": "^2.4.1",
     "http-server": "^14.1.1",
     "livereload": "^0.9.3"