Add proper swagger route for optional path variable /assets/files r…

…oute (#58) * Add proper swagger route for optional path variable route * changelog
godaddy · May 28, 2019 · faabc1c · faabc1c
1 parent 90c3c34
commit faabc1c
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,6 @@
 # CHANGELOG
 
+- Add proper swagger route for optional path variable `/assets/files` route
 - [#57] Update `README.md`
   - Add badges
   - Add `promote` routes

diff --git a/lib/routes/assets.js b/lib/routes/assets.js
@@ -28,6 +28,37 @@ module.exports = function (app) {
   /**
    * API for serving latest files
    * @swagger
+   * /assets/files/{pkg}/{env}:
+   *   get:
+   *     summary: Gets the file assets for a given package-environment-version
+   *     security: []
+   *     produces:
+   *       - "application/json"
+   *     parameters:
+   *       - $ref: '#/parameters/Pkg'
+   *       - $ref: '#/parameters/Env'
+   *       - in: query
+   *         name: filter
+   *         required: false
+   *         schema:
+   *           type: string
+   *           maximum: 50
+   *         description: Case-insensitive substring filter to apply to the file list
+   *     responses:
+   *       200:
+   *         description: OK
+   *         content:
+   *           application/json:
+   *             schema:
+   *               $ref: '#/definitions/Assets'
+   *       400:
+   *         description: Filter is too long
+   *       403:
+   *         $ref: '#/responses/Standard403'
+   *       404:
+   *         $ref: '#/responses/Standard404'
+   *       500:
+   *         $ref: '#/responses/Standard500'
    * /assets/files/{pkg}/{env}/{version}:
    *   get:
    *     summary: Gets the file assets for a given package-environment-version