Skip to content

Commit 66c4d09

Browse files
stevencraderstevencrader
committed
Add max parameter to search/byperson, search/byterm, search/bytitle, search/music/byterm, podcasts/bymedium
https://podcastindex.social/@dave/110074339879578390
1 parent e087909 commit 66c4d09

File tree

8 files changed

+76
-21
lines changed

8 files changed

+76
-21
lines changed

‎Postman Docs/PodcastIndex.postman_collection.json‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,12 @@
3535
"description": "Only returns feeds with a `value` block of the specified type. Use `any` to return feeds with any `value` block.\n",
3636
"disabled": true
3737
},
38+
{
39+
"key": "max",
40+
"value": "20",
41+
"description": "Maximum number of results to return.\n",
42+
"disabled": true
43+
},
3844
{
3945
"key": "aponly",
4046
"value": "true",
@@ -91,6 +97,12 @@
9197
"description": "Only returns feeds with a `value` block of the specified type. Use `any` to return feeds with any `value` block.\n",
9298
"disabled": true
9399
},
100+
{
101+
"key": "max",
102+
"value": "20",
103+
"description": "Maximum number of results to return.\n",
104+
"disabled": true
105+
},
94106
{
95107
"key": "clean",
96108
"value": "",
@@ -141,6 +153,12 @@
141153
"value": "adam curry",
142154
"description": "(Required) Person search for\n"
143155
},
156+
{
157+
"key": "max",
158+
"value": "20",
159+
"description": "Maximum number of results to return.\n",
160+
"disabled": true
161+
},
144162
{
145163
"key": "fulltext",
146164
"value": "",
@@ -192,6 +210,12 @@
192210
"description": "Only returns feeds with an `itunesId`.\n",
193211
"disabled": true
194212
},
213+
{
214+
"key": "max",
215+
"value": "20",
216+
"description": "Maximum number of results to return.\n",
217+
"disabled": true
218+
},
195219
{
196220
"key": "clean",
197221
"value": "",
@@ -412,6 +436,12 @@
412436
"value": "video",
413437
"description": "(Required) The medium value to search for.\n\nFull list of possible values documented in [medium](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md#medium) tag spec."
414438
},
439+
{
440+
"key": "max",
441+
"value": "20",
442+
"description": "Maximum number of results to return.\n",
443+
"disabled": true
444+
},
415445
{
416446
"key": "pretty",
417447
"value": "",

‎api_src/paths/podcasts/bymedium.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ get:
1414
- $ref: '../../components/security/security.yaml'
1515
parameters:
1616
- $ref: '../../components/parameters/medium.yaml'
17+
- $ref: '../../components/parameters/max.yaml'
1718
- $ref: '../../components/parameters/pretty.yaml'
1819
responses:
1920
'200':

‎api_src/paths/search/byperson.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ get:
2626
- $ref: '../../components/security/security.yaml'
2727
parameters:
2828
- $ref: '../../components/parameters/q_person.yaml'
29+
- $ref: '../../components/parameters/max.yaml'
2930
- $ref: '../../components/parameters/fulltext.yaml'
3031
- $ref: '../../components/parameters/pretty.yaml'
3132
responses:

‎api_src/paths/search/byterm.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ get:
1414
parameters:
1515
- $ref: '../../components/parameters/q.yaml'
1616
- $ref: '../../components/parameters/val.yaml'
17+
- $ref: '../../components/parameters/max.yaml'
1718
- $ref: '../../components/parameters/aponly.yaml'
1819
- $ref: '../../components/parameters/clean.yaml'
1920
- $ref: '../../components/parameters/fulltext.yaml'

‎api_src/paths/search/bytitle.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ get:
1818
parameters:
1919
- $ref: '../../components/parameters/q.yaml'
2020
- $ref: '../../components/parameters/val.yaml'
21+
- $ref: '../../components/parameters/max.yaml'
2122
- $ref: '../../components/parameters/clean.yaml'
2223
- $ref: '../../components/parameters/fulltext.yaml'
2324
- $ref: '../../components/parameters/pretty.yaml'

‎api_src/paths/search/music/byterm.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ get:
1616
- $ref: '../../../components/parameters/q.yaml'
1717
- $ref: '../../../components/parameters/val.yaml'
1818
- $ref: '../../../components/parameters/aponly.yaml'
19+
- $ref: '../../../components/parameters/max.yaml'
1920
- $ref: '../../../components/parameters/clean.yaml'
2021
- $ref: '../../../components/parameters/fulltext.yaml'
2122
- $ref: '../../../components/parameters/pretty.yaml'

‎docs/pi_api.json‎

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,17 @@
165165
},
166166
"example": ""
167167
},
168+
"max": {
169+
"name": "max",
170+
"in": "query",
171+
"description": "Maximum number of results to return.\n",
172+
"schema": {
173+
"type": "integer",
174+
"minimum": 1,
175+
"maximum": 1000
176+
},
177+
"example": 10
178+
},
168179
"aponly": {
169180
"name": "aponly",
170181
"in": "query",
@@ -291,17 +302,6 @@
291302
},
292303
"example": "film"
293304
},
294-
"max": {
295-
"name": "max",
296-
"in": "query",
297-
"description": "Maximum number of results to return.\n",
298-
"schema": {
299-
"type": "integer",
300-
"minimum": 1,
301-
"maximum": 1000
302-
},
303-
"example": 10
304-
},
305305
"since": {
306306
"name": "since",
307307
"in": "query",
@@ -4034,6 +4034,9 @@
40344034
{
40354035
"$ref": "#/components/parameters/val"
40364036
},
4037+
{
4038+
"$ref": "#/components/parameters/max"
4039+
},
40374040
{
40384041
"$ref": "#/components/parameters/aponly"
40394042
},
@@ -4097,6 +4100,9 @@
40974100
{
40984101
"$ref": "#/components/parameters/val"
40994102
},
4103+
{
4104+
"$ref": "#/components/parameters/max"
4105+
},
41004106
{
41014107
"$ref": "#/components/parameters/clean"
41024108
},
@@ -4143,6 +4149,9 @@
41434149
{
41444150
"$ref": "#/components/parameters/q_person"
41454151
},
4152+
{
4153+
"$ref": "#/components/parameters/max"
4154+
},
41464155
{
41474156
"$ref": "#/components/parameters/fulltext"
41484157
},
@@ -4189,6 +4198,9 @@
41894198
{
41904199
"$ref": "#/components/parameters/aponly"
41914200
},
4201+
{
4202+
"$ref": "#/components/parameters/max"
4203+
},
41924204
{
41934205
"$ref": "#/components/parameters/clean"
41944206
},
@@ -4423,6 +4435,9 @@
44234435
{
44244436
"$ref": "#/components/parameters/medium"
44254437
},
4438+
{
4439+
"$ref": "#/components/parameters/max"
4440+
},
44264441
{
44274442
"$ref": "#/components/parameters/pretty"
44284443
}

‎docs/pi_api.yaml‎

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,16 @@ components:
273273
- hive
274274
- webmonetization
275275
example: ''
276+
max:
277+
name: max
278+
in: query
279+
description: |
280+
Maximum number of results to return.
281+
schema:
282+
type: integer
283+
minimum: 1
284+
maximum: 1000
285+
example: 10
276286
aponly:
277287
name: aponly
278288
in: query
@@ -407,16 +417,6 @@ components:
407417
- podcast
408418
- video
409419
example: film
410-
max:
411-
name: max
412-
in: query
413-
description: |
414-
Maximum number of results to return.
415-
schema:
416-
type: integer
417-
minimum: 1
418-
maximum: 1000
419-
example: 10
420420
since:
421421
name: since
422422
in: query
@@ -3547,6 +3547,7 @@ paths:
35473547
parameters:
35483548
- $ref: '#/components/parameters/q'
35493549
- $ref: '#/components/parameters/val'
3550+
- $ref: '#/components/parameters/max'
35503551
- $ref: '#/components/parameters/aponly'
35513552
- $ref: '#/components/parameters/clean'
35523553
- $ref: '#/components/parameters/fulltext'
@@ -3758,6 +3759,7 @@ paths:
37583759
parameters:
37593760
- $ref: '#/components/parameters/q'
37603761
- $ref: '#/components/parameters/val'
3762+
- $ref: '#/components/parameters/max'
37613763
- $ref: '#/components/parameters/clean'
37623764
- $ref: '#/components/parameters/fulltext'
37633765
- $ref: '#/components/parameters/pretty'
@@ -3801,6 +3803,7 @@ paths:
38013803
Authorization: []
38023804
parameters:
38033805
- $ref: '#/components/parameters/q_person'
3806+
- $ref: '#/components/parameters/max'
38043807
- $ref: '#/components/parameters/fulltext'
38053808
- $ref: '#/components/parameters/pretty'
38063809
responses:
@@ -3834,6 +3837,7 @@ paths:
38343837
- $ref: '#/components/parameters/q'
38353838
- $ref: '#/components/parameters/val'
38363839
- $ref: '#/components/parameters/aponly'
3840+
- $ref: '#/components/parameters/max'
38373841
- $ref: '#/components/parameters/clean'
38383842
- $ref: '#/components/parameters/fulltext'
38393843
- $ref: '#/components/parameters/pretty'
@@ -4028,6 +4032,7 @@ paths:
40284032
Authorization: []
40294033
parameters:
40304034
- $ref: '#/components/parameters/medium'
4035+
- $ref: '#/components/parameters/max'
40314036
- $ref: '#/components/parameters/pretty'
40324037
responses:
40334038
'200':

0 commit comments

Comments
 (0)