added plex.tv/api/users

[JasonLandbridge]

added https://plex.tv/api/users

Summary by CodeRabbit

This release introduces a new API endpoint that enables retrieval of connected users with library access using an authentication token. The API documentation has been updated to accurately describe the new user data endpoint, providing clearer guidance for integration. These enhancements significantly simplify user management and improve overall API usability.

• New Features
  • Added an API endpoint for retrieving connected users with library access.
• Documentation
  • Updated API documentation to clearly describe the new user data endpoint.

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

In this update, a new development dependency is added, and a novel API endpoint has been introduced. The endpoint, defined in a new YAML file, facilitates the retrieval of connected Plex users. Additionally, the primary API specification is amended to include this endpoint, and the testing utility has been refined to process XML responses by introducing a new parameter and helper function. These changes collectively adjust the configuration, endpoint definitions, and response validation logic.

Changes

File(s)	Change Summary
package.json	Added xml-js dependency (version ^1.6.11) in devDependencies.
src/paths/.../get-users.yaml src/pms-spec.yaml	Introduced a new API endpoint (get-users and /users) for retrieving connected Plex users with associated request parameters and response schema definitions.
tests/utils/import.ts	Updated validateResponseSpec to accept a new parameter (responseType as "json" or "xml"), added XML processing logic, and introduced a flattenAttributes helper function.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Client
    participant Server as API Server
    participant Plex as Plex API
    Client->>Server: GET /users (with Plex token)
    Server->>Plex: Forward request to Plex API
    Plex-->>Server: XML response with MediaContainer data
    Server-->>Client: Return XML response with user list

Loading

sequenceDiagram
    participant TestCaller as Test Script
    participant Validator as validateResponseSpec
    TestCaller->>Validator: Call validateResponseSpec(..., responseType="xml")
    Validator->>Validator: Check if responseType is "xml"
    Validator->>Validator: Convert XML to JSON via xml2json
    Validator->>Validator: Flatten attributes using flattenAttributes
    Validator-->>TestCaller: Return validated JSON data

Loading

Poem

In the realm of code, a change takes flight,
A dependency and endpoint brought to light.
XML now converses with our tests so grand,
As attributes are flattened by a careful hand.
May our code, like a fine butler, serve with delight!

Tip

🌐 Web search-backed reviews and chat

• We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
• You can disable this feature by setting web_search: false in the knowledge_base settings.
• Please share any feedback in the Discord discussion.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 628ff25 and 401efaf.

⛔ Files ignored due to path filters (1)

• bun.lockb is excluded by !**/bun.lockb

📒 Files selected for processing (4)

• package.json (1 hunks)
• src/paths/users/get-users.yaml (1 hunks)
• src/pms-spec.yaml (1 hunks)
• tests/utils/import.ts (4 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.