refactor: remove descriptions from YAML files for clarity

src/models/media/aspect-ratio.yaml

@@ -1,7 +1,6 @@
 type: object
 required:
   - aspectRatio
-description: "Aspect ratio of the video."
 properties:
   aspectRatio:
     type: number

src/models/media/audio-channels.yaml

@@ -1,7 +1,6 @@
 type: object
 required:
   - audioChannels
-description: "Number of audio channels."
 properties:
   audioChannels:
     type: integer

src/models/media/audio-codec.yaml

@@ -1,9 +1,8 @@
 type: object
 required:
   - audioCodec
-description: "Audio codec used."
 properties:
   audioCodec:
     type: string
     description: "Audio codec used."
-    example: "eac3" 
+    example: "aac" 

src/models/media/audio-profile.yaml

@@ -1,9 +1,8 @@
 type: object
 required:
   - audioProfile
-description: "The audio profile used for the media."
 properties:
   audioProfile:
     type: string
     description: "The audio profile used for the media (e.g., DTS, Dolby Digital, etc.)."
-    example: "dts" 
+    example: "dts"

src/models/media/bitrate.yaml

@@ -1,10 +1,9 @@
 type: object
 required:
   - bitrate
-description: "Bitrate in bits per second."
 properties:
   bitrate:
     type: integer
     format: int32
     description: "Bitrate in bits per second."
-    example: 25512 
+    example: 25512

src/models/media/container.yaml

@@ -1,9 +1,8 @@
 type: object
 required:
   - container
-description: "File container type."
 properties:
   container:
     type: string
-    description: "File container type."
-    example: "mkv" 
+    description: "Container format of the media."
+    example: "mp4" 

src/models/media/display-offset.yaml

@@ -1,9 +1,8 @@
 type: object
 required:
   - displayOffset
-description: "Display offset value."
 properties:
   displayOffset:
     type: integer
     format: int32
-    example: 50 
+    example: 50

src/models/media/duration.yaml

@@ -1,10 +1,9 @@
 type: object
 required:
   - duration
-description: "Duration of the media in milliseconds."
 properties:
   duration:
     type: integer
     format: int32
     description: "Duration of the media in milliseconds."
-    example: 9610350 
+    example: 9610350

src/models/media/has-64bit-offsets.yaml

@@ -1,8 +1,7 @@
 type: object
 required:
   - has64bitOffsets
-description: "Indicates whether the media has 64-bit offsets."
 properties:
   has64bitOffsets:
     type: boolean
-    example: false 
+    example: false

src/models/media/has-voice-activity.yaml

@@ -1,9 +1,8 @@
 type: object
 required:
   - hasVoiceActivity
-description: "Indicates whether voice activity is detected."
 properties:
   hasVoiceActivity:
     type: boolean
     description: "Indicates whether voice activity is detected."
-    example: false 
+    example: false

src/models/media/height.yaml

@@ -1,10 +1,9 @@
 type: object
 required:
   - height
-description: "Video height in pixels."
 properties:
   height:
     type: integer
     format: int32
     description: "Video height in pixels."
-    example: 1602 
+    example: 1602

src/models/media/id.yaml

@@ -1,9 +1,8 @@
 type: object
 required:
   - id
-description: "Unique media identifier."
 properties:
   id:
     type: integer
     description: "Unique media identifier."
-    example: 387322 
+    example: 387322

src/models/media/optimized-for-streaming.yaml

@@ -1,7 +1,6 @@
 type: object
 required:
   - optimizedForStreaming
-description: "Has this media been optimized for streaming."
 properties:
   optimizedForStreaming:
     description: "Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true"

src/models/media/part/accessible.yaml

@@ -1,7 +1,6 @@
 type: object
 required:
   - accessible
-description: "Indicates if the part is accessible."
 properties:
   accessible:
     type: boolean

src/models/media/part/audio-profile.yaml

@@ -1,9 +1,8 @@
 type: object
 required:
   - audioProfile
-description: "The audio profile used for the media."
 properties:
   audioProfile:
     type: string
     description: "The audio profile used for the media (e.g., DTS, Dolby Digital, etc.)."
-    example: "dts" 
+    example: "dts"

src/models/media/part/container.yaml

@@ -1,9 +1,8 @@
 type: object
 required:
   - container
-description: "Container format of the part."
 properties:
   container:
     type: string
     description: "Container format of the part."
-    example: "mkv" 
+    example: "mkv"

src/models/media/part/duration.yaml

@@ -1,10 +1,9 @@
 type: object
 required:
   - duration
-description: "Duration of the part in milliseconds."
 properties:
   duration:
     type: integer
     format: int32
     description: "Duration of the part in milliseconds."
-    example: 9610350 
+    example: 9610350

src/models/media/part/file.yaml

@@ -1,9 +1,8 @@
 type: object
 required:
   - file
-description: "File path for the part."
 properties:
   file:
     type: string
     description: "File path for the part."
-    example: "/mnt/Movies_1/W/Wicked (2024).mkv" 
+    example: "/mnt/Movies_1/W/Wicked (2024).mkv"

src/models/media/part/has-64bit-offsets.yaml

@@ -1,8 +1,7 @@
 type: object
 required:
   - has64bitOffsets
-description: "Indicates whether the part has 64-bit offsets."
 properties:
   has64bitOffsets:
     type: boolean
-    example: false 
+    example: false

src/models/media/part/has-thumbnail.yaml

@@ -1,9 +1,8 @@
 type: object
 required:
   - hasThumbnail
-description: "Indicates if the part has a thumbnail."
 properties:
   hasThumbnail:
     allOf:
       - description: "Indicates if the part has a thumbnail."
-      - $ref: "../models/common/PlexBooleanString.yaml" 
+      - $ref: "../models/common/PlexBooleanString.yaml"

src/models/media/part/id.yaml

@@ -1,9 +1,8 @@
 type: object
 required:
   - id
-description: "Unique part identifier."
 properties:
   id:
     type: integer
     description: "Unique part identifier."
-    example: 418385 
+    example: 418385

src/models/media/part/indexes.yaml

@@ -1,8 +1,7 @@
 type: object
 required:
   - indexes
-description: "Indexes for the part."
 properties:
   indexes:
     type: string
-    example: "sd" 
+    example: "sd"

src/models/media/part/key.yaml

@@ -1,9 +1,8 @@
 type: object
 required:
   - key
-description: "Key to access this part."
 properties:
   key:
     type: string
     description: "Key to access this part."
-    example: "/library/parts/418385/1735864239/file.mkv" 
+    example: "/library/parts/418385/1735864239/file.mkv"

src/models/media/part/optimized-for-streaming.yaml

@@ -1,7 +1,6 @@
 type: object
 required:
   - optimizedForStreaming
-description: "Has this part been optimized for streaming."
 properties:
   optimizedForStreaming:
     description: "Has this media been optimized for streaming. NOTE: This can be 0, 1, false or true"
@@ -10,4 +9,4 @@ properties:
         format: int32
         enum: [0, 1]
       - type: boolean
-        enum: [true, false] 
+        enum: [true, false]

src/models/media/part/packet-length.yaml

@@ -1,9 +1,8 @@
 type: object
 required:
   - packetLength
-description: "Packet length for the part."
 properties:
   packetLength:
     type: integer
     format: int32
-    example: 188 
+    example: 188

src/models/media/part/size.yaml

@@ -1,9 +1,8 @@
 type: object
 required:
   - size
-description: "File size in bytes."
 properties:
   size:
     description: "File size in bytes."
     type: integer
-    example: 30649952104 
+    example: 30649952104

src/models/media/part/stream/audio-channel-layout.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Audio channel layout information."
 properties:
   audioChannelLayout:
     type: string
     description: "Audio channel layout."
-    example: "5.1(side)" 
+    example: "5.1(side)"

src/models/media/part/stream/bit-depth.yaml

@@ -1,8 +1,7 @@
 type: object
-description: "Bit depth information."
 properties:
   bitDepth:
     type: integer
     format: int32
     description: "Bit depth of the video stream."
-    example: 10 
+    example: 10

src/models/media/part/stream/bitrate.yaml

@@ -1,8 +1,7 @@
 type: object
-description: "Stream bitrate information."
 properties:
   bitrate:
     type: integer
     format: int32
     description: "Bitrate of the stream."
-    example: 24743 
+    example: 24743

src/models/media/part/stream/channels.yaml

@@ -1,8 +1,7 @@
 type: object
-description: "Audio channels information."
 properties:
   channels:
     type: integer
     format: int32
     description: "Number of audio channels (for audio streams)."
-    example: 6 
+    example: 6

src/models/media/part/stream/chroma-location.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Chroma location information."
 properties:
   chromaLocation:
     type: string
     description: "Chroma sample location."
-    example: "topleft" 
+    example: "topleft"

src/models/media/part/stream/chroma-subsampling.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Chroma subsampling information."
 properties:
   chromaSubsampling:
     type: string
     description: "Chroma subsampling format."
-    example: "4:2:0" 
+    example: "4:2:0"

src/models/media/part/stream/closed-captions.yaml

@@ -1,6 +1,5 @@
 type: object
-description: "Closed captions information."
 properties:
   closedCaptions:
     type: boolean
-    example: true 
+    example: true

src/models/media/part/stream/codec.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Codec information."
 properties:
   codec:
     type: string
     description: "Codec used by the stream."
-    example: "hevc" 
+    example: "hevc"

src/models/media/part/stream/coded-height.yaml

@@ -1,8 +1,7 @@
 type: object
-description: "Coded height information."
 properties:
   codedHeight:
     type: integer
     format: int32
     description: "Coded video height."
-    example: 1608 
+    example: 1608

src/models/media/part/stream/coded-width.yaml

@@ -1,8 +1,7 @@
 type: object
-description: "Coded width information."
 properties:
   codedWidth:
     type: integer
     format: int32
     description: "Coded video width."
-    example: 3840 
+    example: 3840

src/models/media/part/stream/color-primaries.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Color primaries information."
 properties:
   colorPrimaries:
     type: string
     description: "Color primaries used."
-    example: "bt2020" 
+    example: "bt2020"

src/models/media/part/stream/color-range.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Color range information."
 properties:
   colorRange:
     type: string
     description: "Color range (e.g., tv)."
-    example: "tv" 
+    example: "tv"

src/models/media/part/stream/color-space.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Color space information."
 properties:
   colorSpace:
     type: string
     description: "Color space."
-    example: "bt2020nc" 
+    example: "bt2020nc"

src/models/media/part/stream/color-trc.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Color transfer characteristics information."
 properties:
   colorTrc:
     type: string
     description: "Color transfer characteristics."
-    example: "smpte2084" 
+    example: "smpte2084"

src/models/media/part/stream/default.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Default stream indicator."
 properties:
   default:
     type: boolean
     description: "Indicates if this stream is default."
-    example: true 
+    example: true

src/models/media/part/stream/display-title.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Display title information."
 properties:
   displayTitle:
     type: string
     description: "Display title for the stream."
-    example: "4K DoVi/HDR10 (HEVC Main 10)" 
+    example: "4K DoVi/HDR10 (HEVC Main 10)"

src/models/media/part/stream/dovi-bl-compat-id.yaml

@@ -1,8 +1,7 @@
 type: object
-description: "Dolby Vision BL compatibility ID information."
 properties:
   DOVIBLCompatID:
     type: integer
     format: int32
     description: "Dolby Vision BL compatibility ID."
-    example: 1 
+    example: 1

src/models/media/part/stream/dovi-bl-present.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Dolby Vision BL presence information."
 properties:
   DOVIBLPresent:
     type: boolean
     description: "Indicates if Dolby Vision BL is present."
-    example: true 
+    example: true

src/models/media/part/stream/dovi-el-present.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Dolby Vision EL presence information."
 properties:
   DOVIELPresent:
     type: boolean
     description: "Indicates if Dolby Vision EL is present."
-    example: false 
+    example: false

src/models/media/part/stream/dovi-level.yaml

@@ -1,8 +1,7 @@
 type: object
-description: "Dolby Vision level information."
 properties:
   DOVILevel:
     type: integer
     format: int32
     description: "Dolby Vision level."
-    example: 6 
+    example: 6

src/models/media/part/stream/dovi-present.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Dolby Vision presence information."
 properties:
   DOVIPresent:
     type: boolean
     description: "Indicates if Dolby Vision is present."
-    example: true 
+    example: true

src/models/media/part/stream/dovi-profile.yaml

@@ -1,8 +1,7 @@
 type: object
-description: "Dolby Vision profile information."
 properties:
   DOVIProfile:
     type: integer
     format: int32
     description: "Dolby Vision profile."
-    example: 8 
+    example: 8

src/models/media/part/stream/dovi-rpu-present.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Dolby Vision RPU presence information."
 properties:
   DOVIRPUPresent:
     type: boolean
     description: "Indicates if Dolby Vision RPU is present."
-    example: true 
+    example: true

src/models/media/part/stream/dovi-version.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Dolby Vision version information."
 properties:
   DOVIVersion:
     type: string
     description: "Dolby Vision version."
-    example: "1.0" 
+    example: "1.0"

src/models/media/part/stream/dub.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Dub information."
 properties:
   dub:
     type: boolean
     description: "Indicates if the stream is a dub."
-    example: true 
+    example: true

src/models/media/part/stream/embedded-in-video.yaml

@@ -1,6 +1,5 @@
 type: object
-description: "Embedded in video information."
 properties:
   embeddedInVideo:
     type: string
-    example: "progressive" 
+    example: "progressive"

src/models/media/part/stream/extended-display-title.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Extended display title information."
 properties:
   extendedDisplayTitle:
     type: string
     description: "Extended display title for the stream."
-    example: "4K DoVi/HDR10 (HEVC Main 10)" 
+    example: "4K DoVi/HDR10 (HEVC Main 10)"

src/models/media/part/stream/forced.yaml

@@ -1,6 +1,5 @@
 type: object
-description: "Forced stream information."
 properties:
   forced:
     type: boolean
-    example: true 
+    example: true

src/models/media/part/stream/format.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Format of the stream."
 properties:
   format:
     type: string
     description: "Format of the stream (e.g., srt)."
-    example: "srt" 
+    example: "srt"

src/models/media/part/stream/frame-rate.yaml

@@ -1,8 +1,7 @@
 type: object
-description: "Frame rate information."
 properties:
   frameRate:
     type: number
     format: float
     description: "Frame rate of the stream."
-    example: 23.976 
+    example: 23.976

src/models/media/part/stream/has-scaling-matrix.yaml

@@ -1,6 +1,5 @@
 type: object
-description: "Scaling matrix information."
 properties:
   hasScalingMatrix:
     type: boolean
-    example: false 
+    example: false

src/models/media/part/stream/header-compression.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Header compression information."
 properties:
   headerCompression:
     type: boolean
     description: "Indicates whether header compression is enabled."
-    example: true 
+    example: true

src/models/media/part/stream/height.yaml

@@ -1,8 +1,7 @@
 type: object
-description: "Stream height information."
 properties:
   height:
     type: integer
     format: int32
     description: "Height of the video stream."
-    example: 1602 
+    example: 1602

src/models/media/part/stream/id.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Unique stream identifier."
 properties:
   id:
     type: integer
     description: "Unique stream identifier."
-    example: 1002625 
+    example: 1002625

src/models/media/part/stream/index.yaml

@@ -1,8 +1,7 @@
 type: object
-description: "Stream index information."
 properties:
   index:
     type: integer
     format: int32
     description: "Index of the stream."
-    example: 0 
+    example: 0

src/models/media/part/stream/key.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Stream key information."
 properties:
   key:
     type: string
     description: "Key to access this stream part."
-    example: "/library/streams/216389" 
+    example: "/library/streams/216389"

src/models/media/part/stream/language-code.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Stream language code information."
 properties:
   languageCode:
     type: string
     description: "ISO language code."
-    example: "eng" 
+    example: "eng"

src/models/media/part/stream/language-tag.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Stream language tag information."
 properties:
   languageTag:
     type: string
     description: "Language tag (e.g., en)."
-    example: "en" 
+    example: "en"

src/models/media/part/stream/language.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Stream language information."
 properties:
   language:
     type: string
     description: "Language of the stream."
-    example: "English" 
+    example: "English"

src/models/media/part/stream/level.yaml

@@ -1,8 +1,7 @@
 type: object
-description: "Video level information."
 properties:
   level:
     type: integer
     format: int32
     description: "Video level."
-    example: 150 
+    example: 150

src/models/media/part/stream/original.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Original stream information."
 properties:
   original:
     type: boolean
     description: "Indicates if this is the original stream."
-    example: true 
+    example: true

src/models/media/part/stream/profile.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Video profile information."
 properties:
   profile:
     type: string
     description: "Video profile."
-    example: "main 10" 
+    example: "main 10"

src/models/media/part/stream/ref-frames.yaml

@@ -1,8 +1,7 @@
 type: object
-description: "Reference frames information."
 properties:
   refFrames:
     type: integer
     format: int32
     description: "Number of reference frames."
-    example: 1 
+    example: 1

src/models/media/part/stream/sampling-rate.yaml

@@ -1,8 +1,7 @@
 type: object
-description: "Sampling rate information."
 properties:
   samplingRate:
     type: integer
     format: int32
     description: "Sampling rate for the audio stream."
-    example: 48000 
+    example: 48000

src/models/media/part/stream/scan-type.yaml

@@ -1,6 +1,5 @@
 type: object
-description: "Scan type information."
 properties:
   scanType:
     type: string
-    example: "progressive" 
+    example: "progressive"

src/models/media/part/stream/selected.yaml

@@ -1,7 +1,6 @@
 type: object
-description: "Stream selection information."
 properties:
   selected:
     type: boolean
     description: "Indicates if this stream is selected (applicable for audio streams)."
-    example: true 
+    example: true

src/models/media/part/stream/stream-type.yaml

@@ -1,5 +1,4 @@
 type: object
-description: "Stream type definition."
 properties:
   streamType:
     type: integer
@@ -18,4 +17,4 @@ properties:
       Stream type:
         - VIDEO = 1
         - AUDIO = 2
-        - SUBTITLE = 3 
+        - SUBTITLE = 3

src/models/media/part/stream/width.yaml

@@ -1,8 +1,7 @@
 type: object
-description: "Stream width information."
 properties:
   width:
     type: integer
     format: int32
     description: "Width of the video stream."
-    example: 3840 
+    example: 3840

src/models/media/video-codec.yaml

@@ -1,9 +1,8 @@
 type: object
 required:
   - videoCodec
-description: "Video codec used."
 properties:
   videoCodec:
     type: string
     description: "Video codec used."
-    example: "hevc" 
+    example: "hevc"

src/models/media/video-frame-rate.yaml

@@ -1,10 +1,9 @@
 type: object
 required:
   - videoFrameRate
-description: "Frame rate of the video."
 properties:
   videoFrameRate:
     type: string
     description: |
       Frame rate of the video. Values found include NTSC, PAL, 24p
-    example: "24p" 
+    example: "24p"

src/models/media/video-profile.yaml

@@ -1,9 +1,8 @@
 type: object
 required:
   - videoProfile
-description: "Video profile (e.g., main 10)."
 properties:
   videoProfile:
     type: string
     description: "Video profile (e.g., main 10)."
-    example: "main 10" 
+    example: "main 10"

src/models/media/video-resolution.yaml

@@ -1,9 +1,8 @@
 type: object
 required:
   - videoResolution
-description: "Video resolution (e.g., 4k)."
 properties:
   videoResolution:
     type: string
     description: "Video resolution (e.g., 4k)."
-    example: "4k" 
+    example: "4k"

src/models/media/width.yaml

@@ -1,10 +1,9 @@
 type: object
 required:
   - width
-description: "Video width in pixels."
 properties:
   width:
     type: integer
     format: int32
     description: "Video width in pixels."
-    example: 3840 
+    example: 3840