Update API spec

+ to use json as post data
+ new SessionSummary component to return as list

server/swagger.yaml

@@ -1,16 +1,15 @@
----
 openapi: 3.0.0
+servers:
+  - url: /api/v1
 info:
-  title: Session API
   description: Linux Odyssey API
+  version: '1.0.0'
+  title: Session API
   contact:
     email: wancat@wancat.cc
   license:
     name: Apache 2.0
-    url: http://www.apache.org/licenses/LICENSE-2.0.html
+    url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
-  version: 1.0.0
-servers:
-  - url: /api/v1
 tags:
   - name: admins
     description: Secured Admin-only calls
@@ -22,6 +21,14 @@ paths:
       tags:
         - signed-in
       summary: list existing sessions of current user
+      security:
+        - BearerAuth: []
+      parameters:
+        - in: query
+          name: quest_id
+          description: find sessions by quest id
+          schema:
+            type: string
       responses:
         '200':
           description: list of existing session
@@ -30,22 +37,23 @@ paths:
               schema:
                 type: array
                 items:
-                  $ref: '#/components/schemas/Session'
+                  $ref: '#/components/schemas/SessionSummary'
-      security:
+
-        - BearerAuth: []
     post:
+      summary: create a new session for current user
       tags:
         - signed-in
-      summary: create a new session for current user
+      security:
-      parameters:
+        - BearerAuth: []
-        - name: quest_id
+      requestBody:
-          in: body
+        description: session data
-          description: pass the quest id
+        content:
-          required: true
+          application/json:
-          style: form
+            schema:
-          explode: true
+              type: object
-          schema:
+              properties:
-            type: string
+                quest_id:
+                  type: string
       responses:
         '201':
           description: session created
@@ -58,21 +66,23 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/inline_response_400'
+                type: object
-      security:
+                properties:
-        - BearerAuth: []
+                  message:
+                    type: string
+
   /sessions/{session_id}:
     get:
       tags:
         - signed-in
       summary: get a specific session of current user by ID
+      security:
+        - BearerAuth: []
       parameters:
-        - name: session_id
+        - in: path
-          in: path
+          name: session_id
           description: ID of the session to retrieve
           required: true
-          style: simple
-          explode: false
           schema:
             type: string
             format: uuid
@@ -88,169 +98,150 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/inline_response_400'
+                type: object
-      security:
+                properties:
-        - BearerAuth: []
+                  message:
+                    type: string
     delete:
       tags:
         - signed-in
       summary: delete a specific session by ID
+      security:
+        - BearerAuth: []
       parameters:
-        - name: session_id
+        - in: path
-          in: path
+          name: session_id
           required: true
-          style: simple
-          explode: false
           schema:
             type: string
             format: uuid
       responses:
         '204':
           description: Session successfully deleted
+
         '404':
           description: Session not found
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/inline_response_404'
+                type: object
+                properties:
+                  message:
+                    type: string
+                    example: 'Session not found.'
         '401':
           description: Unauthorized
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/inline_response_401'
+                type: object
-      security:
+                properties:
-        - BearerAuth: []
+                  message:
-  /inventory:
+                    type: string
-    get:
+                    example: 'Unauthorized.'
-      tags:
+
-        - developers
-      summary: searches inventory
-      description: |
-        By passing in the appropriate options, you can search for
-        available inventory in the system
-      operationId: searchInventory
-      parameters:
-        - name: searchString
-          in: query
-          description: pass an optional search string for looking up inventory
-          required: false
-          style: form
-          explode: true
-          schema:
-            type: string
-        - name: skip
-          in: query
-          description: number of records to skip for pagination
-          required: false
-          style: form
-          explode: true
-          schema:
-            minimum: 0
-            type: integer
-            format: int32
-        - name: limit
-          in: query
-          description: maximum number of records to return
-          required: false
-          style: form
-          explode: true
-          schema:
-            maximum: 50
-            minimum: 0
-            type: integer
-            format: int32
-      responses:
-        '200':
-          description: search results matching criteria
-          content:
-            application/json:
-              schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/InventoryItem'
-        '400':
-          description: bad input parameter
-    post:
-      tags:
-        - admins
-      summary: adds an inventory item
-      description: Adds an item to the system
-      operationId: addInventory
-      requestBody:
-        description: Inventory item to add
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/InventoryItem'
-      responses:
-        '201':
-          description: item created
-        '400':
-          description: 'invalid input, object invalid'
-        '409':
-          description: an existing item already exists
   /register:
     post:
       summary: Register a new user
       requestBody:
+        required: true
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/register_body'
+              type: object
-        required: true
+              properties:
+                username:
+                  type: string
+                email:
+                  type: string
+                password:
+                  type: string
       responses:
         '201':
           description: User created
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/inline_response_201'
+                type: object
+                properties:
+                  message:
+                    type: string
+                    example: User created successfully
         '400':
           description: Bad Request
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/inline_response_400_1'
+                type: object
+                properties:
+                  message:
+                    type: string
+                    example: Missing username, email or password
         '409':
           description: Conflict
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/inline_response_409'
+                type: object
+                properties:
+                  message:
+                    type: string
+                    example: User already exists
+
   /login:
     post:
       summary: Log in a user
       requestBody:
+        required: true
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/login_body'
+              type: object
-        required: true
+              properties:
+                username:
+                  type: string
+                password:
+                  type: string
       responses:
         '200':
           description: User logged in
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/inline_response_200'
+                type: object
+                properties:
+                  message:
+                    type: string
+                    example: Login successful
+                  token:
+                    type: string
+                    description: Access token
         '400':
           description: Bad Request
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/inline_response_400_2'
+                type: object
+                properties:
+                  message:
+                    type: string
+                    example: Missing username or password
         '401':
           description: Unauthorized
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/inline_response_401_1'
+                type: object
+                properties:
+                  message:
+                    type: string
+                    example: Incorrect username or password
+
   /profile:
-    tags:
-      - signed-in
     get:
       summary: Get the profile of current logged-in user
+      security:
+        - BearerAuth: []
       responses:
         '200':
           description: Get user's profile
@@ -258,8 +249,7 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/User'
-      security:
+
-        - BearerAuth: []
 components:
   schemas:
     User:
@@ -270,7 +260,7 @@ components:
           format: uuid
         username:
           type: string
-          example: alex
+          example: 'alex'
         email:
           type: string
           format: email
@@ -279,20 +269,19 @@ components:
       properties:
         name:
           type: string
-        introduction:
+        description:
           type: string
+
     Session:
       type: object
       properties:
         id:
           type: string
           format: uuid
-        user_id:
+        user:
-          type: string
+          $ref: '#/components/schemas/User'
-          format: uuid
+        quest:
-        quest_id:
+          $ref: '#/components/schemas/Quest'
-          type: string
-          format: uuid
         created_at:
           type: string
           format: date-time
@@ -316,6 +305,25 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/Hint'
+
+    SessionSummary:
+      type: object
+      properties:
+        id:
+          type: string
+          format: uuid
+        quest:
+          $ref: '#/components/schemas/Quest'
+        created_at:
+          type: string
+          format: date-time
+        updated_at:
+          type: string
+          format: date-time
+        finished_at:
+          type: string
+          format: date-time
+
     TreeNode:
       type: object
       properties:
@@ -327,6 +335,7 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/TreeNode'
+
     Progress:
       type: object
       properties:
@@ -338,6 +347,7 @@ components:
         skipped_at:
           type: string
           format: date-time
+
     Hint:
       type: object
       properties:
@@ -347,114 +357,7 @@ components:
           type: string
         source:
           type: string
-    InventoryItem:
+
-      required:
-        - id
-        - manufacturer
-        - name
-        - releaseDate
-      type: object
-      properties:
-        id:
-          type: string
-          format: uuid
-          example: d290f1ee-6c54-4b01-90e6-d701748f0851
-        name:
-          type: string
-          example: Widget Adapter
-        releaseDate:
-          type: string
-          format: date-time
-          example: 2016-08-29T09:12:33.001Z
-        manufacturer:
-          $ref: '#/components/schemas/Manufacturer'
-    Manufacturer:
-      required:
-        - name
-      type: object
-      properties:
-        name:
-          type: string
-          example: ACME Corporation
-        homePage:
-          type: string
-          format: url
-          example: https://www.acme-corp.com
-        phone:
-          type: string
-          example: 408-867-5309
-    inline_response_400:
-      type: object
-      properties:
-        message:
-          type: string
-    inline_response_404:
-      type: object
-      properties:
-        message:
-          type: string
-          example: Session not found.
-    inline_response_401:
-      type: object
-      properties:
-        message:
-          type: string
-          example: Unauthorized.
-    register_body:
-      type: object
-      properties:
-        username:
-          type: string
-        email:
-          type: string
-        password:
-          type: string
-    inline_response_201:
-      type: object
-      properties:
-        message:
-          type: string
-          example: User created successfully
-    inline_response_400_1:
-      type: object
-      properties:
-        message:
-          type: string
-          example: 'Missing username, email or password'
-    inline_response_409:
-      type: object
-      properties:
-        message:
-          type: string
-          example: User already exists
-    login_body:
-      type: object
-      properties:
-        username:
-          type: string
-        password:
-          type: string
-    inline_response_200:
-      type: object
-      properties:
-        message:
-          type: string
-          example: Login successful
-        token:
-          type: string
-          description: Access token
-    inline_response_400_2:
-      type: object
-      properties:
-        message:
-          type: string
-          example: Missing username or password
-    inline_response_401_1:
-      type: object
-      properties:
-        message:
-          type: string
-          example: Incorrect username or password
   securitySchemes:
     BearerAuth:
       type: http