LukeParke/plex-api-spec
1
0
Fork 0
mirror of https://github.com/LukeHagar/plex-api-spec.git synced 2025-12-10 04:20:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

moved to correct folder

Browse Source
This commit is contained in:
JasonLandbridge
2025-06-03 13:05:14 +02:00
parent d1ee80a018
commit f6a944deca
10 changed files with 253 additions and 253 deletions
Download Patch File Download Diff File Expand all files Collapse all files

164
src/paths/library/[sectionKey]/get-library-all.yaml
View File

@@ -1,164 +0,0 @@
get:
tags:
- Library
summary: Get all media of library
operationId: get-all-media-library
description: |
Retrieves a list of all general media data for this library.
parameters:
- $ref: "../../../parameters/library/section-key.yaml"
- $ref: "../../../parameters/type.yaml"
- $ref: "../../../parameters/include-meta.yaml"
- $ref: "../../../parameters/include-guids.yaml"
- $ref: "../../../parameters/include-advanced.yaml"
- $ref: "../../../parameters/include-collections.yaml"
- $ref: "../../../parameters/include-external-media.yaml"
- $ref: "../../../parameters/container-start.yaml"
- $ref: "../../../parameters/container-size.yaml"
- $ref: "../../../parameters/accept-application-json.yaml"
responses:
"200":
description: Successful response containing media container data.
content:
application/json:
schema:
type: object
properties:
MediaContainer:
allOf:
- $ref: "../../../models/media-container/size.yaml"
- $ref: "../../../models/media-container/total-size.yaml"
- $ref: "../../../models/media-container/offset.yaml"
- $ref: "../../../models/media-container/allow-sync.yaml"
- $ref: "../../../models/media-container/art.yaml"
- $ref: "../../../models/media-container/content.yaml"
- $ref: "../../../models/media-container/identifier.yaml"
- $ref: "../../../models/media-container/library-section-id.yaml"
- $ref: "../../../models/media-container/library-section-title.yaml"
- $ref: "../../../models/media-container/library-section-uuid.yaml"
- $ref: "../../../models/media-container/media-tag-prefix.yaml"
- $ref: "../../../models/media-container/media-tag-version.yaml"
- $ref: "../../../models/media-container/thumb.yaml"
- $ref: "../../../models/media-container/nocache.yaml"
- $ref: "../../../models/media-container/title1.yaml"
- $ref: "../../../models/media-container/title2.yaml"
- $ref: "../../../models/media-container/view-group.yaml"
- type: object
properties:
Meta:
$ref: "../../../models/Meta.yaml"
Metadata:
type: array
description: "An array of metadata items."
items:
required:
- type
allOf:
- $ref: "../../../models/meta-data/rating-key.yaml"
- $ref: "../../../models/meta-data/key.yaml"
- $ref: "../../../models/meta-data/guid.yaml"
- $ref: "../../../models/meta-data/slug.yaml"
- $ref: "../../../models/meta-data/studio.yaml"
- $ref: "../../../models/meta-data/type.yaml"
- $ref: "../../../models/meta-data/title.yaml"
- $ref: "../../../models/meta-data/title-sort.yaml"
- $ref: "../../../models/meta-data/content-rating.yaml"
- $ref: "../../../models/meta-data/summary.yaml"
- $ref: "../../../models/meta-data/rating.yaml"
- $ref: "../../../models/meta-data/audience-rating.yaml"
- $ref: "../../../models/meta-data/year.yaml"
- $ref: "../../../models/meta-data/tagline.yaml"
- $ref: "../../../models/meta-data/thumb.yaml"
- $ref: "../../../models/meta-data/art.yaml"
- $ref: "../../../models/meta-data/theme.yaml"
- $ref: "../../../models/meta-data/index.yaml"
- $ref: "../../../models/meta-data/leaf-count.yaml"
- $ref: "../../../models/meta-data/viewed-leaf-count.yaml"
- $ref: "../../../models/meta-data/child-count.yaml"
- $ref: "../../../models/meta-data/season-count.yaml"
- $ref: "../../../models/meta-data/duration.yaml"
- $ref: "../../../models/meta-data/originally-available-at.yaml"
- $ref: "../../../models/meta-data/added-at.yaml"
- $ref: "../../../models/meta-data/updated-at.yaml"
- $ref: "../../../models/meta-data/audience-rating-image.yaml"
- $ref: "../../../models/meta-data/chapter-source.yaml"
- $ref: "../../../models/meta-data/primary-extra-key.yaml"
- $ref: "../../../models/meta-data/original-title.yaml"
- $ref: "../../../models/meta-data/parent-rating-key.yaml"
- $ref: "../../../models/meta-data/grandparent-rating-key.yaml"
- $ref: "../../../models/meta-data/parent-guid.yaml"
- $ref: "../../../models/meta-data/grandparent-guid.yaml"
- $ref: "../../../models/meta-data/grandparent-slug.yaml"
- $ref: "../../../models/meta-data/grandparent-key.yaml"
- $ref: "../../../models/meta-data/parent-key.yaml"
- $ref: "../../../models/meta-data/grandparent-title.yaml"
- $ref: "../../../models/meta-data/grandparent-thumb.yaml"
- $ref: "../../../models/meta-data/grandparent-theme.yaml"
- $ref: "../../../models/meta-data/grandparent-art.yaml"
- $ref: "../../../models/meta-data/parent-title.yaml"
- $ref: "../../../models/meta-data/parent-index.yaml"
- $ref: "../../../models/meta-data/parent-thumb.yaml"
- $ref: "../../../models/meta-data/rating-image.yaml"
- $ref: "../../../models/meta-data/view-count.yaml"
- $ref: "../../../models/meta-data/view-offset.yaml"
- $ref: "../../../models/meta-data/skip-count.yaml"
- $ref: "../../../models/meta-data/subtype.yaml"
- $ref: "../../../models/meta-data/last-rated-at.yaml"
- $ref: "../../../models/meta-data/created-at-accuracy.yaml"
- $ref: "../../../models/meta-data/created-at-tz-offset.yaml"
- $ref: "../../../models/meta-data/last-viewed-at.yaml"
- $ref: "../../../models/meta-data/user-rating.yaml"
- $ref: "../../../models/meta-data/objects/image.yaml"
- $ref: "../../../models/meta-data/objects/ultra-blur-colors.yaml"
- type: object
properties:
Media:
allOf:
- $ref: "../../../models/Media-data.yaml"
Genre:
type: array
items:
allOf:
- $ref: "../../../models/genre/tag.yaml"
Country:
type: array
items:
allOf:
- $ref: "../../../models/country/tag.yaml"
Director:
type: array
items:
allOf:
- $ref: "../../../models/director/tag.yaml"
Writer:
type: array
items:
allOf:
- $ref: "../../../models/writer/tag.yaml"
Role:
type: array
items:
allOf:
- $ref: "../../../models/role/tag.yaml"
Guid:
x-speakeasy-name-override: guids
type: array
items:
type: object
properties:
id:
type: string
description: |
The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337
example: tvdb://2337
Collection:
type: array
items:
allOf:
- $ref: "../../../models/collection/tag.yaml"
"400":
$ref: "../../../responses/400.yaml"
"401":
$ref: "../../../responses/401.yaml"
"404":
$ref: "../../../responses/404-html.yaml"

36
src/paths/library/[sectionKey]/get-library-actors.yaml → src/paths/library/sections/[sectionKey]/get-library-actors.yaml
View File

@@ -6,9 +6,9 @@ get:
description: | description: |
Retrieves a list of all the actors that are found for the media in this library. Retrieves a list of all the actors that are found for the media in this library.
parameters: parameters:
- $ref: "../../../parameters/library/section-key.yaml" - $ref: "../../../../parameters/library/section-key.yaml"
- $ref: "../../../parameters/type.yaml" - $ref: "../../../../parameters/type.yaml"
- $ref: "../../../parameters/accept-application-json.yaml" - $ref: "../../../../parameters/accept-application-json.yaml"
responses: responses:
"200": "200":
description: Successful response containing media container data. description: Successful response containing media container data.
@@ -19,18 +19,18 @@ get:
properties: properties:
MediaContainer: MediaContainer:
allOf: allOf:
- $ref: "../../../models/media-container/size.yaml" - $ref: "../../../../models/media-container/size.yaml"
- $ref: "../../../models/media-container/allow-sync.yaml" - $ref: "../../../../models/media-container/allow-sync.yaml"
- $ref: "../../../models/media-container/art.yaml" - $ref: "../../../../models/media-container/art.yaml"
- $ref: "../../../models/media-container/identifier.yaml" - $ref: "../../../../models/media-container/identifier.yaml"
- $ref: "../../../models/media-container/media-tag-prefix.yaml" - $ref: "../../../../models/media-container/media-tag-prefix.yaml"
- $ref: "../../../models/media-container/media-tag-version.yaml" - $ref: "../../../../models/media-container/media-tag-version.yaml"
- $ref: "../../../models/media-container/nocache.yaml" - $ref: "../../../../models/media-container/nocache.yaml"
- $ref: "../../../models/media-container/thumb.yaml" - $ref: "../../../../models/media-container/thumb.yaml"
- $ref: "../../../models/media-container/title1.yaml" - $ref: "../../../../models/media-container/title1.yaml"
- $ref: "../../../models/media-container/title2.yaml" - $ref: "../../../../models/media-container/title2.yaml"
- $ref: "../../../models/media-container/view-group.yaml" - $ref: "../../../../models/media-container/view-group.yaml"
- $ref: "../../../models/media-container/view-mode.yaml" - $ref: "../../../../models/media-container/view-mode.yaml"
- type: object - type: object
properties: properties:
Directory: Directory:
@@ -61,8 +61,8 @@ get:
description: "The name of the actor." description: "The name of the actor."
example: "Aaron Paul" example: "Aaron Paul"
"400": "400":
$ref: "../../../responses/400.yaml" $ref: "../../../../responses/400.yaml"
"401": "401":
$ref: "../../../responses/401.yaml" $ref: "../../../../responses/401.yaml"
"404": "404":
$ref: "../../../responses/404-html.yaml" $ref: "../../../../responses/404-html.yaml"

36
src/paths/library/[sectionKey]/get-library-countries.yaml → src/paths/library/sections/[sectionKey]/get-library-countries.yaml
View File

@@ -6,9 +6,9 @@ get:
description: | description: |
Retrieves a list of all the countries that are found for the media in this library. Retrieves a list of all the countries that are found for the media in this library.
parameters: parameters:
- $ref: "../../../parameters/library/section-key.yaml" - $ref: "../../../../parameters/library/section-key.yaml"
- $ref: "../../../parameters/type.yaml" - $ref: "../../../../parameters/type.yaml"
- $ref: "../../../parameters/accept-application-json.yaml" - $ref: "../../../../parameters/accept-application-json.yaml"
responses: responses:
"200": "200":
description: Successful response containing media container data. description: Successful response containing media container data.
@@ -19,18 +19,18 @@ get:
properties: properties:
MediaContainer: MediaContainer:
allOf: allOf:
- $ref: "../../../models/media-container/size.yaml" - $ref: "../../../../models/media-container/size.yaml"
- $ref: "../../../models/media-container/allow-sync.yaml" - $ref: "../../../../models/media-container/allow-sync.yaml"
- $ref: "../../../models/media-container/art.yaml" - $ref: "../../../../models/media-container/art.yaml"
- $ref: "../../../models/media-container/content.yaml" - $ref: "../../../../models/media-container/content.yaml"
- $ref: "../../../models/media-container/identifier.yaml" - $ref: "../../../../models/media-container/identifier.yaml"
- $ref: "../../../models/media-container/media-tag-prefix.yaml" - $ref: "../../../../models/media-container/media-tag-prefix.yaml"
- $ref: "../../../models/media-container/media-tag-version.yaml" - $ref: "../../../../models/media-container/media-tag-version.yaml"
- $ref: "../../../models/media-container/nocache.yaml" - $ref: "../../../../models/media-container/nocache.yaml"
- $ref: "../../../models/media-container/thumb.yaml" - $ref: "../../../../models/media-container/thumb.yaml"
- $ref: "../../../models/media-container/title1.yaml" - $ref: "../../../../models/media-container/title1.yaml"
- $ref: "../../../models/media-container/title2.yaml" - $ref: "../../../../models/media-container/title2.yaml"
- $ref: "../../../models/media-container/view-group.yaml" - $ref: "../../../../models/media-container/view-group.yaml"
- type: object - type: object
properties: properties:
Directory: Directory:
@@ -52,8 +52,8 @@ get:
type: string type: string
example: "Japan" example: "Japan"
"400": "400":
$ref: "../../../responses/400.yaml" $ref: "../../../../responses/400.yaml"
"401": "401":
$ref: "../../../responses/401.yaml" $ref: "../../../../responses/401.yaml"
"404": "404":
$ref: "../../../responses/404-html.yaml" $ref: "../../../../responses/404-html.yaml"

36
src/paths/library/[sectionKey]/get-library-genres.yaml → src/paths/library/sections/[sectionKey]/get-library-genres.yaml
View File

@@ -6,9 +6,9 @@ get:
description: | description: |
Retrieves a list of all the genres that are found for the media in this library. Retrieves a list of all the genres that are found for the media in this library.
parameters: parameters:
- $ref: "../../../parameters/library/section-key.yaml" - $ref: "../../../../parameters/library/section-key.yaml"
- $ref: "../../../parameters/type.yaml" - $ref: "../../../../parameters/type.yaml"
- $ref: "../../../parameters/accept-application-json.yaml" - $ref: "../../../../parameters/accept-application-json.yaml"
responses: responses:
"200": "200":
description: Successful response containing media container data. description: Successful response containing media container data.
@@ -19,18 +19,18 @@ get:
properties: properties:
MediaContainer: MediaContainer:
allOf: allOf:
- $ref: "../../../models/media-container/size.yaml" - $ref: "../../../../models/media-container/size.yaml"
- $ref: "../../../models/media-container/allow-sync.yaml" - $ref: "../../../../models/media-container/allow-sync.yaml"
- $ref: "../../../models/media-container/art.yaml" - $ref: "../../../../models/media-container/art.yaml"
- $ref: "../../../models/media-container/content.yaml" - $ref: "../../../../models/media-container/content.yaml"
- $ref: "../../../models/media-container/identifier.yaml" - $ref: "../../../../models/media-container/identifier.yaml"
- $ref: "../../../models/media-container/media-tag-prefix.yaml" - $ref: "../../../../models/media-container/media-tag-prefix.yaml"
- $ref: "../../../models/media-container/media-tag-version.yaml" - $ref: "../../../../models/media-container/media-tag-version.yaml"
- $ref: "../../../models/media-container/nocache.yaml" - $ref: "../../../../models/media-container/nocache.yaml"
- $ref: "../../../models/media-container/thumb.yaml" - $ref: "../../../../models/media-container/thumb.yaml"
- $ref: "../../../models/media-container/title1.yaml" - $ref: "../../../../models/media-container/title1.yaml"
- $ref: "../../../models/media-container/title2.yaml" - $ref: "../../../../models/media-container/title2.yaml"
- $ref: "../../../models/media-container/view-group.yaml" - $ref: "../../../../models/media-container/view-group.yaml"
- type: object - type: object
properties: properties:
Directory: Directory:
@@ -56,8 +56,8 @@ get:
type: string type: string
example: "genre" example: "genre"
"400": "400":
$ref: "../../../responses/400.yaml" $ref: "../../../../responses/400.yaml"
"401": "401":
$ref: "../../../responses/401.yaml" $ref: "../../../../responses/401.yaml"
"404": "404":
$ref: "../../../responses/404-html.yaml" $ref: "../../../../responses/404-html.yaml"

26
src/paths/library/[sectionKey]/get-library-items.yaml → src/paths/library/sections/[sectionKey]/get-library-items.yaml
View File

@@ -55,14 +55,14 @@ get:
description: | description: |
Adds the Guids object to the response Adds the Guids object to the response
schema: schema:
$ref: "../../../models/common/PlexBoolean.yaml" $ref: "../../../../models/common/PlexBoolean.yaml"
- $ref: "../../../parameters/type.yaml" - $ref: "../../../../parameters/type.yaml"
- $ref: "../../../parameters/library/section-key.yaml" - $ref: "../../../../parameters/library/section-key.yaml"
- $ref: "../../../parameters/include-meta.yaml" - $ref: "../../../../parameters/include-meta.yaml"
- $ref: "../../../parameters/container-start.yaml" - $ref: "../../../../parameters/container-start.yaml"
- $ref: "../../../parameters/container-size.yaml" - $ref: "../../../../parameters/container-size.yaml"
- $ref: "../../../parameters/accept-application-json.yaml" - $ref: "../../../../parameters/accept-application-json.yaml"
responses: responses:
"200": "200":
description: The contents of the library by section and tag description: The contents of the library by section and tag
@@ -73,7 +73,7 @@ get:
properties: properties:
MediaContainer: MediaContainer:
allOf: allOf:
- $ref: "../../../models/Meta.yaml" - $ref: "../../../../models/Meta.yaml"
- type: object - type: object
required: required:
- size - size
@@ -160,7 +160,7 @@ get:
Metadata: Metadata:
type: array type: array
items: items:
$ref: "../../../models/MetaData.yaml" $ref: "../../../../models/MetaData.yaml"
Meta: Meta:
description: | description: |
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`. The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
@@ -230,9 +230,9 @@ get:
type: boolean type: boolean
example: false example: false
activeDirection: activeDirection:
$ref: "../../../models/common/PlexSortDirection.yaml" $ref: "../../../../models/common/PlexSortDirection.yaml"
defaultDirection: defaultDirection:
$ref: "../../../models/common/PlexSortDirection.yaml" $ref: "../../../../models/common/PlexSortDirection.yaml"
descKey: descKey:
type: string type: string
example: "titleSort:desc" example: "titleSort:desc"
@@ -293,6 +293,6 @@ get:
example: "is" example: "is"
"400": "400":
$ref: "../../../responses/400.yaml" $ref: "../../../../responses/400.yaml"
"401": "401":
$ref: "../../../responses/401.yaml" $ref: "../../../../responses/401.yaml"

164
src/paths/library/sections/[sectionKey]/get-library-sections-all.yaml Normal file
View File

@@ -0,0 +1,164 @@
get:
tags:
- Library
summary: Get all media of library
operationId: get-library-sections-all
description: |
Retrieves a list of all general media data for this library.
parameters:
- $ref: "../../../../parameters/library/section-key.yaml"
- $ref: "../../../../parameters/type.yaml"
- $ref: "../../../../parameters/include-meta.yaml"
- $ref: "../../../../parameters/include-guids.yaml"
- $ref: "../../../../parameters/include-advanced.yaml"
- $ref: "../../../../parameters/include-collections.yaml"
- $ref: "../../../../parameters/include-external-media.yaml"
- $ref: "../../../../parameters/container-start.yaml"
- $ref: "../../../../parameters/container-size.yaml"
- $ref: "../../../../parameters/accept-application-json.yaml"
responses:
"200":
description: Successful response containing media container data.
content:
application/json:
schema:
type: object
properties:
MediaContainer:
allOf:
- $ref: "../../../../models/media-container/size.yaml"
- $ref: "../../../../models/media-container/total-size.yaml"
- $ref: "../../../../models/media-container/offset.yaml"
- $ref: "../../../../models/media-container/allow-sync.yaml"
- $ref: "../../../../models/media-container/art.yaml"
- $ref: "../../../../models/media-container/content.yaml"
- $ref: "../../../../models/media-container/identifier.yaml"
- $ref: "../../../../models/media-container/library-section-id.yaml"
- $ref: "../../../../models/media-container/library-section-title.yaml"
- $ref: "../../../../models/media-container/library-section-uuid.yaml"
- $ref: "../../../../models/media-container/media-tag-prefix.yaml"
- $ref: "../../../../models/media-container/media-tag-version.yaml"
- $ref: "../../../../models/media-container/thumb.yaml"
- $ref: "../../../../models/media-container/nocache.yaml"
- $ref: "../../../../models/media-container/title1.yaml"
- $ref: "../../../../models/media-container/title2.yaml"
- $ref: "../../../../models/media-container/view-group.yaml"
- type: object
properties:
Meta:
$ref: "../../../../models/Meta.yaml"
Metadata:
type: array
description: "An array of metadata items."
items:
required:
- type
allOf:
- $ref: "../../../../models/meta-data/rating-key.yaml"
- $ref: "../../../../models/meta-data/key.yaml"
- $ref: "../../../../models/meta-data/guid.yaml"
- $ref: "../../../../models/meta-data/slug.yaml"
- $ref: "../../../../models/meta-data/studio.yaml"
- $ref: "../../../../models/meta-data/type.yaml"
- $ref: "../../../../models/meta-data/title.yaml"
- $ref: "../../../../models/meta-data/title-sort.yaml"
- $ref: "../../../../models/meta-data/content-rating.yaml"
- $ref: "../../../../models/meta-data/summary.yaml"
- $ref: "../../../../models/meta-data/rating.yaml"
- $ref: "../../../../models/meta-data/audience-rating.yaml"
- $ref: "../../../../models/meta-data/year.yaml"
- $ref: "../../../../models/meta-data/tagline.yaml"
- $ref: "../../../../models/meta-data/thumb.yaml"
- $ref: "../../../../models/meta-data/art.yaml"
- $ref: "../../../../models/meta-data/theme.yaml"
- $ref: "../../../../models/meta-data/index.yaml"
- $ref: "../../../../models/meta-data/leaf-count.yaml"
- $ref: "../../../../models/meta-data/viewed-leaf-count.yaml"
- $ref: "../../../../models/meta-data/child-count.yaml"
- $ref: "../../../../models/meta-data/season-count.yaml"
- $ref: "../../../../models/meta-data/duration.yaml"
- $ref: "../../../../models/meta-data/originally-available-at.yaml"
- $ref: "../../../../models/meta-data/added-at.yaml"
- $ref: "../../../../models/meta-data/updated-at.yaml"
- $ref: "../../../../models/meta-data/audience-rating-image.yaml"
- $ref: "../../../../models/meta-data/chapter-source.yaml"
- $ref: "../../../../models/meta-data/primary-extra-key.yaml"
- $ref: "../../../../models/meta-data/original-title.yaml"
- $ref: "../../../../models/meta-data/parent-rating-key.yaml"
- $ref: "../../../../models/meta-data/grandparent-rating-key.yaml"
- $ref: "../../../../models/meta-data/parent-guid.yaml"
- $ref: "../../../../models/meta-data/grandparent-guid.yaml"
- $ref: "../../../../models/meta-data/grandparent-slug.yaml"
- $ref: "../../../../models/meta-data/grandparent-key.yaml"
- $ref: "../../../../models/meta-data/parent-key.yaml"
- $ref: "../../../../models/meta-data/grandparent-title.yaml"
- $ref: "../../../../models/meta-data/grandparent-thumb.yaml"
- $ref: "../../../../models/meta-data/grandparent-theme.yaml"
- $ref: "../../../../models/meta-data/grandparent-art.yaml"
- $ref: "../../../../models/meta-data/parent-title.yaml"
- $ref: "../../../../models/meta-data/parent-index.yaml"
- $ref: "../../../../models/meta-data/parent-thumb.yaml"
- $ref: "../../../../models/meta-data/rating-image.yaml"
- $ref: "../../../../models/meta-data/view-count.yaml"
- $ref: "../../../../models/meta-data/view-offset.yaml"
- $ref: "../../../../models/meta-data/skip-count.yaml"
- $ref: "../../../../models/meta-data/subtype.yaml"
- $ref: "../../../../models/meta-data/last-rated-at.yaml"
- $ref: "../../../../models/meta-data/created-at-accuracy.yaml"
- $ref: "../../../../models/meta-data/created-at-tz-offset.yaml"
- $ref: "../../../../models/meta-data/last-viewed-at.yaml"
- $ref: "../../../../models/meta-data/user-rating.yaml"
- $ref: "../../../../models/meta-data/objects/image.yaml"
- $ref: "../../../../models/meta-data/objects/ultra-blur-colors.yaml"
- type: object
properties:
Media:
allOf:
- $ref: "../../../../models/Media-data.yaml"
Genre:
type: array
items:
allOf:
- $ref: "../../../../models/genre/tag.yaml"
Country:
type: array
items:
allOf:
- $ref: "../../../../models/country/tag.yaml"
Director:
type: array
items:
allOf:
- $ref: "../../../../models/director/tag.yaml"
Writer:
type: array
items:
allOf:
- $ref: "../../../../models/writer/tag.yaml"
Role:
type: array
items:
allOf:
- $ref: "../../../../models/role/tag.yaml"
Guid:
x-speakeasy-name-override: guids
type: array
items:
type: object
properties:
id:
type: string
description: |
The unique identifier for the Guid. Can be imdb://tt0286347, tmdb://1763, tvdb://2337
example: tvdb://2337
Collection:
type: array
items:
allOf:
- $ref: "../../../../models/collection/tag.yaml"
"400":
$ref: "../../../../responses/400.yaml"
"401":
$ref: "../../../../responses/401.yaml"
"404":
$ref: "../../../../responses/404-html.yaml"

10
src/paths/library/[sectionKey]/get-search-library.yaml → src/paths/library/sections/[sectionKey]/get-search-library.yaml
View File

@@ -23,9 +23,9 @@ get:
> **Note**: Filters and sorts are optional; without them, no filtering controls are rendered. > **Note**: Filters and sorts are optional; without them, no filtering controls are rendered.
parameters: parameters:
- $ref: "../../../parameters/library/section-key.yaml" - $ref: "../../../../parameters/library/section-key.yaml"
- $ref: "../../../parameters/accept-application-json.yaml" - $ref: "../../../../parameters/accept-application-json.yaml"
- $ref: "../../../parameters/type.yaml" - $ref: "../../../../parameters/type.yaml"
responses: responses:
"200": "200":
description: The contents of the library by section and type description: The contents of the library by section and type
@@ -157,6 +157,6 @@ get:
format: int32 format: int32
example: 1705636920 example: 1705636920
"400": "400":
$ref: "../../../responses/400.yaml" $ref: "../../../../responses/400.yaml"
"401": "401":
$ref: "../../../responses/401.yaml" $ref: "../../../../responses/401.yaml"

12
src/paths/library/[sectionKey]/library-section.yaml → src/paths/library/sections/[sectionKey]/library-section.yaml
View File

@@ -57,7 +57,7 @@ get:
- 1 - 1
default: 0 default: 0
required: false required: false
- $ref: "../../../parameters/library/section-key.yaml" - $ref: "../../../../parameters/library/section-key.yaml"
responses: responses:
"200": "200":
description: The details of the library description: The details of the library
@@ -226,9 +226,9 @@ get:
type: string type: string
example: is example: is
"400": "400":
$ref: "../../../responses/400.yaml" $ref: "../../../../responses/400.yaml"
"401": "401":
$ref: "../../../responses/401.yaml" $ref: "../../../../responses/401.yaml"
delete: delete:
tags: tags:
@@ -237,11 +237,11 @@ delete:
description: Delete a library using a specific section id description: Delete a library using a specific section id
operationId: deleteLibrary operationId: deleteLibrary
parameters: parameters:
- $ref: "../../../parameters/library/section-key.yaml" - $ref: "../../../../parameters/library/section-key.yaml"
responses: responses:
"200": "200":
description: The library is deleted description: The library is deleted
"400": "400":
$ref: "../../../responses/400.yaml" $ref: "../../../../responses/400.yaml"
"401": "401":
$ref: "../../../responses/401.yaml" $ref: "../../../../responses/401.yaml"

6
src/paths/library/[sectionKey]/refresh/get-refresh-library-metadata.yaml → src/paths/library/sections/[sectionKey]/refresh/get-refresh-library-metadata.yaml
View File

@@ -16,12 +16,12 @@ get:
- 0 - 0
- 1 - 1
required: false required: false
- $ref: "../../../../parameters/library/section-key.yaml" - $ref: "../../../../../parameters/library/section-key.yaml"
responses: responses:
"200": "200":
description: The library is refreshing description: The library is refreshing
"400": "400":
$ref: "../../../../responses/400.yaml" $ref: "../../../../../responses/400.yaml"
"401": "401":
$ref: "../../../../responses/401.yaml" $ref: "../../../../../responses/401.yaml"

16
src/pms-spec.yaml
View File

@@ -157,26 +157,26 @@ paths:
$ref: "./paths/library/get-all-libraries.yaml" $ref: "./paths/library/get-all-libraries.yaml"
/library/sections/{sectionKey}: /library/sections/{sectionKey}:
$ref: "./paths/library/[sectionKey]/library-section.yaml" $ref: "./paths/library/sections/[sectionKey]/library-section.yaml"
# Watchlist # Watchlist
/library/sections/watchlist/{filter}: /library/sections/watchlist/{filter}:
$ref: "./paths/library/sections/watchlist/get-watch-list.yaml" $ref: "./paths/library/sections/watchlist/get-watch-list.yaml"
/library/sections/{sectionKey}/{tag}: /library/sections/{sectionKey}/{tag}:
$ref: "./paths/library/[sectionKey]/get-library-items.yaml" $ref: "./paths/library/sections/[sectionKey]/get-library-items.yaml"
/library/sections/{sectionKey}/all: /library/sections/{sectionKey}/all:
$ref: "./paths/library/[sectionKey]/get-library-all.yaml" $ref: "./paths/library/sections/[sectionKey]/get-library-sections-all.yaml"
/library/sections/{sectionKey}/refresh: /library/sections/{sectionKey}/refresh:
$ref: "./paths/library/[sectionKey]/refresh/get-refresh-library-metadata.yaml" $ref: "./paths/library/sections/[sectionKey]/refresh/get-refresh-library-metadata.yaml"
/library/sections/{sectionKey}/search: /library/sections/{sectionKey}/search:
$ref: "./paths/library/[sectionKey]/get-search-library.yaml" $ref: "./paths/library/sections/[sectionKey]/get-search-library.yaml"
/library/sections/{sectionKey}/genre: /library/sections/{sectionKey}/genre:
$ref: "./paths/library/[sectionKey]/get-library-genres.yaml" $ref: "./paths/library/sections/[sectionKey]/get-library-genres.yaml"
/library/sections/{sectionKey}/country: /library/sections/{sectionKey}/country:
$ref: "./paths/library/[sectionKey]/get-library-countries.yaml" $ref: "./paths/library/sections/[sectionKey]/get-library-countries.yaml"
/library/sections/{sectionKey}/actor: /library/sections/{sectionKey}/actor:
$ref: "./paths/library/[sectionKey]/get-library-actors.yaml" $ref: "./paths/library/sections/[sectionKey]/get-library-actors.yaml"
/library/search: /library/search:
$ref: "./paths/library/get-search-all-libraries.yaml" $ref: "./paths/library/get-search-all-libraries.yaml"