fix: Add additional titles and indexes to item metadata #69
Conversation
|
Caution Review failedThe pull request is closed. 📝 Walkthrough📝 WalkthroughWalkthroughThe recent modifications pertain to the OpenAPI specification for the Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant API
participant MetadataService
Client->>API: Request metadata by rating key
API->>MetadataService: Fetch metadata
MetadataService-->>API: Return metadata (with new titles)
API-->>Client: Send metadata response (includes grandparentTitle, parentTitle, originalTitle, index, parentIndex)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| grandparentTitle: | ||
| type: string | ||
| parentTitle: | ||
| type: string | ||
| originalTitle: | ||
| type: string |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
I say, most splendid additions to the metadata schema, if I may be so bold!
Most certainly, the new title fields are properly positioned within the schema, good sir. However, might I humbly suggest the addition of proper descriptions for these distinguished new properties? It would be most helpful for our esteemed API consumers.
If you would be so kind as to consider this modest enhancement:
grandparentTitle:
type: string
+ description: The title of the topmost item in the hierarchy (e.g., TV Show title, Artist name)
parentTitle:
type: string
+ description: The title of the intermediate item in the hierarchy (e.g., Season title, Album name)
originalTitle:
type: string
+ description: The original title of the item, if different from the primary titleI must commend your judicious decision to omit example values, as they would indeed be rather peculiar in a non-hierarchical context, as noted in your most eloquent PR description.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| grandparentTitle: | |
| type: string | |
| parentTitle: | |
| type: string | |
| originalTitle: | |
| type: string | |
| grandparentTitle: | |
| type: string | |
| description: The title of the topmost item in the hierarchy (e.g., TV Show title, Artist name) | |
| parentTitle: | |
| type: string | |
| description: The title of the intermediate item in the hierarchy (e.g., Season title, Album name) | |
| originalTitle: | |
| type: string | |
| description: The original title of the item, if different from the primary title |
dstaley
changed the title
slight description corrections
|
Thank you for the contribution! |
This PR adds support for the
grandparentTitle,parentTitle,originalTitle,index, andparentIndexitem metadata fields. The example is from a non-hierarchical library, so adding example values wouldn't match the existing example data.Example:
{ "MediaContainer": { "size": 1, "allowSync": true, "identifier": "com.plexapp.plugins.library", "librarySectionID": 4, "librarySectionTitle": "Music", "librarySectionUUID": "3c088ca3-5a22-4ab0-a5f6-96172580433e", "mediaTagPrefix": "/system/bundle/media/flags/", "mediaTagVersion": 1730230381, "Metadata": [ { "ratingKey": "3013", "key": "/library/metadata/3013", "parentRatingKey": "3008", "grandparentRatingKey": "3007", "guid": "plex://track/5d0802d7403c640290f88cb3", "parentGuid": "plex://album/5d07cbed403c640290e32974", "grandparentGuid": "plex://artist/5d07bcb4403c64029053da80", "parentStudio": "Atlantic", "type": "track", "title": "Screwed", "grandparentKey": "/library/metadata/3007", "parentKey": "/library/metadata/3008", "librarySectionTitle": "Music", "librarySectionID": 4, "librarySectionKey": "/library/sections/4", + "grandparentTitle": "Janelle Monáe", + "parentTitle": "Dirty Computer", + "originalTitle": "Janelle Monáe ft. Zoë Kravitz", "summary": "", + "index": 5, + "parentIndex": 1, "ratingCount": 8623, "viewCount": 33, "lastViewedAt": 1702820467, "parentYear": 2018, "thumb": "/library/metadata/3008/thumb/1717555188", "art": "/library/metadata/3007/art/1731300415", "parentThumb": "/library/metadata/3008/thumb/1717555188", "grandparentThumb": "/library/metadata/3007/thumb/1731300415", "grandparentArt": "/library/metadata/3007/art/1731300415", "duration": 302491, "addedAt": 1525097811, "updatedAt": 1731300416, "musicAnalysisVersion": "1", "Media": [ { "id": 5019, "duration": 302491, "bitrate": 1650, "audioChannels": 2, "audioCodec": "flac", "container": "flac", "hasVoiceActivity": false, "Part": [ { "accessible": true, "exists": true, "id": 8862, "key": "/library/parts/8862/1641607904/file.flac", "duration": 302491, "file": "/media/Music/Janelle Monáe/Dirty Computer/05. Screwed.flac", "size": 62930454, "container": "flac", "hasThumbnail": "1", "Stream": [ { "id": 17528, "streamType": 2, "selected": true, "codec": "flac", "index": 0, "channels": 2, "bitrate": 1650, "albumGain": "-9.13", "albumPeak": "1.000000", "albumRange": "8.868684", "audioChannelLayout": "stereo", "bitDepth": 24, "gain": "-9.13", "loudness": "-8.87", "lra": "5.80", "peak": "0.993688", "samplingRate": 44100, "displayTitle": "FLAC (Stereo)", "extendedDisplayTitle": "FLAC (Stereo)" }, { "id": 71824, "key": "/library/streams/71824", "streamType": 4, "codec": "lrc", "format": "lrc", "minLines": "3", "provider": "com.plexapp.agents.lyricfind", "timed": "1", "displayTitle": "LRC", "extendedDisplayTitle": "LRC (External)" } ] } ] } ], "Image": [ { "alt": "Screwed", "type": "coverPoster", "url": "/library/metadata/3008/thumb/1717555188" }, { "alt": "Screwed", "type": "background", "url": "/library/metadata/3007/art/1731300415" } ], "Genre": [ { "id": 24810, "filter": "genre=24810", "tag": "R&b" } ], "Guid": [ { "id": "mbid://f1f18c39-135b-42f9-a019-29663f5e1e4c" } ] } ] } }Summary by CodeRabbit
grandparentTitle,parentTitle,originalTitle,index, andparentIndex, providing more contextual information about hierarchical relationships and item organization.