mirror of
https://github.com/LukeHagar/plex-api-spec.git
synced 2025-12-06 12:37:45 +00:00
Adjusting tags and descriptions
This commit is contained in:
41
.github/workflows/build-and-copy-plextv-spec.yml
vendored
41
.github/workflows/build-and-copy-plextv-spec.yml
vendored
@@ -1,41 +0,0 @@
|
|||||||
name: Build and Copy Dereferenced Plex TV API Spec
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
paths:
|
|
||||||
- plextv/**
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
dereference_api:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Checkout PR branch
|
|
||||||
uses: actions/checkout@v3
|
|
||||||
- name: Set up Node
|
|
||||||
uses: actions/setup-node@v3
|
|
||||||
with:
|
|
||||||
node-version: "16"
|
|
||||||
- name: Install swagger-cli
|
|
||||||
run: |
|
|
||||||
npm install -g swagger-cli
|
|
||||||
|
|
||||||
- name: Dereference Plex TV Specification
|
|
||||||
run: |
|
|
||||||
swagger-cli bundle --dereference plextv/plextv-spec.yaml -t yaml -o plex-tv-spec-dereferenced.yaml
|
|
||||||
|
|
||||||
- name: Pushes Dereferenced Specification File
|
|
||||||
uses: dmnemec/copy_file_to_another_repo_action@main
|
|
||||||
env:
|
|
||||||
API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
|
|
||||||
with:
|
|
||||||
source_file: plex-tv-spec-dereferenced.yaml
|
|
||||||
destination_repo: lukehagar/plex-docs
|
|
||||||
destination_folder: static
|
|
||||||
user_email: lukeslakemail@gmail.com
|
|
||||||
user_name: lukehagar
|
|
||||||
commit_message: Updating PlexTV Spec
|
|
||||||
|
|
||||||
- uses: stefanzweifel/git-auto-commit-action@v4
|
|
||||||
@@ -2,7 +2,7 @@ get:
|
|||||||
servers:
|
servers:
|
||||||
- url: https://plex.tv/api/v2
|
- url: https://plex.tv/api/v2
|
||||||
tags:
|
tags:
|
||||||
- Plex.tv
|
- Plex
|
||||||
summary: Get Access Token
|
summary: Get Access Token
|
||||||
operationId: getToken
|
operationId: getToken
|
||||||
description: Retrieve an Access Token from Plex.tv after the Pin has already been authenticated
|
description: Retrieve an Access Token from Plex.tv after the Pin has already been authenticated
|
||||||
@@ -15,7 +15,10 @@ get:
|
|||||||
type: string
|
type: string
|
||||||
required: true
|
required: true
|
||||||
- name: X-Plex-Client-Identifier
|
- name: X-Plex-Client-Identifier
|
||||||
description: Plex Authentication Token
|
description: |
|
||||||
|
The unique identifier for the client application
|
||||||
|
This is used to track the client application and its usage
|
||||||
|
(UUID, serial number, or other number unique per device)
|
||||||
in: header
|
in: header
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ post:
|
|||||||
servers:
|
servers:
|
||||||
- url: https://plex.tv/api/v2
|
- url: https://plex.tv/api/v2
|
||||||
tags:
|
tags:
|
||||||
- Plex.tv
|
- Plex
|
||||||
summary: Get a Pin
|
summary: Get a Pin
|
||||||
operationId: getPin
|
operationId: getPin
|
||||||
description: Retrieve a Pin from Plex.tv for authentication flows
|
description: Retrieve a Pin from Plex.tv for authentication flows
|
||||||
@@ -19,7 +19,10 @@ post:
|
|||||||
default: false
|
default: false
|
||||||
required: false
|
required: false
|
||||||
- name: X-Plex-Client-Identifier
|
- name: X-Plex-Client-Identifier
|
||||||
description: Plex Authentication Token
|
description: |
|
||||||
|
The unique identifier for the client application
|
||||||
|
This is used to track the client application and its usage
|
||||||
|
(UUID, serial number, or other number unique per device)
|
||||||
in: header
|
in: header
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
|
|||||||
@@ -218,3 +218,6 @@ tags:
|
|||||||
- name: Video
|
- name: Video
|
||||||
description: |
|
description: |
|
||||||
API Calls that perform operations with Plex Media Server Videos
|
API Calls that perform operations with Plex Media Server Videos
|
||||||
|
- name: Plex
|
||||||
|
description: |
|
||||||
|
API Calls that perform operations directly against https://Plex.tv
|
||||||
|
|||||||
Reference in New Issue
Block a user