added missing properties

This commit is contained in:
JasonLandbridge
2024-09-20 11:47:39 +02:00
parent 31e12e43e9
commit 1a85d7298f
5 changed files with 1642 additions and 28 deletions

View File

@@ -18,7 +18,7 @@
"preview-docs": "redocly preview-docs src/pms-spec.yaml --config=./redocly.yaml", "preview-docs": "redocly preview-docs src/pms-spec.yaml --config=./redocly.yaml",
"stats": "redocly stats ./src/pms-spec.yaml", "stats": "redocly stats ./src/pms-spec.yaml",
"build": "swagger-cli bundle --dereference ./src/pms-spec.yaml -t yaml -o ./output/plex-media-server-spec-dereferenced.yaml", "build": "swagger-cli bundle --dereference ./src/pms-spec.yaml -t yaml -o ./output/plex-media-server-spec-dereferenced.yaml",
"build-watch": "chokidar './src/**/*' -c 'bun run build'", "build-watch": "bun run build && chokidar './src/**/*' -c 'bun run build'",
"build-redocly": "redocly bundle ./src/pms-spec.yaml --ext yaml -o ./output/plex-media-server-spec-dereferenced.yaml", "build-redocly": "redocly bundle ./src/pms-spec.yaml --ext yaml -o ./output/plex-media-server-spec-dereferenced.yaml",
"test": "bun run build && vitest --run", "test": "bun run build && vitest --run",
"type-check": "tsc", "type-check": "tsc",

View File

@@ -1,21 +1,11 @@
type: integer type: integer
enum: enum:
- 0
- 1 - 1
- 2 - 2
- 3 - 3
- 4 - 4
example: 2 example: 2
default: 0
description: |
The type of media to retrieve.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
x-speakeasy-enums: x-speakeasy-enums:
- NONE
- MOVIE - MOVIE
- TV_SHOW - TV_SHOW
- SEASON - SEASON

View File

@@ -8,16 +8,6 @@ description: |
4 = episode 4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
schema: schema:
type: integer $ref: "../models/common/PlexMediaType.yaml"
enum:
- 1
- 2
- 3
- 4
example: 2
x-speakeasy-enums:
- MOVIE
- SHOW
- SEASON
- EPISODE
required: true required: true

View File

@@ -64,7 +64,18 @@ get:
Adds the Meta object to the response Adds the Meta object to the response
schema: schema:
$ref: "../../../models/common/PlexBoolean.yaml" $ref: "../../../models/common/PlexBoolean.yaml"
- $ref: "../../../parameters/type.yaml" - name: type
in: query
description: |
The type of media to retrieve.
1 = movie
2 = show
3 = season
4 = episode
E.g. A movie library will not return anything with type 3 as there are no seasons for movie libraries
required: false
schema:
$ref: "../../../models/common/PlexMediaType.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"
@@ -172,11 +183,7 @@ get:
- guid - guid
- title - title
- type - type
- year
- duration
- addedAt - addedAt
- Media
- UltraBlurColors
properties: properties:
ratingKey: ratingKey:
type: string type: string
@@ -193,6 +200,9 @@ get:
studio: studio:
type: string type: string
example: 20th Century Studios example: 20th Century Studios
skipChildren:
type: boolean
example: false
type: type:
$ref: "../../../models/common/PlexMediaTypeString.yaml" $ref: "../../../models/common/PlexMediaTypeString.yaml"
title: title:
@@ -221,9 +231,37 @@ get:
type: integer type: integer
format: int32 format: int32
example: 2022 example: 2022
seasonCount:
type: integer
format: int32
example: 2022
tagline: tagline:
type: string type: string
example: Return to Pandora. example: Return to Pandora.
flattenSeasons:
$ref: "../../../models/common/PlexBooleanString.yaml"
showOrdering:
type: string
description: |
Setting that indicates the episode ordering for the show
None = Library default,
tmdbAiring = The Movie Database (Aired),
aired = TheTVDB (Aired),
dvd = TheTVDB (DVD),
absolute = TheTVDB (Absolute)).
enum:
- None
- tmdbAiring
- aired
- dvd
- absolute
x-speakeasy-enums:
- NONE
- TMDB_AIRING
- AIRED
- DVD
- ABSOLUTE
example: dvd
thumb: thumb:
type: string type: string
example: /library/metadata/58683/thumb/1703239236 example: /library/metadata/58683/thumb/1703239236
@@ -282,6 +320,8 @@ get:
type: string type: string
example: /library/metadata/66/theme/1705716261 example: /library/metadata/66/theme/1705716261
Media: Media:
description: |
The Media object is only included when type query is `4` or higher.
type: array type: array
items: items:
type: object type: object

File diff suppressed because it is too large Load Diff