mirror of
https://github.com/LukeHagar/plex-api-spec.git
synced 2025-12-11 04:20:52 +00:00
feat: add new YAML schemas for media search results and related properties
This commit is contained in:
@@ -0,0 +1,6 @@
|
||||
type: object
|
||||
properties:
|
||||
count:
|
||||
description: "The number of items associated with this search result."
|
||||
type: integer
|
||||
example: 10
|
||||
@@ -0,0 +1,6 @@
|
||||
type: object
|
||||
properties:
|
||||
filter:
|
||||
description: "The filter string used to query this specific item in the library."
|
||||
type: string
|
||||
example: "actor=197429"
|
||||
@@ -0,0 +1,5 @@
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
example: 197429
|
||||
@@ -0,0 +1,6 @@
|
||||
type: object
|
||||
properties:
|
||||
key:
|
||||
description: "The unique identifier path for the search result item."
|
||||
type: string
|
||||
example: "/library/sections/3/all?actor=197429"
|
||||
@@ -0,0 +1,6 @@
|
||||
type: object
|
||||
properties:
|
||||
librarySectionID:
|
||||
description: "The unique identifier of the library section containing this item."
|
||||
type: integer
|
||||
example: 3
|
||||
@@ -0,0 +1,6 @@
|
||||
type: object
|
||||
properties:
|
||||
librarySectionKey:
|
||||
description: "The path to access the library section containing this item."
|
||||
type: string
|
||||
example: "/library/sections/3"
|
||||
@@ -0,0 +1,5 @@
|
||||
type: object
|
||||
properties:
|
||||
librarySectionTitle:
|
||||
type: string
|
||||
example: "Movies"
|
||||
@@ -0,0 +1,9 @@
|
||||
type: object
|
||||
properties:
|
||||
librarySectionType:
|
||||
type: integer
|
||||
oneOf:
|
||||
- const: 1
|
||||
title: Movie
|
||||
- const: 2
|
||||
title: TV Show
|
||||
@@ -0,0 +1,6 @@
|
||||
type: object
|
||||
properties:
|
||||
tagKey:
|
||||
description: "The unique identifier for the tag associated with this search result."
|
||||
type: string
|
||||
example: "5d776826999c64001ec2c606"
|
||||
@@ -0,0 +1,10 @@
|
||||
type: object
|
||||
properties:
|
||||
tagType:
|
||||
description: "The type of tag associated with this search result (e.g., Director, Actor)."
|
||||
type: integer
|
||||
oneOf:
|
||||
- const: 4
|
||||
title: Director
|
||||
- const: 6
|
||||
title: Actor
|
||||
@@ -0,0 +1,5 @@
|
||||
type: object
|
||||
properties:
|
||||
tag:
|
||||
type: string
|
||||
example: "Ben Stiller"
|
||||
@@ -0,0 +1,7 @@
|
||||
type: object
|
||||
properties:
|
||||
thumb:
|
||||
description: "The URL to the thumbnail image associated with this search result."
|
||||
type: string
|
||||
format: uri
|
||||
example: "https://metadata-static.plex.tv/5/people/57bd7c7d6c5c9e2881251b30e5603d3d.jpg"
|
||||
@@ -0,0 +1,6 @@
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
description: "The type of the directory."
|
||||
type: string
|
||||
example: tag
|
||||
7
src/models/media-container/search-result/score.yaml
Normal file
7
src/models/media-container/search-result/score.yaml
Normal file
@@ -0,0 +1,7 @@
|
||||
type: object
|
||||
properties:
|
||||
score:
|
||||
description: "The score of the search result, typically a float value between 0 and 1."
|
||||
type: number
|
||||
format: float
|
||||
example: 0.92
|
||||
@@ -1,6 +1,4 @@
|
||||
type: object
|
||||
required:
|
||||
- videoFrameRate
|
||||
properties:
|
||||
videoFrameRate:
|
||||
type: string
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
type: object
|
||||
required:
|
||||
- videoProfile
|
||||
properties:
|
||||
videoProfile:
|
||||
type: string
|
||||
|
||||
Reference in New Issue
Block a user