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.

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

fix: Add missing originalTitle property in responses #74

Merged
merged 2 commits into from
Dec 21, 2024

Conversation

FoxxMD
Copy link
Contributor

@FoxxMD FoxxMD commented Dec 17, 2024

@JasonLandbridge I see that originalTitle is already added (by you) in the Metadata model but it's unclear if this is not present in https://github.com/LukeHagar/plexjs due to npm publishing issues or because I'm misunderstanding how models vs. paths work here -- why doesn't the spec use the models in path responses, rather than hardcoding the responses for each path?

If I need to add originalTitle to other paths where Metadata is used I can add more commits, just confused about why its already in the spec but not used.

Fixes #72

Summary by CodeRabbit

  • New Features
    • Introduced an originalTitle property in the session metadata, providing additional context for non-English media items or audio tracks.

Copy link
Contributor

coderabbitai bot commented Dec 17, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

A new property, originalTitle, has been introduced to the Metadata object within the response schema of the getSessions operation in the sessions.yaml file. This property, defined as a string, signifies the original untranslated name of a media item when it is non-English or the track artist if the audio item has an album artist. An illustrative example value is provided: "The American Dream Is Killing Me." No other alterations to the logic, error handling, or control flow have been made in this update.

Changes

File Change Summary
src/paths/status/sessions.yaml Added originalTitle string property to Metadata object in getSessions response schema

Poem

Hark! A title most pristine and true,
originalTitle joins our schema's view
🎵 From tracks to tales, a name revealed
With elegance, its secrets unsealed! 🎤
A butler's touch to metadata's art 🎩

Assessment against linked issues

Objective Addressed Explanation
Include originalTitle property in response (#[72])

📜 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 88d7bd8 and 6a441e4.

📒 Files selected for processing (1)
  • src/paths/status/sessions.yaml (1 hunks)
🔇 Additional comments (2)
src/paths/status/sessions.yaml (2)

78-81: Most splendid addition of the originalTitle property, good sir!

I must say, the implementation is most proper and well-placed within the schema. The type declaration and example value are absolutely spot-on, if I do say so myself.


78-81: Might I suggest a standardization of descriptions across the specification, sir?

I do beg your pardon, but I couldn't help but notice that the description of this most excellent property varies across different parts of our specification, as previously observed. Might I suggest we maintain consistency by adopting a standardized description throughout?

If you'll permit me, I shall examine the current state of affairs:

#!/bin/bash
# Description: Verify consistency of originalTitle descriptions across the specification

echo "=== Examining originalTitle descriptions across the specification, sir ==="
rg -A 1 "originalTitle:" --type yaml

echo -e "\n=== And now, the Metadata model definition, if you please ==="
cat src/models/MetaData.yaml 2>/dev/null || echo "My sincerest apologies, but I cannot locate the Metadata model file, sir."

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between f50fbeb and 88d7bd8.

📒 Files selected for processing (1)
  • src/paths/status/sessions.yaml (1 hunks)

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@JasonLandbridge
Copy link
Collaborator

@JasonLandbridge I see that originalTitle is already added (by you) in the Metadata model

If the response of /sessions in this case has that entire Metadata model, then it can be used.

but it's unclear if this is not present in LukeHagar/plexjs due to npm publishing issues or because I'm misunderstanding how models vs. paths work here -- why doesn't the spec use the models in path responses, rather than hardcoding the responses for each path?

It goes:

/status/sessions:
$ref: "./paths/status/sessions.yaml"

To the response here:

So it should work, it's most likely the publishing issues

@FoxxMD
Copy link
Contributor Author

FoxxMD commented Dec 19, 2024

Thanks for the clarification. /sessions response does not have the entirety of the Metadata model so that makes sense why its a hardcoded subset. The current sessions.yaml is missing originalTitle so this PR is still needed.

@LukeHagar
Copy link
Owner

Anyone mind if I merge this in?

@JasonLandbridge
Copy link
Collaborator

Anyone mind if I merge this in?

@JasonLandbridge Nope go ahead, LGTM

@JasonLandbridge JasonLandbridge self-assigned this Dec 19, 2024
@JasonLandbridge JasonLandbridge merged commit 790b5b8 into LukeHagar:main Dec 21, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Media/Metadata does not contain originalTitle property
3 participants