users swagger def

docs/resources-manager.yml

@@ -1,110 +1,195 @@
 swagger: "2.0"
 info:
-  description: "SimplePAD API"
+  description: "Resources Manager API"
   version: "1.0.0"
   title: "SimplePad API"
-host: "simplepad.localhost"
+host: "localhost"
 basePath: "/api"
 tags:
-- name: "pad"
+- name: "user"
-  description: "CRUD Pads"
+  description: "Operations about user"
 schemes:
 - "https"
 - "http"
 paths:
-  /pad:
+  /user:
     post:
       tags:
-      - "pad"
+      - "user"
-      summary: "Create a new pad"
+      summary: "Create user"
-      description: "Create a new PAD (with a random id)"
+      description: "Need pass an api key to authentificate."
-      consumes:
+      operationId: "createUser"
+      produces:
       - "application/json"
+      parameters:
+      - in: "body"
+        name: "body"
+        description: "Created user object"
+        required: true
+        schema:
+          $ref: "#/definitions/User"
+      - in: header
+        name: X-API-Key
+        type: string
+        required: true
+      responses:
+        default:
+          description: "successful operation"
+  /user/createWithArray:
+    post:
+      tags:
+      - "user"
+      summary: "Creates list of users with given input array"
+      description: ""
+      operationId: "createUsersWithArrayInput"
       produces:
+      - "application/xml"
       - "application/json"
       parameters:
       - in: "body"
         name: "body"
+        description: "List of user object"
         required: true
         schema:
-          $ref: "#/definitions/Pad"
+          type: "array"
+          items:
+            $ref: "#/definitions/User"
+      - in: header
+        name: X-API-Key
+        type: string
+        required: true
       responses:
-        405:
+        default:
-          description: "Invalid input"
+          description: "successful operation"
-        200:
+  /user/createWithList:
-          description: "SuccessFull"
+    post:
-          schema:
+      tags:
-            $ref: "#/definitions/Pad"
+      - "user"
-
+      summary: "Creates list of users with given input array"
-  /pad/{pad_id}:
+      description: ""
+      operationId: "createUsersWithListInput"
+      produces:
+      - "application/xml"
+      - "application/json"
+      parameters:
+      - in: "body"
+        name: "body"
+        description: "List of user object"
+        required: true
+        schema:
+          type: "array"
+          items:
+            $ref: "#/definitions/User"
+      - in: header
+        name: X-API-Key
+        type: string
+        required: true
+      responses:
+        default:
+          description: "successful operation"
+  /user/{username}:
     get:
       tags:
-      - "pad"
+      - "user"
+      summary: "Get user by user name"
+      description: ""
+      operationId: "getUserByName"
       produces:
+      - "application/xml"
       - "application/json"
       parameters:
-      - in: "path"
+      - name: "username"
-        name: "pad_id"
+        in: "path"
+        description: "The name that needs to be fetched."
         required: true
+        type: "string"
+      - in: header
+        name: X-API-Key
         type: string
-        maxLength: 6
+        required: false
-        minLength: 6
       responses:
-        404:
-          description: "Does not exists"
         200:
-          description: "SuccessFull"
+          description: "successful operation"
           schema:
-            $ref: "#/definitions/Pad"
+            $ref: "#/definitions/User"
-    post:
+        400:
+          description: "Invalid username supplied"
+        404:
+          description: "User not found"
+    put:
       tags:
-      - "pad"
+      - "user"
-      description: "Create a new PAD with the given ID"
+      summary: "Updated user"
+      description: "This can only be done by the logged in user."
+      operationId: "updateUser"
       produces:
+      - "application/xml"
       - "application/json"
       parameters:
-      - in: "path"
+      - name: "username"
-        name: "pad_id"
+        in: "path"
+        description: "name that need to be updated"
         required: true
-        type: string
+        type: "string"
-        maxLength: 6
-        minLength: 6
       - in: "body"
         name: "body"
-        description: "content"
+        description: "Updated user object"
         required: true
         schema:
-          $ref: "#/definitions/PadPost"
+          $ref: "#/definitions/User"
+      - in: header
+        name: X-API-Key
+        type: string
+        required: true
       responses:
-        405:
+        400:
-          description: "Invalid input"
+          description: "Invalid user supplied"
-        409:
+        404:
-          description: "Given Id already exists"
+          description: "User not found"
-        200:
+    delete:
-          description: "SuccessFull"
+      tags:
-          schema:
+      - "user"
-            $ref: "#/definitions/Pad"      
+      summary: "Delete user"
-      
+      description: "This can only be done by the logged in user."
+      operationId: "deleteUser"
+      produces:
+      - "application/xml"
+      - "application/json"
+      parameters:
+      - name: "username"
+        in: "path"
+        description: "The name that needs to be deleted"
+        required: true
+        type: "string"
+      - in: header
+        name: X-API-Key
+        type: string
+        required: true
+      responses:
+        400:
+          description: "Invalid username supplied"
+        404:
+          description: "User not found"
 definitions:
-  Pad:
+  User:
     type: "object"
     properties:
       id:
-        type: string
+        type: "integer"
-        maxLength: 6
+        format: "int64"
-        minLength: 6
+      username:
-      content:
+        type: "string"
-        type: string
+      firstName:
-      create_date:
+        type: "string"
-        type: string
+      lastName:
-        format: date
+        type: "string"
-  PadPost:
+      email:
-    type: "object"
+        type: "string"
-    required:
+      password:
-      - content
+        type: "string"
-    properties:
+      phone:
-      content:
+        type: "string"
-        type: string
+      userStatus:
-
+        type: "integer"
-
+        format: "int32"
-
+        description: "User Status"