Issue 639 - fix issues with api

Author: xxcxy

docs/swagger.yaml

@@ -12,16 +12,85 @@ tags:
   description: "Template files to serve as reference for multitude of tasks"
 - name: "uploads"
   description: "Upload files for batch processing"
-- name: "skills"
-  description: "Skills endpoints"
-  externalDocs:
-    description: "Proxy to EMSI skills"
-    url: "https://api.emsidata.com/apis/skills-classification#get-search-for-skills"
 schemes:
 - "https"
 - "http"
 paths:
   /templates:
+    get:
+      summary: "Get all templates"
+      description: |
+        "Return all templates. You can specify the date from and name when you would like the records.""
+      tags:
+        - "templates"
+      operationId: "getTemplates"
+      parameters:
+      - name: "from"
+        in: "query"
+        description: "The date from when you would like the uploads (inclusive)"
+        required: false
+        type: "string"
+        default: "today's value"
+      - name: "name"
+        in: "query"
+        description: "The name of templates"
+        required: false
+        type: "string"
+      responses:
+        "200":
+          description: "Success"
+          schema:
+            type: array
+            items:
+              $ref: '#/definitions/Template'
+        "400":
+          $ref: "#/definitions/BadRequest"
+        "401":
+          $ref: "#/definitions/Unauthorized"
+        "403":
+          $ref: "#/definitions/Forbidden"
+        "404":
+          $ref: "#/definitions/NotFound"
+        "500":
+          $ref: "#/definitions/ServerError"
+      security:
+      - api_key: []
+      x-swagger-router-controller: "Templates"
+
+    head:
+      summary: "Get only status code for fetching all templates"
+      description: "Equivalent to GET /templates, but returns only status codes"
+      tags:
+        - "templates"
+      operationId: "headTemplates"
+      parameters:
+      - name: "from"
+        in: "query"
+        description: "The date from when you would like the uploads (inclusive)"
+        required: false
+        type: "string"
+        default: "today's value"
+      - name: "organizationId"
+        in: "query"
+        description: "The name of templates"
+        required: false
+        type: "string"
+      responses:
+        "200":
+          description: "Success"
+        "400":
+          $ref: "#/definitions/BadRequest"
+        "401":
+          $ref: "#/definitions/Unauthorized"
+        "403":
+          $ref: "#/definitions/Forbidden"
+        "404":
+          $ref: "#/definitions/NotFound"
+        "500":
+          $ref: "#/definitions/ServerError"
+      security:
+      - api_key: []
+      x-swagger-router-controller: "Templates"
     post:
       tags:
       - "templates"
@@ -89,6 +158,29 @@ paths:
       security:
       - api_key: []
       x-swagger-router-controller: "Templates"
+    head:
+      tags:
+      - "templates"
+      summary: "Get only status code for getting template"
+      description: "Equivalent to GET /templates/:id, but returns only status codes"
+      operationId: "headTemplateById"
+      produces:
+      - "application/json"
+      parameters: []
+      responses:
+        "200":
+          description: "Success"
+        "401":
+          $ref: "#/definitions/Unauthorized"
+        "403":
+          $ref: "#/definitions/Forbidden"
+        "404":
+          $ref: "#/definitions/NotFound"
+        "500":
+          $ref: "#/definitions/ServerError"
+      security:
+      - api_key: []
+      x-swagger-router-controller: "Templates"
   /uploads:
     get:
       summary: "Get all uploads"
@@ -104,6 +196,11 @@ paths:
         required: false
         type: "string"
         default: "today's value"
+      - name: "organizationId"
+        in: "query"
+        description: "The organization id to associate with"
+        required: true
+        type: "string"
       responses:
         "200":
           description: "Success"
@@ -121,6 +218,9 @@ paths:
           $ref: "#/definitions/NotFound"
         "500":
           $ref: "#/definitions/ServerError"
+      security:
+      - api_key: []
+      x-swagger-router-controller: "Uploads"
 
     head:
       summary: "Get only status code for fetching all uploads"
@@ -135,6 +235,11 @@ paths:
         required: false
         type: "string"
         default: "today's value"
+      - name: "organizationId"
+        in: "query"
+        description: "The organization id to associate with"
+        required: true
+        type: "string"
       responses:
         "200":
           description: "Success"
@@ -148,6 +253,9 @@ paths:
           $ref: "#/definitions/NotFound"
         "500":
           $ref: "#/definitions/ServerError"
+      security:
+      - api_key: []
+      x-swagger-router-controller: "Uploads"
 
     post:
       tags:
@@ -217,6 +325,29 @@ paths:
       security:
       - api_key: []
       x-swagger-router-controller: "Uploads"
+    head:
+      tags:
+      - "uploads"
+      summary: "Get only status code for getting details of an upload"
+      description: "Equivalent to GET /uploads/:id, but returns only status codes"
+      operationId: "headUploadById"
+      produces:
+      - "application/json"
+      parameters: []
+      responses:
+        "200":
+          description: "Success"
+        "401":
+          $ref: "#/definitions/Unauthorized"
+        "403":
+          $ref: "#/definitions/Forbidden"
+        "404":
+          $ref: "#/definitions/NotFound"
+        "500":
+          $ref: "#/definitions/ServerError"
+      security:
+      - api_key: []
+      x-swagger-router-controller: "Uploads"
     patch:
       tags:
       - "uploads"
@@ -254,37 +385,6 @@ paths:
       security:
       - api_key: []
       x-swagger-router-controller: "Uploads"
-  /skills:
-    get:
-      tags:
-      - "skills"
-      summary: "Search for skills by name using the q query parameter"
-      description: "Responds with the skills search result. Proxy api to EMSI"
-      operationId: "getSkills"
-      produces:
-      - "application/json"
-      parameters:
-      - name: "q"
-        in: "query"
-        description: "The skill to search for. All special characters must be URL encoded, eg. \"C++ Progr\" should be encoded \"C%2B%2B%20Progr\""
-        required: false
-        type: "string"
-      responses:
-        "200":
-          description: "Success"
-          schema:
-            $ref: "#/definitions/Skill"
-        "401":
-          $ref: "#/definitions/Unauthorized"
-        "403":
-          $ref: "#/definitions/Forbidden"
-        "404":
-          $ref: "#/definitions/NotFound"
-        "500":
-          $ref: "#/definitions/ServerError"
-      security:
-      - api_key: []
-      x-swagger-router-controller: "Skills"
 securityDefinitions:
   api_key:
     type: "apiKey"
@@ -335,26 +435,6 @@ definitions:
           type: "string"
           description: "The organization id to associate new users with"
     - $ref: "#/definitions/AuditFields"
-  Skill:
-    allOf:
-    - type: "object"
-      properties:
-        skills:
-          type: "array"
-          items:
-            properties:
-              type:
-                type: string
-                description: The skill type
-                example: 'Hard Skill'
-              id:
-                type: string
-                description: The skill id
-                example: 'KS1200364C9C1LK3V5Q1'
-              name:
-                type: string
-                description: The skill name
-                example: 'C (Programming Language)'
   AuditFields:
     type: "object"
     required:

src/controllers/TemplateController.js

@@ -23,7 +23,18 @@ async function getEntity (req, res) {
   res.send(result)
 }
 
+/**
+ * Get template
+ * @param {Object} req the request
+ * @param {Object} res the response
+ */
+async function getEntities (req, res) {
+  const result = await service.getEntities(req.query)
+  res.send(result)
+}
+
 module.exports = {
   uploadEntity,
-  getEntity
+  getEntity,
+  getEntities
 }

src/routes.js

@@ -62,6 +62,13 @@ module.exports = {
       auth: 'jwt',
       access: constants.AdminUser,
       scopes: [constants.Scopes.CreateTemplate, constants.Scopes.AllTemplate]
+    },
+    get: {
+      controller: 'TemplateController',
+      method: 'getEntities',
+      auth: 'jwt',
+      access: constants.AdminUser,
+      scopes: [constants.Scopes.GetTemplate, constants.Scopes.AllTemplate]
     }
   },
   '/templates/:id': {

src/services/TemplateService.js

@@ -57,9 +57,41 @@ uploadEntity.schema = {
   }).required()
 }
 
+/**
+ * Returns all templates (filtered by created date)
+ * @param {Object} query the filter query
+ * @returns {Object} the list of templates
+ */
+async function getEntities (query) {
+  const filter = {}
+  if (!query.from) {
+    query.from = (new Date((new Date()).setDate((new Date()).getDate() - 1)).toISOString()) // 24 hours ago
+  }
+  filter.created = { ge: query.from }
+  if (query.name) {
+    filter.name = { contains: query.name }
+  }
+  const templates = await helper.getAll(config.AMAZON.DYNAMODB_TEMPLATE_TABLE, filter)
+  const res = _.map(templates, (template) => {
+    template = _.extend(
+      _.omit(_.pickBy(template, _.isString), 'objectKey'), { url: helper.generateS3Url(template.objectKey) }
+    )
+    return template
+  })
+  return res
+}
+
+getEntities.schema = {
+  query: Joi.object().keys({
+    from: Joi.string(),
+    name: Joi.string()
+  })
+}
+
 module.exports = {
   getEntity,
-  uploadEntity
+  uploadEntity,
+  getEntities
 }
 
 logger.buildService(module.exports)