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

more fixes

Browse Source
This commit is contained in:
JasonLandbridge
2024-09-17 17:45:03 +02:00
parent 8e9339b46c
commit bff472e4ee
3 changed files with 378 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

204
output/plex-media-server-spec-dereferenced.yaml
View File

@@ -3887,22 +3887,30 @@ paths:
Adds the Guids object to the response Adds the Guids object to the response
schema: schema:
type: integer type: integer
format: int32
enum: enum:
- 0 - 0
- 1 - 1
example: 1 example: 1
required: false default: 0
x-speakeasy-enums:
- DISABLE
- ENABLE
- name: includeMeta - name: includeMeta
in: query in: query
description: | description: |
Adds the Meta object to the response Adds the Meta object to the response
schema: schema:
type: integer type: integer
format: int32
enum: enum:
- 0 - 0
- 1 - 1
example: 1 example: 1
required: false default: 0
x-speakeasy-enums:
- DISABLE
- ENABLE
- name: type - name: type
in: query in: query
description: | description: |
@@ -3920,6 +3928,11 @@ paths:
- 3 - 3
- 4 - 4
example: 2 example: 2
x-speakeasy-enums:
- MOVIE
- SHOW
- SEASON
- EPISODE
required: true required: true
- name: X-Plex-Container-Start - name: X-Plex-Container-Start
in: query in: query
@@ -3964,6 +3977,23 @@ paths:
properties: properties:
MediaContainer: MediaContainer:
type: object type: object
required:
- size
- totalSize
- offset
- allowSync
- art
- content
- identifier
- librarySectionID
- librarySectionTitle
- librarySectionUUID
- mediaTagPrefix
- mediaTagVersion
- thumb
- title1
- title2
- viewGroup
properties: properties:
size: size:
type: integer type: integer
@@ -4021,6 +4051,15 @@ paths:
type: array type: array
items: items:
type: object type: object
required:
- ratingKey
- key
- guid
- title
- type
- year
- duration
- Media
properties: properties:
ratingKey: ratingKey:
type: string type: string
@@ -4233,6 +4272,22 @@ paths:
tag: tag:
type: string type: string
example: Sigourney Weaver example: Sigourney Weaver
Guid:
x-speakeasy-name-override: MediaGuid
description: |
The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.
type: array
items:
type: object
required:
- id
properties:
id:
type: string
description: |
Can be one of the following formats:
imdb://tt13015952, tmdb://2434012, tvdb://7945991
example: 'imdb://tt13015952'
titleSort: titleSort:
type: string type: string
example: Whale example: Whale
@@ -4309,6 +4364,132 @@ paths:
parentTheme: parentTheme:
type: string type: string
example: /library/metadata/66/theme/1705716261 example: /library/metadata/66/theme/1705716261
Meta:
description: |
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
type: object
properties:
Type:
type: array
items:
type: object
required:
- key
- type
- title
- active
properties:
key:
type: string
example: /library/sections/2/all?type=2
type:
type: string
example: show
title:
type: string
example: TV Shows
active:
type: boolean
example: false
Filter:
type: array
items:
type: object
required:
- filter
- filterType
- key
- title
- type
properties:
filter:
type: string
example: genre
filterType:
type: string
example: string
key:
type: string
example: /library/sections/2/genre?type=2
title:
type: string
example: Genre
type:
type: string
example: filter
Sort:
type: array
items:
type: object
required:
- key
- title
- defaultDirection
properties:
default:
type: string
example: asc
defaultDirection:
type: string
example: asc
descKey:
type: string
example: 'titleSort:desc'
firstCharacterKey:
type: string
example: /library/sections/2/firstCharacter
key:
type: string
example: titleSort
title:
type: string
example: Title
Field:
type: array
items:
type: object
required:
- key
- title
- type
properties:
key:
type: string
example: show.title
title:
type: string
example: Show Title
type:
type: string
example: string
subType:
type: string
example: rating
FieldType:
type: array
items:
type: object
required:
- type
- Operator
properties:
type:
type: string
example: tag
Operator:
type: array
items:
type: object
required:
- key
- title
properties:
key:
type: string
example: '='
title:
type: string
example: is
'400': '400':
description: 'Bad Request - A parameter was not specified, or was specified incorrectly.' description: 'Bad Request - A parameter was not specified, or was specified incorrectly.'
content: content:
@@ -4495,6 +4676,11 @@ paths:
- 3 - 3
- 4 - 4
example: 2 example: 2
x-speakeasy-enums:
- MOVIE
- SHOW
- SEASON
- EPISODE
required: true required: true
responses: responses:
'200': '200':
@@ -5816,6 +6002,11 @@ paths:
- 3 - 3
- 4 - 4
example: 2 example: 2
x-speakeasy-enums:
- MOVIE
- SHOW
- SEASON
- EPISODE
required: true required: true
- name: includeGuids - name: includeGuids
in: query in: query
@@ -8187,6 +8378,11 @@ paths:
- 3 - 3
- 4 - 4
example: 2 example: 2
x-speakeasy-enums:
- MOVIE
- SHOW
- SEASON
- EPISODE
required: true required: true
responses: responses:
'200': '200':

5
src/parameters/type.yaml
View File

@@ -15,4 +15,9 @@ schema:
- 3 - 3
- 4 - 4
example: 2 example: 2
x-speakeasy-enums:
- MOVIE
- SHOW
- SEASON
- EPISODE
required: true required: true

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

@@ -57,23 +57,13 @@ get:
description: | description: |
Adds the Guids object to the response Adds the Guids object to the response
schema: schema:
type: integer $ref: "../../../models/common/PlexBoolean.yaml"
enum:
- 0
- 1
example: 1
required: false
- name: includeMeta - name: includeMeta
in: query in: query
description: | description: |
Adds the Meta object to the response Adds the Meta object to the response
schema: schema:
type: integer $ref: "../../../models/common/PlexBoolean.yaml"
enum:
- 0
- 1
example: 1
required: false
- $ref: "../../../parameters/type.yaml" - $ref: "../../../parameters/type.yaml"
- $ref: "../../../parameters/container-start.yaml" - $ref: "../../../parameters/container-start.yaml"
- $ref: "../../../parameters/container-size.yaml" - $ref: "../../../parameters/container-size.yaml"
@@ -88,6 +78,23 @@ get:
properties: properties:
MediaContainer: MediaContainer:
type: object type: object
required:
- size
- totalSize
- offset
- allowSync
- art
- content
- identifier
- librarySectionID
- librarySectionTitle
- librarySectionUUID
- mediaTagPrefix
- mediaTagVersion
- thumb
- title1
- title2
- viewGroup
properties: properties:
size: size:
type: integer type: integer
@@ -143,6 +150,15 @@ get:
type: array type: array
items: items:
type: object type: object
required:
- ratingKey
- key
- guid
- title
- type
- year
- duration
- Media
properties: properties:
ratingKey: ratingKey:
type: string type: string
@@ -360,6 +376,22 @@ get:
tag: tag:
type: string type: string
example: Sigourney Weaver example: Sigourney Weaver
Guid:
x-speakeasy-name-override: MediaGuid
description: |
The Guid object is only included in the response if the `includeGuids` parameter is set to `1`.
type: array
items:
type: object
required:
- id
properties:
id:
type: string
description: |
Can be one of the following formats:
imdb://tt13015952, tmdb://2434012, tvdb://7945991
example: imdb://tt13015952
titleSort: titleSort:
type: string type: string
example: Whale example: Whale
@@ -436,6 +468,135 @@ get:
parentTheme: parentTheme:
type: string type: string
example: /library/metadata/66/theme/1705716261 example: /library/metadata/66/theme/1705716261
Meta:
description: |
The Meta object is only included in the response if the `includeMeta` parameter is set to `1`.
type: object
properties:
Type:
type: array
items:
type: object
required:
- key
- type
- title
- active
- Filter
- Sort
properties:
key:
type: string
example: "/library/sections/2/all?type=2"
type:
type: string
example: "show"
title:
type: string
example: "TV Shows"
active:
type: boolean
example: false
Filter:
type: array
items:
type: object
required:
- filter
- filterType
- key
- title
- type
properties:
filter:
type: string
example: "genre"
filterType:
type: string
example: "string"
key:
type: string
example: "/library/sections/2/genre?type=2"
title:
type: string
example: "Genre"
type:
type: string
example: "filter"
Sort:
type: array
items:
type: object
required:
- key
- title
- defaultDirection
properties:
default:
type: string
example: "asc"
defaultDirection:
type: string
example: "asc"
descKey:
type: string
example: "titleSort:desc"
firstCharacterKey:
type: string
example: "/library/sections/2/firstCharacter"
key:
type: string
example: "titleSort"
title:
type: string
example: "Title"
Field:
type: array
items:
type: object
required:
- key
- title
- type
properties:
key:
type: string
example: "show.title"
title:
type: string
example: "Show Title"
type:
type: string
example: "string"
subType:
type: string
example: "rating"
FieldType:
type: array
items:
type: object
required:
- type
- Operator
properties:
type:
type: string
example: "tag"
Operator:
type: array
items:
type: object
required:
- key
- title
properties:
key:
type: string
example: "="
title:
type: string
example: "is"
"400": "400":
$ref: "../../../responses/400.yaml" $ref: "../../../responses/400.yaml"
"401": "401":