Skip to content
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

added include meta param to library items #43

Merged
merged 5 commits into from
Aug 30, 2024
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
9 changes: 9 additions & 0 deletions parameters/container-size.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: X-Plex-Container-Size
in: query
description: |
Add the length/size of the number of media to be retrieved.
By default this is 50
schema:
type: integer
example: 0
required: false
9 changes: 9 additions & 0 deletions parameters/container-start.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: X-Plex-Container-Start
in: query
description: |
Add the index start from which the media items should be returned.
By default this is 0
schema:
type: integer
example: 0
required: false
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ get:
tags:
- Library
summary: Get Library Items
operationId: getLibraryItems
operationId: get-library-items
description: |
Fetches details from a specific section of the library identified by a section key and a tag. The tag parameter accepts the following values:
- `all`: All items in the section.
Expand Down Expand Up @@ -30,13 +30,7 @@ get:
required: true
description: the Id of the library to query
schema:
x-speakeasy-type-override: any
type: [integer, string]
examples:
librarySectionID:
value: 1
providerSectionID:
value: watchlist
- name: tag
in: path
required: true
Expand Down Expand Up @@ -67,10 +61,45 @@ get:
in: query
description: |
Adds the Guids object to the response
schema:
schema:
type: integer
enum:
- 0
- 1
example: 1
required: false
- name: includeMeta
in: query
description: |
Adds the Meta object to the response
schema:
type: integer
enum:
- 0
- 1
example: 1
required: false
- name: type
in: query
description: |
Filter the type of media to retrieve
1 is movie
2 is tv shows
3 is seasons
4 is episodes
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
schema:
type: integer
enum:
- 0
- 1
- 2
- 3
- 4
example: 2
required: false
- $ref: "../../../parameters/container-start.yaml"
- $ref: "../../../parameters/container-size.yaml"
responses:
"200":
description: The contents of the library by section and tag
Expand Down Expand Up @@ -430,6 +459,6 @@ get:
type: string
example: /library/metadata/66/theme/1705716261
"400":
$ref: "../../responses/400.yaml"
$ref: "../../../responses/400.yaml"
"401":
$ref: "../../responses/401.yaml"
$ref: "../../../responses/401.yaml"
7 changes: 2 additions & 5 deletions paths/pins/pins-id.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,7 @@ get:
schema:
$ref: ../../models/AuthPinContainer.yaml
'400':
content:
application/json:
schema:
$ref: ../../responses/400-MissingIdentifier.yaml
$ref: ../../responses/400-MissingIdentifier.yaml
'404':
description: Not Found or Expired
content:
Expand All @@ -48,4 +45,4 @@ get:
example:
errors:
- code: 1020
message: Code not found or expired
message: Code not found or expired
2 changes: 1 addition & 1 deletion pms-spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ paths:


/library/sections/{sectionId}/{tag}:
$ref: "./paths/library/content.yaml"
$ref: "./paths/library/[sectionId]/get-library-items.yaml"
/library/sections/{sectionId}/refresh:
$ref: "./paths/library/[sectionId]/refresh/get-refresh-library-metadata.yaml"
/library/sections/{sectionId}/search:
Expand Down
Loading
Loading