Skip to content

Commit f5c07ce

Browse files
committed
Mark attributes that may be null or missing in response.
Resolves #103
1 parent d6a4ce4 commit f5c07ce

25 files changed

+118
-48
lines changed

api_src/components/properties/chaptersUrl.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22
description: >
33
Link to the JSON file containing the episode chapters
44
type: string
5+
nullable: true
56
format: URL
67
example: "https://studio.hypercatcher.com/chapters/podcast/http:feed.nashownotes.comrss.xml/episode/http:1322.noagendanotes.com"
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# language=Markdown
22
description: >
3-
The name of a custom record key to send along with the payment.
3+
The name of a custom record key to send along with the payment. May not be reported.
44
55
66
See the [podcast namespace spec](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value)
77
and [value specification](https://github.com/Podcastindex-org/podcast-namespace/blob/main/value/value.md)
88
for more information.
99
type: string
10+
nullable: true
1011
example: "112111100"
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# language=Markdown
22
description: >
3-
A custom value to pass along with the payment. This is considered the value that belongs to the customKey.
3+
A custom value to pass along with the payment. This is considered the value that belongs to the customKey. May not be reported.
44
55
66
See the [podcast namespace spec](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#value)
77
and [value specification](https://github.com/Podcastindex-org/podcast-namespace/blob/main/value/value.md)
88
for more information.
99
type: string
10+
nullable: true
1011
example: "wal_ZmqFg13NB31oek"
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# language=Markdown
22
description: >
3-
The internal PodcastIndex.org Feed ID this feed duplicates
3+
The internal PodcastIndex.org Feed ID this feed duplicates. May be null except in `podcasts/dead`.
44
type: integer
5+
nullable: true
56
example: 75075
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# language=Markdown
22
description: >
3-
The estimated length of the item specified by the `enclosureUrl` in seconds
3+
The estimated length of the item specified by the `enclosureUrl` in seconds. Will be null for `liveItem`.
44
type: integer
5+
nullable: true
56
format: seconds
67
example: 54

api_src/components/properties/episodeType.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# language=Markdown
22
description: >
3-
The type of episode
3+
The type of episode. May be null for `liveItem`.
44
type: string
5+
nullable: true
56
enum:
67
- full
78
- trailer

api_src/components/properties/episode_number.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
description: >
33
Episode number
44
type: integer
5+
nullable: true
56
example: 19
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# language=Markdown
22
description: >
3-
Indicates if destination is included due to a fee being charged
3+
Indicates if destination is included due to a fee being charged. May not be reported.
44
type: boolean
5+
nullable: true
56
example: true

api_src/components/properties/feeds_categories.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22
description: >
33
List of categories
44
type: array
5+
nullable: true
56
items:
67
$ref: '../schemas/feed_categories.yaml'

api_src/components/properties/funding.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# language=Markdown
22
description: >
3-
Information for donation/funding the podcast.
3+
Information for donation/funding the podcast. May not be reported.
44
55
66
See the [podcast namespace spec](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#funding) for more information.
77
type: object
8+
nullable: true
89
properties:
910
url:
1011
$ref: '../properties/url_funding.yaml'

0 commit comments

Comments
 (0)