sifter/swagger.yml at main · bmeg/sifter · 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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
swagger: "2.0"
info:
  title: Sifter API
  description: API Load and status API
  version: 1.0.0
basePath: /api
paths:
  /playbook:
    post:
      summary: Starts loading a manifest
      description: Post a manifest to start loading into GRIP
      produces:
        - application/json
      consumes:
        - text/plain
        - application/x-www-form-urlencoded
      parameters:
        - in: body
          name: manifest
          required: true
          schema:
            type: string
      responses:
        200:
          description: OK
    get:
      summary: Get list of playbooks
      produces:
         - application/json
      responses:
        200:
          description: List of playbooks
          schema:
            type: array
            items:
              type: object
              properties:
                name:
                  type: string
                  description: Name of playbook
  /playbook/{id}/{graph}:
    post:
      summary: Post a run request
      parameters:
        - in: path
          name: id
          type: string
          required: True
        - in: path
          name: graph
          type: string
          required: True
        - in: body
          name: params
          schema:
            type: string
      consumes:
        - text/plain
        - application/x-www-form-urlencoded
      responses:
        200:
          description: OK
          schema:
            type: object
            properties:
              id:
                type: string


  /status:
    get:
      summary: Get Loading Status
      responses:
        '200':
          description: Status Data
          schema:
            type: array
            items:
              type: object
              properties:
                playbook:
                  type: string
                  description: Playbook name
                current:
                  type: string
                  description: Current element being loaded
                stepNum:
                  type: integer
                  description: Current Step being loaded
                stepTotal:
                  type: integer
                  description: Total number of steps
                vertexCount:
                  type: integer
                  description: Number of vertices loaded so far
                edgeCount:
                  type: integer
                  description: Number of edges loaded so far