lizard/public/api/v1/openapi.yaml at main · djbender/lizard · 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
100
openapi: 3.1.0
info:
  title: Lizard API
  description: Test run metrics tracking API
  version: 1.0.0

servers:
  - url: /api/v1

paths:
  /api/v1/test_runs:
    post:
      summary: Create a test run
      operationId: createTestRun
      security:
        - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateTestRunRequest"
      responses:
        "200":
          description: Test run created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SuccessResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"

components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

  schemas:
    CreateTestRunRequest:
      type: object
      required:
        - test_run
      properties:
        test_run:
          $ref: "#/components/schemas/TestRunAttributes"

    TestRunAttributes:
      type: object
      properties:
        commit_sha:
          type: string
        branch:
          type: string
        ruby_specs:
          type: integer
        js_specs:
          type: integer
        runtime:
          type: number
        coverage:
          type: number
        ran_at:
          type: string
          format: date-time
        metadata:
          $ref: "#/components/schemas/TestRunMetadata"

    TestRunMetadata:
      type: object
      properties:
        github_run_id:
          type: string
        github_repository:
          type: string
      additionalProperties: false

    SuccessResponse:
      type: object
      required:
        - status
        - id
      properties:
        status:
          type: string
          const: success
        id:
          type: integer

    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string