adding Library endpoint

This commit is contained in:
luke-hagar-sp
2023-03-28 14:06:26 -05:00
parent 7dae9fb563
commit bf36f62f21
3 changed files with 89 additions and 0 deletions

View File

@@ -545,6 +545,47 @@ paths:
description: Source Connection Information
'401':
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
/library/sections/{sectionId}/{category}:
get:
tags:
- Library
summary: Get Library Items
description: |
This endpoint will return a list of library items filtered by the filter and type provided
operationId: startAButlerTasks
parameters:
- name: sectionId
description: the Id of the library to query
in: path
schema:
type: number
required: true
- name: category
description: the Id of the library to query
in: path
schema:
type: string
enum:
- all
- latest
required: true
- name: type
description: item type
in: query
schema:
type: number
required: false
- name: filter
description: the filter parameter
in: query
schema:
type: string
required: false
responses:
'200':
description: The details of the library
'401':
description: Unauthorized - Returned if the X-Plex-Token is missing from the header or query.
tags:
- name: Activities
description: |
@@ -571,3 +612,6 @@ tags:
- name: Security
description: |
API Calls against Security for Plex Media Server
- name: Library
description: |
API Calls interacting with Plex Media Server Libraries

View File

@@ -0,0 +1,40 @@
get:
tags:
- Library
summary: Get Library Items
description: |
This endpoint will return a list of library items filtered by the filter and type provided
operationId: startAButlerTasks
parameters:
- name: sectionId
description: the Id of the library to query
in: path
schema:
type: number
required: true
- name: category
description: the Id of the library to query
in: path
schema:
type: string
enum:
- all
- latest
required: true
- name: type
description: item type
in: query
schema:
type: number
required: false
- name: filter
description: the filter parameter
in: query
schema:
type: string
required: false
responses:
"200":
description: The details of the library
"401":
$ref: "../responses/401.yaml"

View File

@@ -61,6 +61,8 @@ paths:
$ref: "./paths/security-token.yaml"
/security/resources:
$ref: "./paths/security-resources.yaml"
/library/sections/{sectionId}/{category}:
$ref: "./paths/library-sections.yaml"
tags:
- name: Activities
@@ -88,3 +90,6 @@ tags:
- name: Security
description: |
API Calls against Security for Plex Media Server
- name: Library
description: |
API Calls interacting with Plex Media Server Libraries