Skip to content

Commit e087909

Browse files
stevencraderstevencrader
committed
Add description of enclosure parameter for episodes/byfeedid and episodes/byitunesid
https://podcastindex.social/@dave/109954913911423061
1 parent c3ad2db commit e087909

File tree

6 files changed

+82
-11
lines changed

6 files changed

+82
-11
lines changed

‎Postman Docs/PodcastIndex.postman_collection.json‎

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -519,7 +519,7 @@
519519
"method": "GET",
520520
"header": [],
521521
"url": {
522-
"raw": "{{baseUrl}}/episodes/byfeedid?id=75075",
522+
"raw": "{{baseUrl}}/episodes/byfeedid?id=41504",
523523
"host": [
524524
"{{baseUrl}}"
525525
],
@@ -530,7 +530,7 @@
530530
"query": [
531531
{
532532
"key": "id",
533-
"value": "75075",
533+
"value": "41504",
534534
"description": "(Required) The PodcastIndex Feed ID or IDs to search for.\n\nIf searching for multiple IDs, separate values with a comma. A maximum of 200 IDs can be provided.\n"
535535
},
536536
{
@@ -545,6 +545,12 @@
545545
"description": "Maximum number of results to return.\n",
546546
"disabled": true
547547
},
548+
{
549+
"key": "enclosure",
550+
"value": "https://op3.dev/e/mp3s.nashownotes.com/NA-1551-2023-04-30-Final.mp3",
551+
"description": "The URL for the episode enclosure to get the information for.\n",
552+
"disabled": true
553+
},
548554
{
549555
"key": "fulltext",
550556
"value": "",
@@ -559,7 +565,7 @@
559565
}
560566
]
561567
},
562-
"description": "This call returns all the episodes we know about for this feed from the PodcastIndex ID. Episodes are in reverse chronological order.\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=75075&pretty\n - https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=41504,920666&pretty\n - Includes `persons`: https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=169991&pretty\n"
568+
"description": "This call returns all the episodes we know about for this feed from the PodcastIndex ID.\nEpisodes are in reverse chronological order.\n\nWhen using the `enclosure` parameter, only the episode matching the URL is returned.\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=75075&pretty\n - https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=41504,920666&pretty\n - Includes `persons`: https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=169991&pretty\n - Includes `value`: https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=4058673&pretty\n - Using `enclosure`: https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=41504&enclosure=https://op3.dev/e/mp3s.nashownotes.com/NA-1551-2023-04-30-Final.mp3&pretty\n"
563569
},
564570
"response": []
565571
},
@@ -669,7 +675,7 @@
669675
"method": "GET",
670676
"header": [],
671677
"url": {
672-
"raw": "{{baseUrl}}/episodes/byitunesid?id=1441923632",
678+
"raw": "{{baseUrl}}/episodes/byitunesid?id=269169796",
673679
"host": [
674680
"{{baseUrl}}"
675681
],
@@ -680,7 +686,7 @@
680686
"query": [
681687
{
682688
"key": "id",
683-
"value": "1441923632",
689+
"value": "269169796",
684690
"description": "(Required) The iTunes Feed ID to search for\n"
685691
},
686692
{
@@ -695,6 +701,12 @@
695701
"description": "Maximum number of results to return.\n",
696702
"disabled": true
697703
},
704+
{
705+
"key": "enclosure",
706+
"value": "https://op3.dev/e/mp3s.nashownotes.com/NA-1551-2023-04-30-Final.mp3",
707+
"description": "The URL for the episode enclosure to get the information for.\n",
708+
"disabled": true
709+
},
698710
{
699711
"key": "fulltext",
700712
"value": "",
@@ -709,7 +721,7 @@
709721
}
710722
]
711723
},
712-
"description": "This call returns all the episodes we know about for this feed from the iTunes ID. Episodes are in reverse chronological order.\n\nExample: https://api.podcastindex.org/api/1.0/episodes/byitunesid?id=1441923632&pretty\n"
724+
"description": "This call returns all the episodes we know about for this feed from the iTunes ID.\nEpisodes are in reverse chronological order.\n\nWhen using the `enclosure` parameter, only the episode matching the URL is returned.\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/episodes/byitunesid?id=1441923632&pretty\n - Using `enclosure`: https://api.podcastindex.org/api/1.0/episodes/byitunesid?id=269169796&enclosure=https://op3.dev/e/mp3s.nashownotes.com/NA-1551-2023-04-30-Final.mp3&pretty\n"
713725
},
714726
"response": []
715727
},

‎api_src/components/parameters/enclosure.yaml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name: enclosure
2+
in: query
3+
# language=Markdown
4+
description: >
5+
The URL for the episode enclosure to get the information for.
6+
required: false
7+
schema:
8+
type: string
9+
example: "https://op3.dev/e/mp3s.nashownotes.com/NA-1551-2023-04-30-Final.mp3"

‎api_src/paths/episodes/byfeedid.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,24 @@ get:
88
Episodes are in reverse chronological order.
99
1010
11+
When using the `enclosure` parameter, only the episode matching the URL is returned.
12+
13+
1114
Examples:
1215
1316
- https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=75075&pretty
1417
- https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=41504,920666&pretty
1518
- Includes `persons`: https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=169991&pretty
1619
- Includes `value`: https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=4058673&pretty
20+
- Using `enclosure`: https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=41504&enclosure=https://op3.dev/e/mp3s.nashownotes.com/NA-1551-2023-04-30-Final.mp3&pretty
1721
operationId: episodes/byfeedid
1822
security:
1923
- $ref: '../../components/security/security.yaml'
2024
parameters:
2125
- $ref: '../../components/parameters/id_feed_episode_pi.yaml'
2226
- $ref: '../../components/parameters/since.yaml'
2327
- $ref: '../../components/parameters/max.yaml'
28+
- $ref: '../../components/parameters/enclosure.yaml'
2429
- $ref: '../../components/parameters/fulltext.yaml'
2530
- $ref: '../../components/parameters/pretty.yaml'
2631
responses:

‎api_src/paths/episodes/byitunesid.yaml‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,21 @@ get:
88
Episodes are in reverse chronological order.
99
1010
11-
Example: https://api.podcastindex.org/api/1.0/episodes/byitunesid?id=1441923632&pretty
11+
When using the `enclosure` parameter, only the episode matching the URL is returned.
12+
13+
14+
Examples:
15+
16+
- https://api.podcastindex.org/api/1.0/episodes/byitunesid?id=1441923632&pretty
17+
- Using `enclosure`: https://api.podcastindex.org/api/1.0/episodes/byitunesid?id=269169796&enclosure=https://op3.dev/e/mp3s.nashownotes.com/NA-1551-2023-04-30-Final.mp3&pretty
1218
operationId: episodes/byitunesid
1319
security:
1420
- $ref: '../../components/security/security.yaml'
1521
parameters:
1622
- $ref: '../../components/parameters/id_feed_podcast_itunes.yaml'
1723
- $ref: '../../components/parameters/since.yaml'
1824
- $ref: '../../components/parameters/max.yaml'
25+
- $ref: '../../components/parameters/enclosure.yaml'
1926
- $ref: '../../components/parameters/fulltext.yaml'
2027
- $ref: '../../components/parameters/pretty.yaml'
2128
responses:

‎docs/pi_api.json‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -408,6 +408,16 @@
408408
}
409409
}
410410
},
411+
"enclosure": {
412+
"name": "enclosure",
413+
"in": "query",
414+
"description": "The URL for the episode enclosure to get the information for.\n",
415+
"required": false,
416+
"schema": {
417+
"type": "string"
418+
},
419+
"example": "https://op3.dev/e/mp3s.nashownotes.com/NA-1551-2023-04-30-Final.mp3"
420+
},
411421
"id_episode_pi": {
412422
"name": "id",
413423
"in": "query",
@@ -4519,7 +4529,7 @@
45194529
"Episodes"
45204530
],
45214531
"summary": "By Feed ID",
4522-
"description": "This call returns all the episodes we know about for this feed from the PodcastIndex ID. Episodes are in reverse chronological order.\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=75075&pretty\n - https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=41504,920666&pretty\n - Includes `persons`: https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=169991&pretty\n - Includes `value`: https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=4058673&pretty\n",
4532+
"description": "This call returns all the episodes we know about for this feed from the PodcastIndex ID. Episodes are in reverse chronological order.\n\nWhen using the `enclosure` parameter, only the episode matching the URL is returned.\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=75075&pretty\n - https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=41504,920666&pretty\n - Includes `persons`: https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=169991&pretty\n - Includes `value`: https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=4058673&pretty\n - Using `enclosure`: https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=41504&enclosure=https://op3.dev/e/mp3s.nashownotes.com/NA-1551-2023-04-30-Final.mp3&pretty\n",
45234533
"operationId": "episodes/byfeedid",
45244534
"security": [
45254535
{
@@ -4539,6 +4549,9 @@
45394549
{
45404550
"$ref": "#/components/parameters/max"
45414551
},
4552+
{
4553+
"$ref": "#/components/parameters/enclosure"
4554+
},
45424555
{
45434556
"$ref": "#/components/parameters/fulltext"
45444557
},
@@ -4657,7 +4670,7 @@
46574670
"Episodes"
46584671
],
46594672
"summary": "By iTunes ID",
4660-
"description": "This call returns all the episodes we know about for this feed from the iTunes ID. Episodes are in reverse chronological order.\n\nExample: https://api.podcastindex.org/api/1.0/episodes/byitunesid?id=1441923632&pretty\n",
4673+
"description": "This call returns all the episodes we know about for this feed from the iTunes ID. Episodes are in reverse chronological order.\n\nWhen using the `enclosure` parameter, only the episode matching the URL is returned.\n\nExamples:\n\n - https://api.podcastindex.org/api/1.0/episodes/byitunesid?id=1441923632&pretty\n - Using `enclosure`: https://api.podcastindex.org/api/1.0/episodes/byitunesid?id=269169796&enclosure=https://op3.dev/e/mp3s.nashownotes.com/NA-1551-2023-04-30-Final.mp3&pretty\n",
46614674
"operationId": "episodes/byitunesid",
46624675
"security": [
46634676
{
@@ -4677,6 +4690,9 @@
46774690
{
46784691
"$ref": "#/components/parameters/max"
46794692
},
4693+
{
4694+
"$ref": "#/components/parameters/enclosure"
4695+
},
46804696
{
46814697
"$ref": "#/components/parameters/fulltext"
46824698
},

‎docs/pi_api.yaml‎

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -551,6 +551,15 @@ components:
551551
multiple:
552552
value: 41504,920666
553553
description: Multiple IDs
554+
enclosure:
555+
name: enclosure
556+
in: query
557+
description: |
558+
The URL for the episode enclosure to get the information for.
559+
required: false
560+
schema:
561+
type: string
562+
example: https://op3.dev/e/mp3s.nashownotes.com/NA-1551-2023-04-30-Final.mp3
554563
id_episode_pi:
555564
name: id
556565
in: query
@@ -4097,12 +4106,17 @@ paths:
40974106
PodcastIndex ID. Episodes are in reverse chronological order.
40984107
40994108
4109+
When using the `enclosure` parameter, only the episode matching the URL
4110+
is returned.
4111+
4112+
41004113
Examples:
41014114
41024115
- https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=75075&pretty
41034116
- https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=41504,920666&pretty
41044117
- Includes `persons`: https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=169991&pretty
41054118
- Includes `value`: https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=4058673&pretty
4119+
- Using `enclosure`: https://api.podcastindex.org/api/1.0/episodes/byfeedid?id=41504&enclosure=https://op3.dev/e/mp3s.nashownotes.com/NA-1551-2023-04-30-Final.mp3&pretty
41064120
operationId: episodes/byfeedid
41074121
security:
41084122
- API Key: []
@@ -4113,6 +4127,7 @@ paths:
41134127
- $ref: '#/components/parameters/id_feed_episode_pi'
41144128
- $ref: '#/components/parameters/since'
41154129
- $ref: '#/components/parameters/max'
4130+
- $ref: '#/components/parameters/enclosure'
41164131
- $ref: '#/components/parameters/fulltext'
41174132
- $ref: '#/components/parameters/pretty'
41184133
responses:
@@ -4199,8 +4214,14 @@ paths:
41994214
iTunes ID. Episodes are in reverse chronological order.
42004215
42014216
4202-
Example:
4203-
https://api.podcastindex.org/api/1.0/episodes/byitunesid?id=1441923632&pretty
4217+
When using the `enclosure` parameter, only the episode matching the URL
4218+
is returned.
4219+
4220+
4221+
Examples:
4222+
4223+
- https://api.podcastindex.org/api/1.0/episodes/byitunesid?id=1441923632&pretty
4224+
- Using `enclosure`: https://api.podcastindex.org/api/1.0/episodes/byitunesid?id=269169796&enclosure=https://op3.dev/e/mp3s.nashownotes.com/NA-1551-2023-04-30-Final.mp3&pretty
42044225
operationId: episodes/byitunesid
42054226
security:
42064227
- API Key: []
@@ -4211,6 +4232,7 @@ paths:
42114232
- $ref: '#/components/parameters/id_feed_podcast_itunes'
42124233
- $ref: '#/components/parameters/since'
42134234
- $ref: '#/components/parameters/max'
4235+
- $ref: '#/components/parameters/enclosure'
42144236
- $ref: '#/components/parameters/fulltext'
42154237
- $ref: '#/components/parameters/pretty'
42164238
responses:

0 commit comments

Comments
 (0)