flowchase.github.io/openapi.yaml at main · flowchase/flowchase.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
openapi: 3.0.3
info:
  version: 1.0.0
  title: Flowchase API
  description: >
    Flowchase API, a RESTful API for the Flowchase performance tool
  termsOfService: "https://www.flowchase.app/terms"
  license:
    name: proprietary software
    url: "https://www.flowchase.app/license"
  x-logo:
    url: "https://storage.googleapis.com/flwc-app-media/flowchaseapilogo.png"
paths:
  $ref: src/domains/performance-tool/router.yaml#/router

components:
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: x-api-key
  schemas:
    feedback:
      type: object
      description: The feedback object
      properties:
        word:
          type: string
        wordIndex:
          type: number
        wordPriority:
          type: number
        feedbackPriorities:
          type: object
          properties:
            total:
              type: number
        feedbackPriority:
          type: number
        status:
          type: string
          enum: [success, failure]
        feedback:
          type: array
          items:
            $ref: "#/components/schemas/feedbackCard"
        ipa:
          type: string
        start:
          type: number
        end:
          type: number

    feedbackCard:
      type: object
      description: The feedback card object
      properties:
        order:
          type: number
        type:
          type: string
        status:
          type: string
          enum: [success, failure]
        aspect:
          type: string
        message:
          type: string
        image:
          type: string
        priority:
          type: number
        metadata:
          type: object

security:
  - api_key: []
servers:
  - url: "https://api-staging.flowchase.app"