notes

api/openapi.yaml

@@ -1256,6 +1256,87 @@ paths:
                   $ref: '#/components/schemas/account_entry'
       security:
       - jwt: ['secret']
+  /v1/notes:
+    get:
+      tags: [ "note" ]
+      summary: Return all normalized notes
+      operationId: methods.get_notes
+      responses:
+        '200':
+          description: notes response
+          content:
+            'application/json':
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/note'
+      security:
+      - jwt: ['secret']
+    post:
+      tags: [ "note" ]
+      summary: Insert a note
+      operationId: methods.insert_note
+      requestBody:
+        description: note
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/note'
+      responses:
+        '200':
+          description: note successfully inserted
+          content:
+            'application/json':
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/note'
+      security:
+      - jwt: ['secret']
+  /v1/notes/{noteId}:
+    get:
+      tags: [ "note" ]
+      summary: Return the normalized note with given id
+      operationId: methods.get_note
+      parameters:
+        - name: noteId
+          in: path
+          required: true
+          schema:
+            type: integer
+      responses:
+        '200':
+          description: note response
+          content:
+            'application/json':
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/note'
+      security:
+      - jwt: ['secret']
+  /v1/notes/tenant/{tenantId}:
+    get:
+      tags: [ "note", "tenant" ]
+      summary: Return note by $tenant
+      operationId: methods.get_note_by_tenant
+      parameters:
+        - name: tenantId
+          in: path
+          required: true
+          schema:
+            type: integer
+      responses:
+        '200':
+          description: note response
+          content:
+            'application/json':
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/note'
+      security:
+      - jwt: ['secret']
 
 # -------------------------------------------------------------------
 # ATTENTION: This file will not be parsed by Cheetah
@@ -1511,3 +1592,15 @@ components:
           type: string
         amount:
           type: number
+    note:
+      description: note
+      type: object
+      properties:
+        id:
+          type: integer
+        created_at:
+          type: string
+        tenant:
+          type: integer
+        note:
+          type: string