Skip to content

Various updates from 2024 08 23 #137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ indent_style = space
insert_final_newline = true
max_line_length = 120
tab_width = 4
trim_trailing_whitespace = true

[{*.yaml,*.yml}]
indent_size = 2
Expand Down
321 changes: 309 additions & 12 deletions Postman Docs/PodcastIndex.postman_collection.json

Large diffs are not rendered by default.

11 changes: 11 additions & 0 deletions api_src/components/parameters/newest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: newest
in: query
# language=Markdown
description: |
If present, returns only the most recent (newest) episode for each specified feed id.


Parameter shall not have a value
schema:
type: boolean
allowEmptyValue: true
6 changes: 6 additions & 0 deletions api_src/components/properties/createdOn.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# language=Markdown
description: |
The first time the feed was seen by Podcast Index
type: integer
format: Unix Epoch
example: 1613394034
18 changes: 18 additions & 0 deletions api_src/components/properties/data_static.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# language=Markdown
description: |
Object containing the recent data
type: object
properties:
nextSince:
# language=Markdown
description: |
Value of `since` in next block of data
type: integer
format: Unix Epoch
example: 1613805249
position:
$ref: '../properties/position.yaml'
feeds:
$ref: '../properties/feeds_data.yaml'
items:
$ref: '../properties/items_data.yaml'
5 changes: 5 additions & 0 deletions api_src/components/properties/episodeCountTotal.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# language=Markdown
description: |
Total individual podcast episodes in the index.
type: integer
example: 143953477
5 changes: 5 additions & 0 deletions api_src/components/properties/episodesWithChapters.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# language=Markdown
description: |
Number of episodes with [`podcast:chapters`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#chapters)
type: integer
example: 652781
7 changes: 7 additions & 0 deletions api_src/components/properties/episodesWithTranscripts.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# language=Markdown
description: |
Episodes with a
[`podcast:transcript`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#transcript)
tag.
type: integer
example: 3198597
5 changes: 5 additions & 0 deletions api_src/components/properties/feedCountTotal.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# language=Markdown
description: |
Total podcast feeds in the index.
type: integer
example: 4257865
75 changes: 75 additions & 0 deletions api_src/components/properties/feed_podcast_batch.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# language=Markdown
description: |
Known details of podcast feed
type: object
properties:
id:
$ref: '../properties/id_feed.yaml'
title:
$ref: '../properties/title_feed.yaml'
url:
$ref: '../properties/url_feed.yaml'
originalUrl:
$ref: '../properties/originalUrl.yaml'
link:
$ref: '../properties/link_feed.yaml'
description:
$ref: '../properties/description_feed.yaml'
author:
$ref: '../properties/author.yaml'
ownerName:
$ref: '../properties/ownerName.yaml'
image:
$ref: '../properties/image_feed.yaml'
artwork:
$ref: '../properties/artwork.yaml'
lastUpdateTime:
$ref: '../properties/lastUpdateTime.yaml'
lastCrawlTime:
$ref: '../properties/lastCrawlTime.yaml'
lastParseTime:
$ref: '../properties/lastParseTime.yaml'
inPollingQueue:
$ref: '../properties/inPollingQueue.yaml'
priority:
$ref: '../properties/priority.yaml'
lastGoodHttpStatusTime:
$ref: '../properties/lastGoodHttpStatusTime.yaml'
lastHttpStatus:
$ref: '../properties/lastHttpStatus.yaml'
contentType:
$ref: '../properties/contentType.yaml'
itunesId:
$ref: '../properties/itunesId_feed.yaml'
generator:
$ref: '../properties/generator.yaml'
createdOn:
$ref: '../properties/createdOn.yaml'
language:
$ref: '../properties/language.yaml'
type:
$ref: '../properties/type.yaml'
dead:
$ref: '../properties/dead.yaml'
crawlErrors:
$ref: '../properties/crawlErrors.yaml'
parseErrors:
$ref: '../properties/parseErrors.yaml'
categories:
$ref: '../properties/categories.yaml'
locked:
$ref: '../properties/locked.yaml'
explicit:
$ref: '../properties/explicit_feed.yaml'
podcastGuid:
$ref: '../properties/podcastguid.yaml'
medium:
$ref: '../properties/medium_feed.yaml'
episodeCount:
$ref: '../properties/episodeCount.yaml'
imageUrlHash:
$ref: '../properties/imageUrlHash.yaml'
newestItemPubdate:
$ref: '../properties/newestItemPublishTime.yaml'
valueBlock:
$ref: '../properties/valueBlock.yaml'
7 changes: 7 additions & 0 deletions api_src/components/properties/feedsWithChapters.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# language=Markdown
description: |
Podcast feeds with a
[`podcast:chapters`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#chapters)
tag in at least 1 episode.
type: integer
example: 35582
7 changes: 7 additions & 0 deletions api_src/components/properties/feedsWithFundingTag.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# language=Markdown
description: |
Podcast feeds with a
[`podcast:funding`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#funding)
tag in at least 1 episode.
type: integer
example: 57582
7 changes: 7 additions & 0 deletions api_src/components/properties/feedsWithMediumMusic.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# language=Markdown
description: |
Podcast feeds with a
[`podcast:medium`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#medium)
tag with a value of `music`.
type: integer
example: 3700
7 changes: 7 additions & 0 deletions api_src/components/properties/feedsWithMediumVideo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# language=Markdown
description: |
Podcast feeds with a
[`podcast:medium`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#medium)
tag with a value of `video`.
type: integer
example: 1288
5 changes: 5 additions & 0 deletions api_src/components/properties/feedsWithNewEpisodes10days.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# language=Markdown
description: |
Podcast feeds with a new episode released in the last 10 days.
type: integer
example: 212322
5 changes: 5 additions & 0 deletions api_src/components/properties/feedsWithNewEpisodes14days.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# language=Markdown
description: |
Podcast feeds with a new episode released in the last 14 days.
type: integer
example: 239664
5 changes: 5 additions & 0 deletions api_src/components/properties/feedsWithNewEpisodes30days.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# language=Markdown
description: |
Podcast feeds with a new episode released in the last 30 days.
type: integer
example: 306748
5 changes: 5 additions & 0 deletions api_src/components/properties/feedsWithNewEpisodes3days.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# language=Markdown
description: |
Podcast feeds with a new episode released in the last 3 days.
type: integer
example: 97522
5 changes: 5 additions & 0 deletions api_src/components/properties/feedsWithNewEpisodes60days.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# language=Markdown
description: |
Podcast feeds with a new episode released in the last 60 days.
type: integer
example: 382945
5 changes: 5 additions & 0 deletions api_src/components/properties/feedsWithNewEpisodes7days.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# language=Markdown
description: |
Podcast feeds with a new episode released in the last 7 days.
type: integer
example: 179043
5 changes: 5 additions & 0 deletions api_src/components/properties/feedsWithNewEpisodes90days.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# language=Markdown
description: |
Podcast feeds with a new episode released in the last 90 days.
type: integer
example: 436933
7 changes: 7 additions & 0 deletions api_src/components/properties/feedsWithTranscripts.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# language=Markdown
description: |
Podcast feeds with a
[`podcast:transcript`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#transcript)
tag in at least 1 episode.
type: integer
example: 61385
7 changes: 7 additions & 0 deletions api_src/components/properties/feedsWithValueBlocks.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# language=Markdown
description: |
Podcast feeds with a
[`podcast:value`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value)
tag in at least 1 episode.
type: integer
example: 21916
6 changes: 6 additions & 0 deletions api_src/components/properties/feeds_batch.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# language=Markdown
description: |
List of feeds with matching GUID
type: array
items:
$ref: 'feed_podcast_batch.yaml'
6 changes: 6 additions & 0 deletions api_src/components/properties/inPollingQueue.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# language=Markdown
description: |
Indicates if feed is currently scheduled to be polled/checked for new episodes.
type: integer
nullable: true
example: 1
5 changes: 5 additions & 0 deletions api_src/components/properties/newEpisodes10days.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# language=Markdown
description: |
Podcast feeds with a new episode containing a released in the last 10 days.
type: integer
example: 684833
5 changes: 5 additions & 0 deletions api_src/components/properties/newEpisodes14days.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# language=Markdown
description: |
Podcast feeds with a new episode containing a released in the last 14 days.
type: integer
example: 907203
5 changes: 5 additions & 0 deletions api_src/components/properties/newEpisodes30days.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# language=Markdown
description: |
Podcast feeds with a new episode containing a released in the last 30 days.
type: integer
example: 1901547
5 changes: 5 additions & 0 deletions api_src/components/properties/newEpisodes3days.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# language=Markdown
description: |
Podcast feeds with a new episode containing a released in the last 3 days.
type: integer
example: 212324
5 changes: 5 additions & 0 deletions api_src/components/properties/newEpisodes60days.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# language=Markdown
description: |
Podcast feeds with a new episode containing a released in the last 60 days.
type: integer
example: 3710750
5 changes: 5 additions & 0 deletions api_src/components/properties/newEpisodes7days.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# language=Markdown
description: |
Podcast feeds with a new episode containing a released in the last 7 days.
type: integer
example: 442061
5 changes: 5 additions & 0 deletions api_src/components/properties/newEpisodes90days.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# language=Markdown
description: |
Podcast feeds with a new episode containing a released in the last 90 days.
type: integer
example: 5498580
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# language=Markdown
description: |
Podcast feeds with a new episode containing a
[`podcast:value`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value)
block released in the last 10 days.
type: integer
example: 165789
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# language=Markdown
description: |
Podcast feeds with a new episode containing a
[`podcast:value`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value)
block released in the last 14 days.
type: integer
example: 186602
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# language=Markdown
description: |
Podcast feeds with a new episode containing a
[`podcast:value`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value)
block released in the last 30 days.
type: integer
example: 237389
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# language=Markdown
description: |
Podcast feeds with a new episode containing a
[`podcast:value`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value)
block released in the last 3 days.
type: integer
example: 77638
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# language=Markdown
description: |
Podcast feeds with a new episode containing a
[`podcast:value`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value)
block released in the last 60 days.
type: integer
example: 77632
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# language=Markdown
description: |
Podcast feeds with a new episode containing a
[`podcast:value`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value)
block released in the last 7 days.
type: integer
example: 140275
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# language=Markdown
description: |
Podcast feeds with a new episode containing a
[`podcast:value`](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value)
block released in the last 90 days.
type: integer
example: 335380
15 changes: 15 additions & 0 deletions api_src/components/properties/priority.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# language=Markdown
description: |
How often the feed is checked for updates and new episodes

A value of -1 means never check. A value of 5 means check the most.
type: integer
enum:
- -1
- 0
- 1
- 2
- 3
- 4
- 5
example: 5
Loading