Feature/show sub original release

dredd/api-description.yml

@@ -994,6 +994,33 @@ paths:
         400:
           $ref: '#/responses/error'
           x-disabled: true
+  /history:
+    get:
+      summary: Return history entries to a specific show
+      description: |
+        The history endpoint returns logged activities stored in the history table, like episodes snatched and downloaded. Or downloaded subtitles for an episode.
+      parameters:
+        - $ref: '#/parameters/page'
+        - $ref: '#/parameters/limit'
+        - $ref: '#/parameters/sort'
+      responses:
+        200:
+          $ref: '#/responses/pagination_history'
+          x-disabled: true
+        400:
+          $ref: '#/responses/error'
+          description: Invalid series id or pagination parameters
+          x-request:
+            path-params:
+              seriesid: asdf
+          x-disabled: true
+        404:
+          $ref: '#/responses/error'
+          description: Series not found
+          x-request:
+            path-params:
+              seriesid: tvdb999999999
+          x-disabled: true
   /history/{seriesid}:
     get:
       summary: Return history entries to a specific show
@@ -1007,18 +1034,21 @@ paths:
       responses:
         200:
           $ref: '#/responses/pagination_history'
+          x-disabled: true
         400:
           $ref: '#/responses/error'
           description: Invalid series id or pagination parameters
           x-request:
-            query-params:
-              sort: abc
+            path-params:
+              seriesid: asdf
+          x-disabled: true
         404:
           $ref: '#/responses/error'
           description: Series not found
           x-request:
             path-params:
               seriesid: tvdb999999999
+          x-disabled: true
   /history/{seriesid}/episode/{episodeid}:
     get:
       summary: Return history entries for a specific episode
@@ -1034,18 +1064,21 @@ paths:
             type: array
             items:
               $ref: '#/definitions/History'
+          x-disabled: true
         400:
           $ref: '#/responses/error'
           description: Invalid series id or pagination parameters
           x-request:
-            query-params:
-              sort: abc
+            path-params:
+              seriesid: asdf
+          x-disabled: true
         404:
           $ref: '#/responses/error'
           description: Series not found
           x-request:
             path-params:
               seriesid: tvdb999999999
+          x-disabled: true
 
 definitions:
   Series:
@@ -2867,7 +2900,7 @@ parameters:
     x-example: tvdb301824
     type: string
   episode-id:
-    name: episode-id
+    name: episodeid
     in: path
     required: true
     description: The episode id to retrieve. E.g. s02e03, e34 or 2016-12-31
@@ -2993,6 +3026,36 @@ parameters:
                 - 'episode'
                 - 'season'
               example: 'episode'
+  history:
+    in: body
+    name: Search Config
+    description: Object with required information to search for a specific show's episode(s).
+    schema:
+      type: object
+      required:
+        - showSlug
+        - episodes
+      properties:
+        showSlug:
+          description: Show slug consisting of the indexer name + indexers id
+          type: string
+          example: tvdb301824
+        episodes:
+          description: An array of searched episode objects with information on the type of search used
+          type: array
+          items:
+            type: string
+          example: ["s01e01", "s03e03"]
+        options:
+          description: Type of the manual search. 'episode' or 'season' search.
+          type: object
+          properties:
+            type:
+              type: string
+              enum:
+                - 'episode'
+                - 'season'
+              example: 'episode'
 responses:
   pagination:
     description: Pagination response