Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update PlexMediaTypeString to match PlexMediaType #76

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update PlexMediaTypeString to match PlexMediaType #76

wants to merge 1 commit into from
+6 −0

Conversation

angafirith
Copy link

@angafirith angafirith commented Jan 6, 2025 •
edited by coderabbitai bot
Loading

GetLibraryItems fails on plexgo when using
operations.GetLibraryItemsQueryParamTypeTrack.ToPointer(), due to error unmarshalling json response body: invalid value for GetLibraryItemsLibraryType: track

Summary by CodeRabbit

  • New Features
    • Expanded media type recognition to include audio-related content types
      • Added support for artist, album, and track media types
  • Documentation
    • Updated schema to reflect new media type classifications

@angafirith
Update PlexMediaTypeString to match PlexMediaType
06329d8 
GetLibraryItems fails on plexgo when using 
`operations.GetLibraryItemsQueryParamTypeTrack.ToPointer(),` due to 
`error unmarshalling json response body: invalid value for GetLibraryItemsLibraryType: track`
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 6, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

Ahem, most esteemed colleagues, I am pleased to report a most refined enhancement to our media type classification schema. The PlexMediaTypeString.yaml document has been graciously expanded to accommodate additional audio-related media types, specifically introducing artist, album, and track to our distinguished enumeration, thereby broadening our taxonomical representation of media content.

Changes

File Change Summary
src/models/common/PlexMediaTypeString.yaml Added new enum values: artist, album, track in both enum and x-speakeasy-enums sections

Poem

In yaml's hallowed halls of type,
Where media's essence takes its swipe,
Three new friends join the grand parade,
Artist, album, track displayed! 🎵
Enumerations dance with glee,
A schema's elegant soirée! 🎼

Cheerio, and good day to you! adjusts monocle

📜 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 a37cf97 and 06329d8.

📒 Files selected for processing (1)
  • src/models/common/PlexMediaTypeString.yaml (2 hunks)
🔇 Additional comments (2)
src/models/common/PlexMediaTypeString.yaml (2)

7-9: Milord, a delightful expansion indeed!

By adding the most esteemed artist, album, and track enumerations, good sir, you have most assuredly bridged the gap that once vexed our dear GetLibraryItems call. This rectifies the marshalling quandary and harmonizes gracefully with the rest of our schema.

18-20: Splendid consistency with x-speakeasy-enums.

Introducing AUDIO, ALBUM, and TRACK to our splendid enumeration ensures unwavering alignment with the newly introduced media types, my good fellow. Truly, a most worthy augmentation of our schema!

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
🪧 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.

JasonLandbridge
JasonLandbridge reviewed Jan 6, 2025
View reviewed changes
src/models/common/PlexMediaTypeString.yaml
@@ -12,3 +15,6 @@ x-speakeasy-enums:
- TV_SHOW
- SEASON
- EPISODE
- AUDIO
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- AUDIO
- ARTIST

@angafirith Should this not be ARTIST?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies for the late response.

I believe AUDIO is correct because that's the value used in src/models/common/PlexMediaType.yaml. I think the primary thing here is that these values need to be in alignment with each other. (i.e. the string value in the response needs to map to the same x-speakeasy-enum value as the int value in the request).

I have to admit that I'm not entirely sure here, since I haven't had the chance to figure out how to regenerate the go module using the updated API spec. I figured out these values by manually editing the source of that module, but there could be some nuance here that I am missing.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking at it again, it should be ARTIST, since this will be the enum value that corresponds with artist as a string value. The order here matters, as with the other options. If you change it, I will merge it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JasonLandbridge JasonLandbridge JasonLandbridge left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@angafirith @JasonLandbridge