LukeHagar / plex-api-spec

An open source Plex Media Server API Specification
MIT License
37 stars 11 forks source link

Improved unit testing and correct spec mistakes #53

Closed JasonLandbridge closed 2 months ago

JasonLandbridge commented 2 months ago

Summary by CodeRabbit

Release Notes

coderabbitai[bot] commented 2 months ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough ## Walkthrough The recent modifications encompass a variety of changes across multiple files, primarily focusing on the enhancement of schemas and API specifications. Notable alterations include the introduction of new properties in YAML files, updates to existing dependencies in the `package.json`, and the refinement of response structures in API paths. These changes aim to improve the clarity and functionality of the application. ## Changes | File Path | Change Summary | |----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `package.json` | Updated `build-watch` script; added dependencies: `@types/lodash-es` and `lodash-es`. | | `src/models/UserPlexAccount.yaml` | Added required property `attributionPartner` of type string or null. | | `src/models/common/PlexBooleanString.yaml` | Introduced new type `PlexBooleanString` with enum values "0" and "1", default "0", and custom property `x-speakeasy-enums`. | | `src/models/common/PlexMediaType.yaml` | Removed integer enumeration; replaced with descriptive enum values for media types and removed default value. | | `src/models/common/PlexMediaTypeString.yaml`| Introduced new type with string enumeration for media content types: "movie," "show," "season," "episode." | | `src/models/common/PlexSortDirection.yaml` | Introduced new type for sorting directions with values `asc` and `desc`, defaulting to `asc`. | | `src/parameters/type.yaml` | Replaced inline enumeration schema for media types with a reference to an external schema. | | `src/paths/library/[sectionKey]/get-library-items.yaml` | Added new query parameter `type`; expanded response schema with new properties and required fields in media item structure. | | `src/paths/media/providers/get-media-providers.yaml` | Enhanced response schema with required fields and new properties in items array, including `flavor`, `scrobbleKey`, and `unscrobbleKey`. Added `Action` property with required fields. | | `src/responses/400.yaml` | Updated `code` and `status` properties to include `format: int32`. | | `src/responses/401.yaml` | Updated `code` and `status` properties to include `format: int32`. | | `src/responses/408.yaml` | Updated `code` property to include `format: int32`. | | `tests/utils/import.ts` | Introduced `addAdditionalProperties` function to enforce stricter validation rules in OpenAPI schema. | ## Poem > In the realm of code, changes abound, > New properties added, where clarity's found. > Dependencies flourish, like flowers in bloom, > Enhancing our schemas, dispelling the gloom. > With each little tweak, our API shines bright, > A splendid affair, oh what a delight! 🌟

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.