diff --git a/.github/workflows/build-and-copy-plextv-spec.yml b/.github/workflows/build-and-copy-plextv-spec.yml deleted file mode 100644 index 792a44f9..00000000 --- a/.github/workflows/build-and-copy-plextv-spec.yml +++ /dev/null @@ -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 diff --git a/pms/paths/pins-id.yaml b/pms/paths/pins-id.yaml index f43b46f9..f427c573 100644 --- a/pms/paths/pins-id.yaml +++ b/pms/paths/pins-id.yaml @@ -2,7 +2,7 @@ get: servers: - url: https://plex.tv/api/v2 tags: - - Plex.tv + - Plex summary: Get Access Token operationId: getToken description: Retrieve an Access Token from Plex.tv after the Pin has already been authenticated @@ -15,7 +15,10 @@ get: type: string required: true - 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 schema: type: string diff --git a/pms/paths/pins.yaml b/pms/paths/pins.yaml index 4957bb37..77031182 100644 --- a/pms/paths/pins.yaml +++ b/pms/paths/pins.yaml @@ -2,7 +2,7 @@ post: servers: - url: https://plex.tv/api/v2 tags: - - Plex.tv + - Plex summary: Get a Pin operationId: getPin description: Retrieve a Pin from Plex.tv for authentication flows @@ -19,7 +19,10 @@ post: default: false required: false - 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 schema: type: string diff --git a/pms/pms-spec.yaml b/pms/pms-spec.yaml index ff727ffc..d4f7d36c 100644 --- a/pms/pms-spec.yaml +++ b/pms/pms-spec.yaml @@ -218,3 +218,6 @@ tags: - name: Video description: | API Calls that perform operations with Plex Media Server Videos + - name: Plex + description: | + API Calls that perform operations directly against https://Plex.tv