openapi/openapi.sql.yaml at main · vertex-center/openapi · 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
openapi: 3.0.1
info:
    title: Vertex SQL
    description: Create and manage SQL databases.
    version: ""
paths:
    /api/about:
        get:
            summary: Get server info
            operationId: getAbout
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/CommonAbout'
    /api/container/{container_uuid}:
        get:
            tags:
                - Container
            summary: Get an installed DBMS
            operationId: getDBMS
            parameters:
                - name: container_uuid
                  in: path
                  required: true
                  schema:
                    type: string
                    format: uuid
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/TypesDBMS'
    /api/dbms/{dbms}/install:
        post:
            tags:
                - DBMS
            summary: Install a DBMS
            operationId: installDBMS
            parameters:
                - name: dbms
                  in: path
                  required: true
                  schema:
                    type: string
            responses:
                "200":
                    description: OK
                    content:
                        application/json:
                            schema:
                                $ref: '#/components/schemas/TypesContainer'
    /api/ping:
        get:
            summary: Ping the app
            operationId: ping
            responses:
                "204":
                    description: No Content
components:
    schemas:
        CommonAbout:
            type: object
            properties:
                arch:
                    type: string
                    example: amd64
                commit:
                    type: string
                    example: cd4ba2876f45775287f426c13adb1868f7c96222
                date:
                    type: string
                    example: 2006-01-02T15:04:05Z07:00
                os:
                    type: string
                    example: linux
                version:
                    type: string
                    example: 1.2.3
        TypesContainer:
            type: object
            properties:
                color:
                    type: string
                    example: '#336699'
                    nullable: true
                command:
                    type: string
                    example: tunnel run
                    nullable: true
                databases:
                    type: object
                    additionalProperties:
                        type: array
                        items:
                            type: integer
                            format: int32
                        maxItems: 16
                        minItems: 16
                description:
                    type: string
                    example: An SQL database.
                    nullable: true
                icon:
                    type: string
                    example: simpleicons/postgres.svg
                    nullable: true
                id:
                    type: string
                    format: uuid
                image:
                    type: string
                    example: postgres
                image_tag:
                    type: string
                    example: latest
                launch_on_startup:
                    type: boolean
                    example: true
                name:
                    type: string
                    example: Postgres
                status:
                    type: string
                    example: running
                template_id:
                    type: string
                    example: postgres
                    nullable: true
                update:
                    $ref: '#/components/schemas/TypesContainerUpdate'
                user_id:
                    type: string
                    format: uuid
        TypesContainerUpdate:
            type: object
            properties:
                current_version:
                    type: string
                latest_version:
                    type: string
        TypesDB:
            type: object
            properties:
                name:
                    type: string
        TypesDBMS:
            type: object
            properties:
                databases:
                    type: array
                    items:
                        $ref: '#/components/schemas/TypesDB'
                password:
                    type: string
                username:
                    type: string
tags:
    - name: Container
    - name: DBMS