Skip to content

Commit 5020213

Browse files
Merge pull request #61 from LukeHagar/fixes2
2 parents d4fbc74 + d15b5a8 commit 5020213

File tree

8 files changed

+36077
-677
lines changed

8 files changed

+36077
-677
lines changed

src/models/MetaData.yaml

+665-672
Large diffs are not rendered by default.

src/models/Subscription.yaml

+11-2
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ properties:
66
type: array
77
items:
88
type: string
9-
x-speakeasy-unknown-values: allow
10-
enum:
9+
#TODO This should become an enum once all values are known
10+
description: |
1111
- Android - Dolby Vision
1212
- Android - PiP
1313
- CU Sunset
@@ -103,6 +103,15 @@ properties:
103103
- watchlist-rss
104104
- web_server_dashboard
105105
- webhooks
106+
- blacklist-subnets
107+
- chromecast-music-mp
108+
- Sync v3
109+
- livetv-platform-specific
110+
- nonAnonymousAccount
111+
- parental-controls
112+
- Subtitles on Demand
113+
- ultrablur
114+
- web-desktop-gracenote-banner
106115
active:
107116
description: If the account's Plex Pass subscription is active
108117
type: boolean

src/parameters/query.yaml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
name: query
2+
in: query
3+
required: true
4+
schema:
5+
type: string
6+
description: The search query term.

src/paths/hubs/home/get-recently-added.yaml

+3-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@ get:
3939
Meta:
4040
$ref: "../../../models/Meta.yaml"
4141
Metadata:
42-
$ref: "../../../models/MetaData.yaml"
42+
type: array
43+
items:
44+
$ref: "../../../models/MetaData.yaml"
4345

4446
"401":
4547
description: Unauthorized, invalid Plex token.

src/paths/library/[sectionKey]/get-library-items.yaml

+3-1
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,9 @@ get:
171171
type: boolean
172172
example: true
173173
Metadata:
174-
$ref: "../../../models/MetaData.yaml"
174+
type: array
175+
items:
176+
$ref: "../../../models/MetaData.yaml"
175177
Meta:
176178
description: |
177179
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
get:
2+
tags:
3+
- Library
4+
summary: Search All Libraries
5+
operationId: get-search-all-libraries
6+
description: |
7+
Search the provided query across all library sections, or a single section, and return matches as hubs, split up by type.
8+
parameters:
9+
- $ref: "../../parameters/query.yaml"
10+
- $ref: "../../parameters/plex/x-plex-identifier.yaml"
11+
- name: limit
12+
in: query
13+
required: false
14+
schema:
15+
type: integer
16+
description: Limit the number of results returned.
17+
- name: searchTypes
18+
in: query
19+
required: false
20+
schema:
21+
type: array
22+
items:
23+
type: string
24+
enum:
25+
- movies
26+
- music
27+
- otherVideos
28+
- people
29+
- tv
30+
example: movies,music,otherVideos,people,tv
31+
style: form
32+
explode: false
33+
description: |
34+
A comma-separated list of search types to include. Valid values are: movies, music, otherVideos, people, tv.
35+
- name: includeCollections
36+
in: query
37+
required: false
38+
schema:
39+
$ref: "../../models/common/PlexBoolean.yaml"
40+
description: Whether to include collections in the search results.
41+
- name: includeExternalMedia
42+
in: query
43+
required: false
44+
schema:
45+
$ref: "../../models/common/PlexBoolean.yaml"
46+
description: Whether to include external media in the search results.
47+
responses:
48+
"200":
49+
description: The libraries available on the Server
50+
content:
51+
application/json:
52+
schema:
53+
type: object
54+
required:
55+
- MediaContainer
56+
properties:
57+
MediaContainer:
58+
type: object
59+
required:
60+
- size
61+
- SearchResult
62+
properties:
63+
size:
64+
type: number
65+
SearchResult:
66+
type: array
67+
items:
68+
type: object
69+
required:
70+
- score
71+
- Metadata
72+
properties:
73+
score:
74+
type: number
75+
format: float # This is correct for 32-bit floating-point numbers
76+
Metadata:
77+
$ref: "../../models/MetaData.yaml"
78+
"400":
79+
$ref: "../../responses/400.yaml"
80+
"401":
81+
$ref: "../../responses/401.yaml"

src/pms-spec.yaml

+4-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ info:
2727
| Swift | [GitHub](https://github.com/LukeHagar/plexswift) | [Releases](https://github.com/LukeHagar/plexswift/releases) | - |
2828
| PHP | [GitHub](https://github.com/LukeHagar/plexphp) | [Releases](https://github.com/LukeHagar/plexphp/releases) | - |
2929
| Java | [GitHub](https://github.com/LukeHagar/plexjava) | [Releases](https://github.com/LukeHagar/plexjava/releases) | - |
30-
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -
30+
| C# | [GitHub](https://github.com/LukeHagar/plexcsharp) | [Releases](https://github.com/LukeHagar/plexcsharp/releases) | -
3131
contact:
3232
name: Luke Hagar
3333
url: "https://www.LukeHagar.com"
@@ -179,6 +179,9 @@ paths:
179179
/library/sections/{sectionKey}/search:
180180
$ref: "./paths/library/[sectionKey]/get-search-library.yaml"
181181

182+
/library/search:
183+
$ref: "./paths/library/get-search-all-libraries.yaml"
184+
182185
/library/metadata/{ratingKey}:
183186
$ref: "./paths/library/metadata/[ratingKey]/get-meta-data-by-rating-key.yaml"
184187
/library/metadata/{ratingKey}/banner:

0 commit comments

Comments
 (0)