added test and fixes for get-library-all corrected get-media-meta-data response #85
Conversation
corrected get-media-meta-data response
📝 WalkthroughWalkthroughI humbly present a comprehensive restructuring of the OpenAPI specifications and accompanying models. Numerous YAML files have been modified or newly introduced. Changes include extensive updates to media data schemas, alterations to property types and formats, and the addition of many new metadata schemas. In addition, several new query parameters and API endpoints (notably for retrieving complete library data and detailed media metadata) have been added. Testing files have also been enhanced with new cases to validate the returned responses. Changes
Sequence Diagram(s)sequenceDiagram
participant C as Client
participant A as API Gateway
participant S as Media Service
participant M as Metadata Service
C->>A: GET /library/sections/{sectionKey}/all
A->>S: Request media data
S-->>A: MediaContainer (modular schema)
A-->>C: 200 OK with MediaContainer response
C->>A: GET /library/metadata/{ratingKey}/get-media-meta-data
A->>M: Request detailed media metadata
M-->>A: Response with rating, ratingImage, and standardised media fields
A-->>C: 200 OK with enriched metadata
Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🔇 Additional comments (1)
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}
There was a problem hiding this comment.
Actionable comments posted: 4
🔭 Outside diff range comments (28)
src/models/meta-data/grandparent-theme.yaml (1)
1-7: Splendid Introduction of the Grandparent Theme Schema!I say, the new schema is exemplarily arranged with the "grandparentTheme" property neatly defined as a string, accompanied by a clear description and a helpful example. Might I suggest confirming that this innovation aligns with the corresponding sibling schemas (such as "parentTheme" and "grandparentArt") to ensure a harmonious consistency across the metadata ensemble? Additionally, it may behoove one to deliberate on marking the property as required, should the design specifications so demand.
src/models/meta-data/parent-thumb.yaml (1)
1-7: Optional Enhancement: URL Validation Pattern
If it pleases you, might I suggest an optional refinement? You may consider introducing a validation pattern to ensure that the thumbnail URL adheres to the expected format. For example, one could add a "pattern" field as follows:example: "/library/metadata/66/thumb/1705716261" + pattern: "^/library/metadata/\\d+/thumb/\\d+$"This addition is purely ornamental and serves only to further safeguard against format anomalies.
tests/paths/library/metadata/[ratingKey]/get-media-meta-data.spec.ts (3)
5-1868: I say, might I suggest enhancing the test case description, good sir?While the test case is splendidly structured, one might venture to suggest the following refinements:
- A more descriptive test name beyond merely "when the response is from Tv-Show"
- Additional assertions to validate critical metadata fields
Might I propose this refined test description:
- it("should validate the 200 response when the response is from Tv-Show", () => { + it("should validate TV show metadata response with complete show details, cast and ratings", () => {🧰 Tools
🪛 Gitleaks (8.21.2)
111-111: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
120-120: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
138-138: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
165-165: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
183-183: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
210-210: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
219-219: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
228-228: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
273-273: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
300-300: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
318-318: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
354-354: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
363-363: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
399-399: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
408-408: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
426-426: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
462-462: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
471-471: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
480-480: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
498-498: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
505-505: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
514-514: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
532-532: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
541-541: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
584-584: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
593-593: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
602-602: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
620-620: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
638-638: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
645-645: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
652-652: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
659-659: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
668-668: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
677-677: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
684-684: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
693-693: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
702-702: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
709-709: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
716-716: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
732-732: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
759-759: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
768-768: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
786-786: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
795-795: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
804-804: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
813-813: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
822-822: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
831-831: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
840-840: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
858-858: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
865-865: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
901-901: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
910-910: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
919-919: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
953-953: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
987-987: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1014-1014: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1039-1039: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1048-1048: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1075-1075: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1112-1112: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1121-1121: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1157-1157: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1164-1164: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1173-1173: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1180-1180: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1198-1198: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1205-1205: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1228-1228: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1246-1246: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1262-1262: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1269-1269: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1287-1287: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1305-1305: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1314-1314: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1321-1321: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1348-1348: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1416-1416: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1425-1425: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1452-1452: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1470-1470: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1479-1479: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1486-1486: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1495-1495: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1502-1502: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1520-1520: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1538-1538: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1547-1547: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1556-1556: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1572-1572: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1581-1581: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1649-1649: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1656-1656: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1672-1672: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1706-1706: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1733-1733: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1783-1783: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1819-1819: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1870-4490: Pardon my intrusion, but might I suggest a similar enhancement for this test case as well?The test structure is most proper, but could benefit from the same refinements as suggested for the TV show test.
If I may be so bold as to suggest:
- it("should validate the 200 response when the response is from Movie", () => { + it("should validate movie metadata response with 4K/HDR stream details and multilingual subtitles", () => {🧰 Tools
🪛 Gitleaks (8.21.2)
2167-2167: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2175-2175: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2183-2183: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2193-2193: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2211-2211: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2238-2238: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2256-2256: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2292-2292: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2301-2301: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2310-2310: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2319-2319: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2346-2346: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2355-2355: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2364-2364: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2373-2373: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2380-2380: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2389-2389: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2398-2398: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2416-2416: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2450-2450: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2459-2459: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2468-2468: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2486-2486: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2495-2495: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2522-2522: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2540-2540: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2556-2556: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2565-2565: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2592-2592: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2608-2608: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2624-2624: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2660-2660: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2687-2687: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2696-2696: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2705-2705: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2719-2719: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2726-2726: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2749-2749: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2758-2758: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2765-2765: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2779-2779: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2788-2788: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2795-2795: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2823-2823: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2846-2846: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2867-2867: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2883-2883: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2890-2890: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2897-2897: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2906-2906: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2920-2920: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2927-2927: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2934-2934: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2941-2941: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2971-2971: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3015-3015: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3022-3022: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3082-3082: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3135-3135: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3223-3223: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3237-3237: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3269-3269: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3306-3306: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3315-3315: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3343-3343: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3350-3350: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3357-3357: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3364-3364: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3380-3380: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3394-3394: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3401-3401: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3436-3436: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3466-3466: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3498-3498: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3521-3521: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3535-3535: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3542-3542: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3563-3563: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3570-3570: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3577-3577: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3614-3614: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3630-3630: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3699-3699: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3713-3713: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3748-3748: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1-5387: If I might make one final observation regarding the test suite as a whole.While the tests most admirably cover different content types, they appear to focus solely on validating the response structure. One might suggest enhancing the test coverage to verify specific field values and business rules.
May I recommend adding test cases to verify:
- Correct calculation of ratings and audience scores
- Proper formatting of stream details and codecs
- Accurate representation of cast and crew information
- Proper handling of missing or optional fields
Would sir like me to assist in crafting these additional test cases?
🧰 Tools
🪛 Gitleaks (8.21.2)
111-111: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
120-120: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
138-138: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
165-165: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
183-183: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
210-210: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
219-219: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
228-228: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
273-273: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
300-300: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
318-318: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
354-354: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
363-363: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
399-399: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
408-408: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
426-426: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
462-462: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
471-471: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
480-480: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
498-498: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
505-505: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
514-514: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
532-532: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
541-541: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
584-584: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
593-593: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
602-602: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
620-620: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
638-638: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
645-645: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
652-652: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
659-659: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
668-668: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
677-677: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
684-684: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
693-693: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
702-702: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
709-709: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
716-716: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
732-732: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
759-759: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
768-768: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
786-786: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
795-795: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
804-804: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
813-813: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
822-822: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
831-831: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
840-840: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
858-858: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
865-865: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
901-901: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
910-910: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
919-919: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
953-953: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
987-987: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1014-1014: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1039-1039: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1048-1048: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1075-1075: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1112-1112: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1121-1121: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1157-1157: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1164-1164: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1173-1173: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1180-1180: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1198-1198: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1205-1205: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1228-1228: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1246-1246: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1262-1262: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1269-1269: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1287-1287: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1305-1305: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1314-1314: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1321-1321: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1348-1348: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1416-1416: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1425-1425: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1452-1452: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1470-1470: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1479-1479: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1486-1486: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1495-1495: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1502-1502: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1520-1520: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1538-1538: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1547-1547: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1556-1556: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1572-1572: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1581-1581: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1649-1649: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1656-1656: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1672-1672: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1706-1706: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1733-1733: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1783-1783: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
1819-1819: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2167-2167: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2175-2175: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2183-2183: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2193-2193: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2211-2211: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2238-2238: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2256-2256: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2292-2292: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2301-2301: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2310-2310: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2319-2319: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2346-2346: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2355-2355: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2364-2364: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2373-2373: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2380-2380: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2389-2389: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2398-2398: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2416-2416: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2450-2450: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2459-2459: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2468-2468: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2486-2486: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2495-2495: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2522-2522: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2540-2540: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2556-2556: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2565-2565: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2592-2592: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2608-2608: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2624-2624: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2660-2660: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2687-2687: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2696-2696: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2705-2705: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2719-2719: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2726-2726: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2749-2749: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2758-2758: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2765-2765: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2779-2779: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2788-2788: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2795-2795: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2823-2823: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2846-2846: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2867-2867: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2883-2883: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2890-2890: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2897-2897: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2906-2906: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2920-2920: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2927-2927: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2934-2934: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2941-2941: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
2971-2971: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3015-3015: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3022-3022: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3082-3082: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3135-3135: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3223-3223: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3237-3237: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3269-3269: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3306-3306: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3315-3315: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3343-3343: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3350-3350: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3357-3357: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3364-3364: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3380-3380: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3394-3394: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3401-3401: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3436-3436: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3466-3466: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3498-3498: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3521-3521: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3535-3535: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3542-3542: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3563-3563: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3570-3570: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3577-3577: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3614-3614: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3630-3630: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3699-3699: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3713-3713: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
3748-3748: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4754-4754: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4762-4762: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4770-4770: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4778-4778: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4786-4786: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4804-4804: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4813-4813: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4831-4831: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4885-4885: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4912-4912: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4930-4930: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4955-4955: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4962-4962: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5012-5012: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5033-5033: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5068-5068: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5086-5086: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5118-5118: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5134-5134: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5141-5141: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5148-5148: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5155-5155: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5164-5164: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5171-5171: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5180-5180: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5196-5196: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
src/models/meta-data/updated-at.yaml (1)
1-5: Well-Crafted ‘updatedAt’ Schema Definition
My dear fellow, this schema is elegantly structured, leveraging the PlexDateTime reference to standardise the timestamp. Should you wish, you might consider adding a descriptive comment or property to aid API consumers, though the present implementation is entirely acceptable.src/models/meta-data/type.yaml (1)
1-8: Distinguished ‘type’ Schema Implementation
Sir, the schema is admirably constituted. The required property is crisply specified, and the use of the allOf composition, referencing PlexMediaTypeString, maintains the elegance and flexibility of the API design. One might, if so inclined, add a descriptive note to further assist the erudite consumer, though it is not strictly necessary.src/parameters/unwatched-leaves.yaml (1)
1-7: Stately Definition for "unwatchedLeaves" Parameter
My dear fellow, this parameter is defined in a fashion that is both clear and consistent with its peers. Do ensure that the description, "Adds the Meta object to the response," conveys exactly what is intended to the consumer; a minor nitpick, but clarity is ever so vital.src/models/meta-data/parent-key.yaml (1)
1-7: Good day, sir/madam. The newly minted parentKey schema is indeed a creditable addition to our metadata collection. The object is defined with clarity, detailing the parent media item's key with an apt description and example. However, one might consider, if this property is indeed indispensable, appending a "required" field to ensure its mandatory presence.src/models/meta-data/grandparent-title.yaml (1)
1-7: I say, what a delightful schema for "grandparentTitle"! The property is well-documented and elegantly expressed, providing both clarity and consistency with its sibling metadata schemas. Should this value be mandated by your design, you might, in a future refinement, consider marking it as required. Nonetheless, a jolly good effort.src/models/meta-data/chapter-source.yaml (1)
1-7: Indeed, an excellent presentation of the chapterSource schema, my dear. The property is clearly defined with its type, description, and example at your service. Pray, do consider whether this field should be necessitated as required by your application's logic, and if so, a small required list might be appended for utmost clarity.src/models/meta-data/studio.yaml (1)
1-7: My compliments on the studio schema—it is as neat as one would expect from such a well-considered definition. The "studio" property is thoroughly explained with type, description, and a relevant example. Should it be of utmost importance, you may wish to declare it required; however, it stands commendably in its current form.src/models/meta-data/grandparent-slug.yaml (1)
1-7: A Most Splendid Schema Addition
My dear, the newly introduced schema for "grandparentSlug" is most exemplary. It is commendably concise and clear. However, if this property is indeed required—as intimated by the accompanying summary—it would be prudent to explicitly include a "required" declaration within the schema.Might I suggest the following enhancement as a means to ensure proper validation?
type: object +required: + - grandparentSlug properties:src/models/meta-data/parent-guid.yaml (1)
1-7: Exquisite Schema for Parent GUID
Dear sir/madam, the schema for "parentGuid" is rendered with admirable simplicity and clarity. In keeping with best practices and to guarantee its mandatory presence (should that be your intent), an explicit "required" list would be most beneficial.Please consider the following diff as a refined suggestion:
type: object +required: + - parentGuid properties:src/models/meta-data/view-count.yaml (1)
1-8: Noteworthy Addition: View Count Schema
My esteemed colleague, this schema for "viewCount" is set forth with commendable precision. To maintain consistency—with its counterparts—and if the "viewCount" is to be indispensable in operation, might I respectfully suggest marking it as required?The following refinement may be of service:
type: object +required: + - viewCount properties:src/models/meta-data/skip-count.yaml (1)
1-8: Elegant Schema for Skip Count
My dear, the "skipCount" schema is most elegantly defined. In a bid to further fortify its utility, should this property indeed be essential, an explicit "required" list is advised.Permit me to propose this minor adjustment:
type: object +required: + - skipCount properties:src/models/meta-data/view-offset.yaml (1)
1-8: Marvelous Schema for View Offset
This delightful schema delineating "viewOffset" is a superb addition, clearly specifying its intended numerical format and description. If the "viewOffset" is to be considered a mandatory field within your data model, it would be most judicious to include a "required" declaration accordingly.Might I suggest the subsequent diff for your kind perusal?
type: object +required: + - viewOffset properties:src/models/meta-data/title.yaml (1)
1-9: Exquisite "Title" Schema Definition
My dear fellow, the schema here is presented most elegantly. The required property “title” is clearly enumerated, and the attribute is defined with its type, a genteel description, and an illustrative example. Do ensure that the solitary numeral appearing on line 9 is indeed intended and not an orphaned remnant.src/models/meta-data/key.yaml (1)
1-9: Well-Tailored "Key" Schema
The “key” schema has been fashioned with commendable precision. The requisite property is declared with a proper type and a fitting description, ensuring its role as the unique identifier is unambiguous. Do also inspect if the trailing digit, as seen on line 9, is purposive or might benefit from removal.src/models/meta-data/leaf-count.yaml (1)
1-8: Meritorious Leaf Count Schema ImplementationThis schema is artfully composed, capturing the number of leaf items with admirable precision through the use of an int32 integer. May I humbly suggest, however, that if the leafCount is invariably expected, you might consider incorporating a required list? Otherwise, this implementation is serviceable as designed.
src/models/meta-data/banner.yaml (1)
1-9: Exquisite schema declaration for the banner.
My dear, the object is elegantly defined with the required property "banner" complete with a clear description and a vivid example. One might, if it pleases you, consider adding a "format: uri" to further refine the validation of the banner URL.src/models/meta-data/has-premium-extras.yaml (1)
1-9: Splendid portrayal of premium extras.
I say, the schema is concise and properly enforces the presence of "hasPremiumExtras". However, might I humbly suggest considering a boolean type for improved clarity, unless the intention is to retain the string format for legacy reasons?src/models/meta-data/parent-theme.yaml (1)
1-9: A refined schema for the parent theme.
The object is succinctly defined with the necessary "parentTheme" property, including a well-crafted description and example. Should you deem it beneficial, adding a "format: uri" might further ensure the veracity of the theme URL.src/models/meta-data/user-rating.yaml (1)
1-8: A delightful schema for user ratings.
The declaration of "userRating" as a number with a float format is clear and precise. Might I suggest, if it suits the application’s purpose, specifying minimum and maximum bounds to further restrict the valid range of ratings? Such an addition could enhance both the integrity and the usability of the schema.src/models/meta-data/created-at-tz-offset.yaml (1)
1-7: Delightful Schema for Creation Time Zone OffsetI note with considerable satisfaction that the property "createdAtTZOffset" is defined as a string, accompanied by a precise description and a representative example. Should this property prove to be indispensable, one might consider designating it as required; however, if its nature is indeed optional, then no further ado is needed.
src/models/meta-data/enable-credits-marker-generation.yaml (1)
1-17: Impeccable schema for enabling credits marker generation
I must say, the new schema covering “enableCreditsMarkerGeneration” is both succinct and clear. The descriptive text and enumeration of allowed values are gracefully provided. May I, however, suggest a brief moment’s reflection on whether a numerical type might better express these flag values? Should the specification indeed require a string, then this is perfectly proper.src/models/meta-data/episode-sort.yaml (1)
1-19: Splendid Schema Definition, Sir!
The schema for “episodeSort” is concise and clear, with proper enumeration and an illustrative example. One small note, however: the solitary line (line 19) appears to be an extraneous artefact; do ensure it is intentional or remove it for a cleaner presentation.src/models/meta-data/objects/ultra-blur-colors.yaml (1)
1-25: A Most Promising Object, Yet With a Gentle Suggestion
The UltraBlurColors schema is well-formed and utilises the required properties capably. Might I humbly suggest enhancing the “description” (currently “Unknown”) to something more descriptive, so that future readers may appreciate the purpose of these color codes with greater clarity?
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (97)
src/models/Media-data.yaml(17 hunks)src/models/MediaContainer.yaml(1 hunks)src/models/Meta.yaml(2 hunks)src/models/collection/tag.yaml(1 hunks)src/models/common/PlexMediaTypeString.yaml(2 hunks)src/models/country/tag.yaml(1 hunks)src/models/director/tag.yaml(1 hunks)src/models/genre/tag.yaml(1 hunks)src/models/media-container/content.yaml(1 hunks)src/models/media-container/offset.yaml(1 hunks)src/models/media-container/size.yaml(1 hunks)src/models/media-container/total-size.yaml(1 hunks)src/models/meta-data/added-at.yaml(1 hunks)src/models/meta-data/art.yaml(1 hunks)src/models/meta-data/audience-rating-image.yaml(1 hunks)src/models/meta-data/audience-rating.yaml(1 hunks)src/models/meta-data/banner.yaml(1 hunks)src/models/meta-data/chapter-source.yaml(1 hunks)src/models/meta-data/child-count.yaml(1 hunks)src/models/meta-data/content-rating.yaml(1 hunks)src/models/meta-data/created-at-accuracy.yaml(1 hunks)src/models/meta-data/created-at-tz-offset.yaml(1 hunks)src/models/meta-data/duration.yaml(1 hunks)src/models/meta-data/enable-credits-marker-generation.yaml(1 hunks)src/models/meta-data/episode-sort.yaml(1 hunks)src/models/meta-data/flatten-seasons.yaml(1 hunks)src/models/meta-data/grandparent-art.yaml(1 hunks)src/models/meta-data/grandparent-guid.yaml(1 hunks)src/models/meta-data/grandparent-key.yaml(1 hunks)src/models/meta-data/grandparent-rating-key.yaml(1 hunks)src/models/meta-data/grandparent-slug.yaml(1 hunks)src/models/meta-data/grandparent-theme.yaml(1 hunks)src/models/meta-data/grandparent-thumb.yaml(1 hunks)src/models/meta-data/grandparent-title.yaml(1 hunks)src/models/meta-data/guid.yaml(1 hunks)src/models/meta-data/has-premium-extras.yaml(1 hunks)src/models/meta-data/has-premium-primary-extra.yaml(1 hunks)src/models/meta-data/index.yaml(1 hunks)src/models/meta-data/key.yaml(1 hunks)src/models/meta-data/last-rated-at.yaml(1 hunks)src/models/meta-data/last-viewed-at.yaml(1 hunks)src/models/meta-data/leaf-count.yaml(1 hunks)src/models/meta-data/library-section-id.yaml(1 hunks)src/models/meta-data/library-section-key.yaml(1 hunks)src/models/meta-data/library-section-title.yaml(1 hunks)src/models/meta-data/objects/image.yaml(1 hunks)src/models/meta-data/objects/ultra-blur-colors.yaml(1 hunks)src/models/meta-data/original-title.yaml(1 hunks)src/models/meta-data/originally-available-at.yaml(1 hunks)src/models/meta-data/parent-guid.yaml(1 hunks)src/models/meta-data/parent-index.yaml(1 hunks)src/models/meta-data/parent-key.yaml(1 hunks)src/models/meta-data/parent-rating-key.yaml(1 hunks)src/models/meta-data/parent-slug.yaml(1 hunks)src/models/meta-data/parent-studio.yaml(1 hunks)src/models/meta-data/parent-theme.yaml(1 hunks)src/models/meta-data/parent-thumb.yaml(1 hunks)src/models/meta-data/parent-title.yaml(1 hunks)src/models/meta-data/parent-year.yaml(1 hunks)src/models/meta-data/primary-extra-key.yaml(1 hunks)src/models/meta-data/rating-image.yaml(1 hunks)src/models/meta-data/rating-key.yaml(1 hunks)src/models/meta-data/rating.yaml(1 hunks)src/models/meta-data/season-count.yaml(1 hunks)src/models/meta-data/show-ordering.yaml(1 hunks)src/models/meta-data/skip-children.yaml(1 hunks)src/models/meta-data/skip-count.yaml(1 hunks)src/models/meta-data/slug.yaml(1 hunks)src/models/meta-data/studio.yaml(1 hunks)src/models/meta-data/subtype.yaml(1 hunks)src/models/meta-data/summary.yaml(1 hunks)src/models/meta-data/tagline.yaml(1 hunks)src/models/meta-data/theme.yaml(1 hunks)src/models/meta-data/thumb.yaml(1 hunks)src/models/meta-data/title-sort.yaml(1 hunks)src/models/meta-data/title.yaml(1 hunks)src/models/meta-data/type.yaml(1 hunks)src/models/meta-data/updated-at.yaml(1 hunks)src/models/meta-data/user-rating.yaml(1 hunks)src/models/meta-data/view-count.yaml(1 hunks)src/models/meta-data/view-offset.yaml(1 hunks)src/models/meta-data/viewed-leaf-count.yaml(1 hunks)src/models/meta-data/year.yaml(1 hunks)src/models/role/tag.yaml(1 hunks)src/models/writer/tag.yaml(1 hunks)src/parameters/include-advanced.yaml(1 hunks)src/parameters/include-collections.yaml(1 hunks)src/parameters/include-external-media.yaml(1 hunks)src/parameters/include-guids.yaml(1 hunks)src/parameters/unwatched-leaves.yaml(1 hunks)src/paths/library/[sectionKey]/get-library-all.yaml(1 hunks)src/paths/library/[sectionKey]/get-library-countries.yaml(1 hunks)src/paths/library/[sectionKey]/get-library-genres.yaml(1 hunks)src/paths/library/[sectionKey]/get-library-items.yaml(0 hunks)src/paths/library/metadata/[ratingKey]/get-media-meta-data.yaml(5 hunks)src/pms-spec.yaml(1 hunks)tests/paths/library/metadata/[ratingKey]/get-media-meta-data.spec.ts(1 hunks)
💤 Files with no reviewable changes (1)
- src/paths/library/[sectionKey]/get-library-items.yaml
🧰 Additional context used
🪛 Gitleaks (8.21.2)
tests/paths/library/metadata/[ratingKey]/get-media-meta-data.spec.ts
4754-4754: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4762-4762: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4770-4770: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4778-4778: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4786-4786: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4804-4804: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4813-4813: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4831-4831: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4885-4885: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4912-4912: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4930-4930: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4955-4955: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
4962-4962: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5012-5012: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5033-5033: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5068-5068: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5086-5086: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5118-5118: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5134-5134: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5141-5141: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5148-5148: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5155-5155: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5164-5164: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5171-5171: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5180-5180: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
5196-5196: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
🔇 Additional comments (93)
src/models/meta-data/season-count.yaml (2)
1-3: Splendid Declaration and Requirements.
My dear fellow, the object is declared with admirable clarity, and the required field "seasonCount" is aptly designated. The structure conforms most splendidly to the expected schema.
4-10: Exquisite Property Detailing.
The "seasonCount" property is articulated with a fine attention to detail; its type as an integer and the 32-bit format are most befitting. The description and example provided render the schema both informative and precise.src/models/meta-data/originally-available-at.yaml (1)
1-10: Exquisite YAML Schema DefinitionMy dear fellow, this new schema is impeccably defined. The object type declaration, required property list, and the detailed "originallyAvailableAt" field (with its type, format, description, and example) are all presented with admirable clarity. It blends seamlessly with your overarching changes to the media metadata structure. I raise my hat in approval.
src/models/meta-data/child-count.yaml (2)
1-3: Object Declaration & Required Field: Splendid Setup
Pray, the schema is declared as an object with the "childCount" property duly marked as required. This arrangement is both clear and proper.
4-9: Property Details: Thoroughly Impeccable
The property "childCount" is defined with precision—a type of integer accompanied by the int32 format, a most fitting description, and an apt example. I commend you on the meticulous attention to detail in this definition.src/models/meta-data/guid.yaml (2)
1-3: Exquisite Declaration of the Object SchemaMy dear fellow, the schema most elegantly specifies the object type and mandates the presence of the "guid" with an air of precision. Excellent work indeed!
4-8: Impeccable Definition of the "guid" PropertyPray, observe how the "guid" property is meticulously rendered with its type, description, and an illustrative example. This refined declaration shall surely impart clarity to its noble users.
src/models/meta-data/slug.yaml (1)
1-8: Splendid new schema addition!I must say, this new YAML schema is executed with the utmost elegance. The object type declaration alongside the required property "slug" is perfectly in order, and the description—with its charming example "4-for-texas"—ensures clarity and precision. Might I suggest a brief verification on the hyphen character used in the description? A standard ASCII hyphen might be preferable to guarantee uniform behaviour across all YAML parsers, but this is merely a refinement rather than a necessity.
src/models/meta-data/viewed-leaf-count.yaml (1)
1-7: Capital Addition, Sir/Madam!
The new YAML schema for "viewedLeafCount" is most elegantly structured. Defining the object as having a single property of type integer with an "int32" format, along with a precise description and a well-chosen example, is simply splendid. Do ensure that its styling remains consistent with the other metadata models.src/models/meta-data/parent-thumb.yaml (1)
1-7: Impeccable Schema Definition
My dear fellow, the schema is presented with both clarity and precision. The usage of "type: object" along with the "properties" definition is most appropriate, and the "parentThumb" property is documented with an apt description and example.src/models/writer/tag.yaml (1)
1-8: A Most Splendidly Composed Writer Schema!I must commend you on the thorough structuring of this YAML schema, which clearly defines an object with a required property 'tag' for representing the writer’s role. Might I humbly suggest enclosing the example value "Danny Boyle" within quotes to ensure consistent parsing across all YAML implementations?
src/models/director/tag.yaml (1)
1-8: A Most Refined Schema for the Director’s Role!The presented schema is both concise and clear in its purpose. The required 'tag' property is well-defined, perfectly mirroring its counterparts in related modules. A gentle recommendation: consider quoting the example "Danny Boyle" for uniformity amongst your schemas.
src/models/role/tag.yaml (1)
1-8: Exemplary Role Tag Schema, Indeed!This schema is rendered with exquisite clarity, stating the object type and the required 'tag' property which represents the actor's role. It would be advantageous, however, to enclose "Danny Boyle" in quotes to align with best practices across similar definitions.
src/models/genre/tag.yaml (1)
1-10: An Exquisitely Detailed Genre Schema!The schema delineates the genre tag with impeccable detail, and the utilization of a block scalar for the description is particularly admirable. A slight refinement might be to quote the example "Crime" to ensure consistent formatting, though the current form is largely satisfactory.
src/models/country/tag.yaml (1)
1-9: A Most Eloquent Schema for Country of Origin!I say, this schema is precisely defined with the requisite 'tag' property, thereby clearly denoting the country of origin. May I suggest, however, that you enclose the example value "United States of America" in quotes for the sake of standardized formatting across your models?
src/models/collection/tag.yaml (1)
1-9: Exquisite Schema StructureMy dear, this new tag schema is crafted in an admirable fashion. The object type is clearly declared, and the requirement for the 'tag' property is unambiguously set. The overall structure aligns splendidly with the consistent schema patterns observed throughout the project.
src/parameters/include-advanced.yaml (1)
1-5: Exquisite Parameter Definition for ‘includeAdvanced’
My dear sir, the new parameter is succinctly and correctly defined, referencing the proper boolean schema. It appears to be in fine order.src/parameters/include-collections.yaml (1)
1-5: Impeccable Parameter Setup for ‘includeCollections’
I note with pleasure that the parameter is delineated in a manner entirely consistent with our other boolean query parameters. The reference to the standard PlexBoolean schema is appropriately rendered.src/parameters/include-external-media.yaml (1)
1-5: Pristine Declaration for ‘includeExternalMedia’ Parameter
The parameter is defined with proper regard to consistency and correctness, referencing the established PlexBoolean schema. Everything is in proper order.src/parameters/include-guids.yaml (1)
1-6: Exquisite Declaration for "includeGuids" Parameter
My dear, this new parameter is most elegantly defined. It is placed rightly in the query and references the common PlexBoolean schema, ensuring consistency across the board. Splendid work indeed.src/models/meta-data/parent-title.yaml (1)
1-6: Impeccable Structure for "parentTitle" Schema
I say, the schema for "parentTitle" is crafted with admirable precision. The type, description, and example are all presented in a most refined manner, befitting the requirements.src/models/meta-data/content-rating.yaml (1)
1-7: Distinguished "contentRating" Schema Introduction
I am most pleased to observe that the "contentRating" property is introduced with due diligence. The type, description, and example are all in impeccable order, thus enhancing the metadata with a refined touch.src/models/meta-data/parent-rating-key.yaml (1)
1-7: Elegant Declaration of "parentRatingKey" Schema
This new schema portion for the "parentRatingKey" is presented with the utmost clarity and simplicity. The property is defined as a string with an apt description and example, guaranteeing its seamless integration into the enriched metadata framework.src/models/meta-data/grandparent-rating-key.yaml (1)
1-7: Exquisite Schema Definition for Grandparent Rating Key
My dear fellow, the schema for “grandparentRatingKey” is as immaculate as one might hope. The property is clearly defined with an apt type, description, and example. Splendid work indeed.src/models/media-container/content.yaml (1)
1-9: Marvelous Introduction of the Content Schema
I must say, this new schema pertaining to “content” is rendered with precision. The required field is explicitly stated, and the properties are described in a most unambiguous manner. Jolly good show!src/models/meta-data/grandparent-key.yaml (1)
1-7: Impeccable Definition of Grandparent Key
Pray, observe the elegant structure of the “grandparentKey” schema. With its clear type, description, and example, it harmonizes gloriously with the rest of the metadata definitions. Truly a credit to the development.src/models/meta-data/rating-image.yaml (1)
1-7: Distinguished Schema for Rating Image
My good sir, the schema for “ratingImage” is presented with finesse. The utilization of a simple string type alongside a descriptive clarification and a tasteful example ensures its utility in the API response. Capital effort!src/models/meta-data/parent-index.yaml (1)
1-8: Splendid Definition of Parent Index
I do commend this schema for “parentIndex” as it is both succinct and clear. The proper designation as an integer with an int32 format, complete with a description and example, makes it eminently serviceable. Quite marvellous.src/models/meta-data/original-title.yaml (1)
1-7: Refined "Original Title" Schema
I say, the schema for “originalTitle” is quite simply expressed and adheres to a clean, concise structure. It wisely opts not to enforce the property as required, which may well be the intention for optionally provided media metadata. Might I suggest verifying that such optionality aligns with your overall design goals, dear sir?src/models/meta-data/parent-studio.yaml (1)
1-9: Distinguished "Parent Studio" Schema
Quite pleasing indeed, the “parentStudio” schema is presented with clarity and decorum. The required field is explicitly stated, and the accompanying description is succinct yet informative. Might I humbly recommend confirming that this field's usage is uniformly upheld throughout your metadata structure?src/models/meta-data/tagline.yaml (1)
1-9: Impeccable "Tagline" Schema
This schema, dear sir, is both refined and consistent with the overall suite of metadata definitions. The “tagline” property is declared as required, and its description coupled with an example imparts clarity for its intended use. Do ensure that any superfluous remnants at the end are expunged if they are not expressly meant for inclusion.src/models/meta-data/year.yaml (1)
1-9: Exquisite Year Schema DefinitionI am most delighted to observe this refined and well-structured schema for the release year. The definition is succinct and pleasingly precise, employing the int32 format and providing an illustrative example. Splendid work indeed.
src/models/meta-data/audience-rating.yaml (1)
1-8: Exquisite Audience Rating SchemaThis schema is rendered with admirable clarity. The usage of the number type, accompanied by a clear description and a representative example, ensures that the media item's audience rating is impeccably defined. Quite commendable, sir/madam.
src/models/meta-data/title-sort.yaml (1)
1-9: Impeccable Title Sort SchemaThe schema is presented in a most concise and elegant fashion. The titleSort property is clearly delineated with a descriptive narrative and an apt example. A fine addition to the metadata repertoire, if I may say so.
src/models/meta-data/grandparent-guid.yaml (1)
1-7: Stately Grandparent GUID SchemaA most stately definition indeed! The grandparentGuid is adroitly specified with an informative description and an illuminating example. Should this identifier be deemed mandatory for all media items, you might wish to declare it as required; if not, it stands impeccably as is.
src/models/meta-data/index.yaml (1)
1-9: Splendid New Index Schema Definition
I say, this new YAML schema defining the media item's index is most pleasing. The property is clearly stated with its type, format, description, and example. One might only suggest ensuring that, when integrated with sort of related models, consistency is maintained overall.src/models/meta-data/primary-extra-key.yaml (1)
1-7: Exquisite Primary Extra Key Schema
Pray, the schema for “primaryExtraKey” is succinctly defined, with a fine description and an illustrative example. Do consider whether this field ought to be required, should your application logic demand it; otherwise, this is absolutely splendid.src/models/meta-data/grandparent-art.yaml (1)
1-7: Impeccable Grandparent Art Schema
I am most delighted by the clarity of this schema. The “grandparentArt” property is well-articulated, complete with a descriptive note and example URL. It shall undoubtedly serve its purpose admirably in the metadata response.src/models/meta-data/library-section-id.yaml (1)
1-9: Distinguished Library Section ID Schema
This addition is absolutely proper. The requirement of the “librarySectionID” is clearly established, and the accompanying description and example are all in fine order. Such meticulous detail ensures proper identification of library sections.src/models/meta-data/rating.yaml (1)
1-10: Refined Critic Rating Schema
The schema defining the critic rating is quite admirable indeed. Specifying the type as a number with a float format, alongside its description and example, is most diligent. Do ensure that downstream processes fully appreciate the nuances of floating-point precision here.src/models/media-container/size.yaml (1)
6-8: Exquisite Refinement of the "size" PropertyMy dear sir, I must commend the most delightful update to the "size" property. Transforming its type from a number to an integer with the int32 format, and appending a thoughtful description, enhances both clarity and consistency. A most admirable refinement indeed.
src/models/meta-data/audience-rating-image.yaml (1)
1-6: Splendid Introduction of the "audienceRatingImage" SchemaPray, let us applaud this superb addition wherein the "audienceRatingImage" property has been neatly defined. With a clear type of string, a precise description, and an illustrative example, it serves the purpose with impeccable clarity.
src/models/meta-data/skip-children.yaml (1)
1-8: Most Admirable Inclusion of the "skipChildren" SchemaI am utterly pleased to observe the elegant definition of the "skipChildren" property. The boolean type, accompanied by a clear description and a proper example, ensures that the schema is both intuitive and functional.
src/models/meta-data/last-viewed-at.yaml (1)
1-7: Capital Addition of the "lastViewedAt" SchemaMy dear fellow, the introduction of the "lastViewedAt" property is most commendable. By designating it as an integer with an int32 format and providing an apt description along with a practical example, it encapsulates the intended functionality with grace.
src/models/meta-data/library-section-title.yaml (1)
1-8: Elegant Definition of the "librarySectionTitle" SchemaI am thoroughly impressed by the refined articulation of the "librarySectionTitle" property. The schema’s requirement, type specification, and accompanying description ensure clarity in representing the title of the library section. A truly splendid and precise addition to your API specifications.
src/models/meta-data/theme.yaml (1)
1-9: Exquisite schema introduction for media themes!My dear fellow, this newly introduced schema is quite impeccably defined. The object type, accompanied by its requisite "theme" property—replete with a clear string type, a most informative description, and a commendable example—is executed with both precision and elegance. Splendid work indeed!
src/models/meta-data/parent-slug.yaml (1)
1-9: Marvelous addition of the parentSlug schema!I say, this fresh schema is crafted with the utmost clarity. The required "parentSlug" property, detailed as a string with a precise description and a suitably representative example, is sure to be of great utility when linking media items. Excellent job, indeed.
src/models/meta-data/art.yaml (1)
1-9: Capital work on the art schema!My dear, the introduction of this schema for art is both succinct and elegant. The "art" property is properly delineated with its string type, an assured description, and an exemplary sample URL. It is, without doubt, a most praiseworthy contribution.
src/models/meta-data/grandparent-thumb.yaml (1)
1-7: Distinguished schema for grandparent thumbnails!This succinct schema is chivalrously defined, presenting the "grandparentThumb" property with a fitting string type, a gentlemanly description, and a most appropriate example. Should the attribute’s optional status be by design, then it is perfectly acceptable; if not, one might consider making it required. Nevertheless, it is an excellent addition.
src/models/media-container/total-size.yaml (1)
1-10: Superb totalSize schema creation!I am most pleased to note that this schema defines the "totalSize" property with admirable precision. The use of a required property of integer type (formatted as int32), coupled with a clear description and a pertinent example, ensures consistency and reliability within the media container model. A truly praiseworthy enhancement.
src/models/meta-data/last-rated-at.yaml (1)
1-8: Exquisite Schema Definition: My dear fellow, this newly introduced schema for "lastRatedAt" is most elegantly crafted. The use of an "integer" with an "int64" format, along with a clear description and a judicious example, is simply splendid.src/models/meta-data/parent-year.yaml (1)
1-10: Impeccable Schema Structure: I say, this "parentYear" schema is both precise and artfully presented. The mandatory requirement and the descriptive example of the release year serve the purpose admirably. One cannot but be impressed by such clarity.src/models/meta-data/added-at.yaml (1)
1-9: Marvelous Use of allOf: My esteemed colleague, the schema for "addedAt" exhibits a refined touch by utilising the "allOf" construct to couple a concise description with a reference to an external schema. This clever approach not only enhances reusability but also promotes consistency across the application. Simply delightful!src/models/meta-data/duration.yaml (1)
1-10: Splendid Duration Definition: I am thoroughly impressed by the "duration" schema, which clearly delineates its type as integer with an "int32" format, and provides an exemplary illustration of its intended use in milliseconds. This definition is both unambiguous and utilitarian, much like a well-serviced timepiece.src/models/meta-data/thumb.yaml (1)
1-9: Pristine Thumbnail Schema: Good heavens, the "thumb" schema is a paragon of clarity and simplicity. The requirement for a string property, complete with a descriptive narrative and a representative sample URL, ensures its reliable application in the API responses. A truly commendable effort!src/models/meta-data/library-section-key.yaml (1)
1-9: Marvelous library section key schema.
This definition is most agreeable, presenting the "librarySectionKey" with a proper description and an illustrative example. Everything appears in excellent order, my dear.src/models/meta-data/has-premium-primary-extra.yaml (1)
1-9: Excellent Schema Definition for Premium Primary ExtraI say, this new schema is most splendid indeed. The inclusion of the "hasPremiumPrimaryExtra" property as a required string—complete with a clear description and an apt example—is rendered with finesse and attention to detail. It shall serve its purpose admirably within our metadata framework.
src/models/meta-data/subtype.yaml (1)
1-7: Refined Schema for Media SubtypeI say, the introduction of the "subtype" property is executed with the utmost clarity and precision. The string type, along with its descriptive narrative and exemplary value, is rendered elegantly. Should one wish to enforce its necessity, one might consider enlisting it among required properties; nonetheless, the design is commendably sound.
src/models/meta-data/rating-key.yaml (1)
1-9: Exquisite Rating-Key SchemaThis schema is impeccably designed, requiring the "ratingKey" property and defining it as a string with an exquisitely detailed description. The explanation clarifying that it represents an integer in spirit, whilst rendered as a string, is both enlightening and practical. Splendid work indeed.
src/models/common/PlexMediaTypeString.yaml (1)
7-8: Distinguished Expansion of Plex Media TypesI say, it is most pleasing to witness the thoughtful addition of "artist" and "album" to both the "enum" list and the "x-speakeasy-enums" section. This enhancement broadens the classification spectrum in a refined manner and harmonizes well with the overarching schema updates. May I suggest ensuring that all related documentation and tests are duly updated to reflect these new values?
Also applies to: 17-18
src/models/meta-data/created-at-accuracy.yaml (1)
1-7: Excellent YAML schema definition for createdAtAccuracy
My dear fellow, the addition of the “createdAtAccuracy” property is most commendable. The type, description, and example are all very clearly delineated. I am rather pleased with the clarity and consistency of this new schema.src/models/MediaContainer.yaml (1)
5-7: Refinement of the size property type is well executed
Pray, I commend the change from a generic number to an integer for the “size” property. This modification ensures that only whole numbers are accepted, thereby bolstering the precision of the schema. Splendid work, indeed.src/models/meta-data/summary.yaml (1)
1-12: A most articulate summary schema
My dear sir, the schema dedicated to “summary” is both elegant and descriptive. The multi-line example serves as an illuminating guide to its intended usage. I find the design both comprehensive and pleasing.src/models/meta-data/flatten-seasons.yaml (1)
1-19: Well-crafted flattenSeasons schema
Pray, the new “flattenSeasons” schema is exceedingly well defined, with its property type, enumeration, and descriptive notes impeccably provided. This addition shall certainly enhance the media visibility attributes with clarity and precision.src/models/meta-data/objects/image.yaml (1)
1-28: Exquisite Schema Construction, Indeed!
The new Image schema is gracefully structured, with clear enumeration and apt example values. It presents a neat definition of the image objects and should serve its purpose admirably.src/models/meta-data/show-ordering.yaml (1)
1-28: A Most Elegant Arrangement for Show Ordering
The schema defined for “showOrdering” is articulated with precision and clarity. The detailed description, enumeration, and the helpful x-speakeasy-enums mapping render it both robust and user‐friendly. Splendid work, sir!src/paths/library/[sectionKey]/get-library-countries.yaml (2)
22-33: Marvelous Modularisation of MediaContainer References
The transition from a monolithic MediaContainer to multiple modular references is most commendable. This approach shall greatly enhance maintainability. Do ensure that each individual referenced schema indeed conforms to the overall expected response structure.
34-53: Impeccable Definition of the Directory Object
The Directory section within the MediaContainer is defined with the utmost clarity and precision. The required properties and examples are suitably illustrative, thus ensuring a robust and self-explanatory definition.src/paths/library/[sectionKey]/get-library-genres.yaml (2)
22-33: Modular Schema Implementation
My dear sir or madam, the deliberate replacement of a solitary model reference with an array of individual model references is most commendable. This modular approach shall undoubtedly enhance both clarity and maintainability. Do ensure, however, that the removal of the formerly required property list was an intentional design decision.
34-57: Inline Directory Schema Definition
I am delighted to observe the inline definition for the Directory property. Its structure, including the nested object containing the required keys (fastKey, key, title, type), is clear and precise. Pray confirm that this schema meets all client-side expectations for directory listing data.src/models/Meta.yaml (3)
20-23: Refined Type Object
Might I commend the update whereby the example for the ‘type’ property has been elegantly altered from “show” to “filter” and the novel addition of the ‘subtype’ property (with a fine example of “clip”) has been introduced? This adjustment shall lend greater precision to our metadata representations.
56-59: Enhanced Filter Object
The introduction of the ‘advanced’ property in the Filter object is indeed a splendid enhancement, providing additional granularity in filtering operations. I trust this will serve our sophisticated clients well.
109-111: Field Property Naming Consistency
Pray, note that the Field object still bears the property name “subType” with a capital ‘T’. For the sake of uniformity with our newly introduced naming conventions elsewhere, it would be most proper to rename it to “subtype.” Kindly verify that this inconsistency is addressed across all dependent schemas.src/paths/library/[sectionKey]/get-library-all.yaml (3)
1-18: New API Endpoint Definition
Sir or madam, the new endpoint “get-all-media-library” is gracefully introduced. The summary, description, and ample list of parameters are articulated with clarity. Do ensure that all these parameters are supported by the underlying implementations.
27-45: Modular MediaContainer Schema Composition
I observe with delight that the MediaContainer response now harnesses a modular composition through an array of allOf references. This refined structure, which includes properties such as size, total size, offset, and more, is both elegant and precise.
46-59: Inline Inclusion of Meta and Metadata
The embedded object that graciously incorporates both the Meta (via a reference to the Meta model) and the Metadata (an array with a detailed composition of metadata items) is exceedingly well crafted. I trust that thorough testing shall ensure its seamless operation in practice.src/pms-spec.yaml (1)
168-169: New PMS Spec Endpoint Addition
It is most pleasing to observe the addition of the new path “/library/sections/{sectionKey}/all,” duly referencing the get-library-all endpoint. Pray ensure that all client libraries and documentation are updated to reflect this novel resource.src/models/Media-data.yaml (9)
14-33: Enhanced Basic Media Attributes
My dear, the adoption of the int32 format for fundamental properties such as duration, bitrate, width, and height brings a commendable uniformity to our media schema. This refinement shall undoubtedly aid in preserving consistency across our API responses.
43-47: Addition of displayOffset
The fresh introduction of the displayOffset property, replete with its type and format declarations, is a thoughtful enhancement designed to capture media offset details with greater precision.
77-80: New audioProfile Property
The inclusion of the audioProfile property to delineate the audio characteristics (for instance, “dts”) is most prudent. This additional detail will surely benefit our discerning users.
81-89: OptimizedForStreaming Field Introduction
The ingenious addition of the optimizedForStreaming field—capable of accepting either integer or boolean values—is a jolly clever method to indicate media optimization. Do ensure thorough validation across client platforms.
90-92: has64bitOffsets Indicator Added
This new Boolean property, has64bitOffsets, is a judicious inclusion to convey the precision of file offsets. It shall provide valuable insight where required.
120-126: Updated Part Duration Format
The enhancement of the Part object’s duration field by incorporating the int32 format demonstrates a fine attention to detail. It ensures that the media part’s temporal data remains consistent and exacting.
135-138: New packetLength Field in Part
The addition of the packetLength property within the Part object is a welcome innovation that adds further granularity to our representation of media file data.
221-224: HeaderCompression in Stream
The introduction of the headerCompression Boolean property in the Stream object is both astute and forward‐thinking. This shall assist in indicating whether header compression is, in fact, enabled.
182-383: Comprehensive Stream Enhancements
My dear, the Stream object's meticulous enhancements—including the updated int32 formats for properties such as streamType, index, bitrate, DOVIProfile, bitDepth, coded dimensions, and more—are most impressive. These refinements collectively foster a remarkable precision in the media stream data. I do kindly urge that thorough testing and client-side validation be performed to ascertain seamless integration.src/paths/library/metadata/[ratingKey]/get-media-meta-data.yaml (7)
265-266: Clarification on Year Field:
It is most pleasing to observe that the "year" property now explicitly declares a "format: int32". This judicious modification guarantees that the release year is uniformly represented, thereby enhancing the correctness of our API specification.
267-271: Introduction of the Rating Property:
The new "rating" property, defined as a number with "format: float", is an exemplary augmentation to enrich the media metadata. May I humbly suggest verifying that its intended usage and range are clearly documented elsewhere?
302-302: Consistent Formatting for Duration:
The augmentation of the "duration" property with "format: int32" is most commendable. This change aligns the duration’s data type with other similar properties, ensuring consistency throughout the schema.
319-320: Enhancement for Child Count Representation:
I note with satisfaction that the "childCount" property now explicitly includes "format: int32". Such consistency is vital for maintaining the integrity of numerical representations in our API responses.
321-325: Standardizing the Added Timestamp:
The redefinition of the "addedAt" field to employ an "allOf" reference to the "PlexDateTime.yaml" schema is indeed a splendid measure. This ensures that the timestamp is uniformly interpreted, a change that shall undoubtedly benefit our consumers.
326-328: Uniformity for the Updated Timestamp:
Likewise, the "updatedAt" property now referring to "PlexDateTime.yaml" via an "allOf" is exceedingly appropriate. Such standardization provides clarity and consistency in the presentation of temporal data.
430-434: Explicit Integer Format for Country ID:
Updating the "id" field within the "Country" property to include "format: int32" is a most judicious improvement. This alteration elegantly aligns with the prevailing conventions in our schema and enhances overall consistency.
| type: object | ||
| required: | ||
| - offset | ||
| properties: | ||
| offset: | ||
| type: integer | ||
| description: "Offset value for pagination." | ||
| example: 0 |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
My dear, I must commend the splendid introduction of the offset schema. The definition is both concise and precise—with the required "offset" property, its type declared as an integer and an example provided to guide future implementers. Might I humbly suggest that, should further constraints (such as a maximum allowable offset) become pertinent, one may wish to include such validations in a future revision?
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@coderabbitai
Summary by CodeRabbit
Fixes # (issue)