central-api/spec/api.yaml at main · devtron-labs/central-api · 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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
openapi: "3.0.0"
info:
  version: 1.0.0
  title: Devtron Labs
paths:
  /api.devtron.ai/release/notes:
    get:
      description: this api will return all the releases and coresponding notes
      parameters: [ ]
      responses:
        '200':
          description: list response
          content:
            application/json:
              schema:
                properties:
                  code:
                    type: integer
                    description: status code
                  status:
                    type: string
                    description: status
                  result:
                    type: array
                    items:
                      $ref: '#/components/schemas/ReleaseNote'
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /api.devtron.ai/release/notes/release/webhook:
    post:
      description: this api will used for getting events/webhook from github.
      requestBody:
        description: json as request body
        required: true
        content:
          application/json:
            schema:
              properties:
                payload:
                  type: string
                  description: json payload (this may be incorrect)
      responses:
        '200':
          description: app labels edit response
          content:
            application/json:
              schema:
                properties:
                  code:
                    type: integer
                    description: status code
                  status:
                    type: string
                    description: status
                  result:
                    type: boolean
                    description: status

        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

  /api.devtron.ai/modules:
    get:
      description: this api will return all the modules
      parameters: [ ]
      responses:
        '200':
          description: list response
          content:
            application/json:
              schema:
                properties:
                  code:
                    type: integer
                    description: status code
                  status:
                    type: string
                    description: status
                  result:
                    type: array
                    items:
                      $ref: '#/components/schemas/Module'
        default:
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'

# components mentioned below
components:
  schemas:
    ReleaseNote:
      type: object
      required:
        - tagName
        - releaseName
        - createdAt
        - body
        - prerequisite
        - tagLink
        - prerequisiteMessage
      properties:
        tagName:
          type: string
          description: tag name
        releaseName:
          type: string
          description: release name
        body:
          type: string
          description: release note body
        createdAt:
          type: string
          description: release created at
        tagLink:
          type: string
          description: tag link
        prerequisite:
           type: boolean
           description: prerequisite required or not
        prerequisiteMessage:
           type: string
           description: prerequisite message
    Module:
      type: object
      required:
        - id
        - name
      properties:
        id:
          type: integer
          description: module id
        name:
          type: string
          description: module name

    ErrorResponse:
      required:
        - code
        - status
      properties:
        code:
          type: integer
          format: int32
          description: Error code
        status:
          type: string
          description: Error message
        errors:
          type: array
          description: errors
          items:
            $ref: '#/components/schemas/Error'

    Error:
      required:
        - code
        - status
      properties:
        code:
          type: integer
          format: int32
          description: Error internal code
        internalMessage:
          type: string
          description: Error internal message
        userMessage:
          type: string
          description: Error user message