V2

api/dash_api.yaml

@@ -164,6 +164,99 @@ paths:
         type: string
         format: date
         example: 2022-02-18
+  
+  /tracking/entry:
+    post:
+      operationId: writeTrackingEntry
+      tags:
+        - tracking
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/TrackingEntry'
+      responses:
+        '200':
+          description: Tracking entry successfully written.
+
+  /tracking/entry/{date}:
+    get:
+      operationId: getTrackingEntryForDate
+      tags:
+        - tracking
+      responses:
+        '200':
+          description: A tracking entry for a specific date.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/TrackingEntry'
+    parameters:
+    - name: date
+      in: path
+      required: true
+      schema:
+        type: string
+        format: date
+        example: 2022-02-18
+  
+  /tracking/categories:
+    get:
+      operationId: getTrackingCategories
+      tags:
+        - tracking
+      responses:
+        '200':
+          description: Tracking categories successfully retrieved.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/TrackingCategories'
+
+  /inbox/:
+    get:
+      operationId: getInboxItems
+      tags:
+        - inbox
+      responses:
+        '200':
+          description: Inbox items successfully retrieved.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/InboxItem'
+    post:
+      operationId: addInboxItem
+      tags:
+        - inbox
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/InboxItem'
+      responses:
+        '200':
+          description: Journal entry successfully written.
+  /inbox/{item}:
+    delete:
+      operationId: deleteInboxItem
+      tags:
+        - inbox
+      responses:
+        '200':
+          description: Inbox item successfully deleted.
+      parameters:
+      - name: item
+        in: path
+        required: true
+        schema:
+          type: integer
+          format: int32
+          example: 1
 
 components:
   schemas:
@@ -293,7 +386,7 @@ components:
         item:
           type: string
           example: 'planWeekItem'
-        numTodos:
+        numTodo:
           type: integer
           format: int32
           example: 3
@@ -315,4 +408,78 @@ components:
           type: array
           items:
             type: string
-          example: '["mitem1", "mitem2", "mitem3"]'
+          example: '["mitem1", "mitem2", "mitem3"]'
+    
+    TrackingItem:
+      type: object
+      required:
+        - date
+        - type
+        - value
+      properties:
+        date:
+          type: string
+          format: date
+          example: 2022-02-18
+        type:
+          type: string
+          example: 'trackingItem'
+        value:
+          type: string
+          example: 'trackingItemValue'
+    
+    TrackingEntry:
+      type: object
+      required:
+        - date
+        - items
+      properties:
+        date:
+          type: string
+          format: date
+          example: 2022-02-18
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/TrackingItem'
+          example: '[{"type": "titem1", "value": "titem1value"}, {"type": "titem2", "value": "titem2value"}]'
+    
+    TrackingCategory:
+      type: object
+      required:
+        - type
+        - name
+      properties:
+        type:
+          type: string
+          example: 'trackingCategory'
+        name:
+          type: string
+          example: 'trackingCategoryName'
+        items:
+          type: array
+          items:
+            type: string
+          example: '["titem1", "titem2", "titem3"]'
+
+    TrackingCategories:
+      type: object
+      properties:
+        categories:
+          type: array
+          items:
+            $ref: '#/components/schemas/TrackingCategory'
+          example: '[{"type": "tcat1", "name": "tcat1name", "items": ["titem1", "titem2", "titem3"]}, {"type": "tcat2", "name": "tcat2name", "items": ["titem1", "titem2", "titem3"]}]'
+    
+    InboxItem:
+      type: object
+      required:
+        - item
+      properties:
+        id:
+          type: integer
+          format: int32
+          example: 1
+        item:
+          type: string
+          example: 'inboxItem'