fixing lint issues

package.json

@@ -5,6 +5,7 @@
   "main": "src/pms-spec.yaml",
   "scripts": {
     "dev": "redocly preview -d=./src",
+    "preview-docs": "redocly preview-docs src/pms-spec.yaml --config=./redocly.yaml",
     "stats": "redocly stats ./src/pms-spec.yaml",
     "build": "swagger-cli bundle --dereference ./src/pms-spec.yaml -t yaml -o ./output/plex-media-server-spec-dereferenced.yaml",
     "build-redocly": "redocly bundle ./src/pms-spec.yaml --ext yaml  -o ./output/plex-media-server-spec-dereferenced.yaml",

redocly.yaml

@@ -0,0 +1,2 @@
+extends:
+  - recommended

src/parameters/plex-token.yaml

@@ -3,5 +3,5 @@ in: query
 description: Plex Authentication Token
 schema:
   type: string
-example: CV5xoxjTpFKUzBTShsaf
+  example: CV5xoxjTpFKUzBTShsaf
 required: true

src/parameters/type.yaml

@@ -1,15 +1,6 @@
-#name: type
-#in: query
-#description: |
-#  Filter the type of media to retrieve
-#required: false
-#schema:
-# $ref: '../models/common/PlexMediaType.yaml'
-#
-#
 name: type
 in: query
-description: Plex content type to search for
+description: Filter the type of media to retrieve
 schema:
   type: integer
   enum:
@@ -17,5 +8,5 @@ schema:
     - 2
     - 3
     - 4
-example: 2
+  example: 2
 required: true

src/paths/library/[sectionId]/get-search-library.yaml

@@ -2,7 +2,7 @@ get:
   tags:
     - Library
   summary: Search Library
-  operationId: searchLibrary
+  operationId: get-search-library
   description: |
     Search for content within a specific section of the library.
 
@@ -29,8 +29,8 @@ get:
       description: the Id of the library to query
       schema:
         type: integer
-    - $ref: "../../parameters/accept-application-json.yaml"
-    - $ref: "../../parameters/type.yaml"
+    - $ref: "../../../parameters/accept-application-json.yaml"
+    - $ref: "../../../parameters/type.yaml"
   responses:
     "200":
       description: The contents of the library by section and type
@@ -161,6 +161,6 @@ get:
                           format: int32
                           example: 1705636920
     "400":
-      $ref: "../../responses/400.yaml"
+      $ref: "../../../responses/400.yaml"
     "401":
-      $ref: "../../responses/401.yaml"
+      $ref: "../../../responses/401.yaml"

src/paths/library/content-common.yaml

@@ -1,36 +0,0 @@
-get:
-  tags:
-    - Library
-  summary: Get Common Library Items
-  description: |
-    Represents a "Common" item. It contains only the common attributes of the items selected by the provided filter
-  operationId: getCommonLibraryItems
-  parameters:
-    - name: sectionId
-      description: the Id of the library to query
-      in: path
-      schema:
-        type: number
-      required: true
-    - name: type
-      description: item type
-      in: query
-      schema:
-        type: number
-      required: true
-    - name: filter
-      description: the filter parameter
-      in: query
-      schema:
-        type: string
-      required: false
-
-  responses:
-    "200":
-      description: The details of the library
-    "400":
-      $ref: "../../responses/400.yaml"
-    "401":
-      $ref: "../../responses/401.yaml"
-    "404":
-      description: In response to a non-existant sectionId.

src/paths/user/user.yaml

@@ -8,6 +8,7 @@ get:
   operationId: getUserDetails
   parameters:
     - $ref: '../../parameters/plex-token.yaml'
+    - $ref: "../../parameters/accept-application-json.yaml"
   responses:
     '200':
       description: Logged in user details

src/pms-spec.yaml

@@ -41,15 +41,6 @@ components:
       name: X-Plex-Token
 
 paths:
-  parameters:
-    - name: Accept
-      in: header
-      required: true
-      schema:
-        type: string
-        enum: [application/json]
-      description: Specifies that the client expects a JSON response.
-
   # Plex Media Server endpoints
 
   # Colon Endpoints
@@ -137,7 +128,7 @@ paths:
   /library/sections/{sectionId}/refresh:
     $ref: "./paths/library/[sectionId]/refresh/get-refresh-library-metadata.yaml"
   /library/sections/{sectionId}/search:
-    $ref: "./paths/library/content-search.yaml"
+    $ref: "./paths/library/[sectionId]/get-search-library.yaml"
   /library/metadata/{ratingKey}:
     $ref: "./paths/library/metadata.yaml"
   /library/metadata/{ratingKey}/children: