init

api/gerald.yaml

@@ -0,0 +1,79 @@
+swagger: '2.0'
+info:
+  description: "gerald - feedback application server"
+  version: 0.0.1
+  title: gerald
+
+basePath: /
+consumes:
+  - application/json
+produces:
+  - application/json
+
+paths:
+  /feedback:
+    post:
+      summary: "Create a feedback"
+      tags:
+        - "feedback"
+      description: "Create a feedback"
+      operationId: "createFeedback"
+      parameters:
+        - in: body
+          name: body
+          description: "Feedback object that needs to be created"
+          required: true
+          schema:
+            $ref: "#/definitions/Feedback"
+        - in: query
+          name: session_id
+          description: "Session ID"
+          required: true
+          type: string
+      responses:
+        200:
+          description: "successful operation"
+        403:
+          description: "Forbidden"
+
+  /feedbacks:
+    get:
+      summary: "Get all feedbacks"
+      tags:
+          - "feedback"
+      description: "Get all feedbacks"
+      operationId: "getFeedbacks"
+      parameters:
+        - in: query
+          name: session_id
+          description: "Session ID"
+          required: true
+          type: string
+      responses:
+        200:
+          description: "successful operation"
+          schema:
+            type: array
+            items:
+              $ref: "#/definitions/Feedback"
+        403:
+          description: "Forbidden"
+
+definitions:
+  Feedback:
+    type: object
+    properties:
+      user_id:
+        type: string
+        description: to have more context about the user
+      project_id:
+        type: string
+        description: to have more context about the project
+      type:
+        type: string
+        enum:
+          - feature_request
+          - feedback
+          - support
+      text:
+        type: string