gui/openapi.yaml at main · multigit-com/gui · 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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
openapi: 3.0.0
info:
  title: GitHub Repository Manager API
  version: 1.0.0
  description: API for managing GitHub repositories and organizations

servers:
  - url: http://localhost:3001
    description: Local development server

paths:
  /api/organizations:
    get:
      summary: List organizations
      description: Retrieve a list of GitHub organizations
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  organizations:
                    type: array
                    items:
                      $ref: '#/components/schemas/Organization'
        '500':
          description: Server error

  /api/repositories:
    get:
      summary: List repositories
      description: Retrieve a list of repositories for a given organization
      parameters:
        - in: query
          name: org
          required: true
          schema:
            type: string
          description: The organization name
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Repository'
        '400':
          description: Bad request
        '500':
          description: Server error

  /api/repository-files:
    get:
      summary: List repository files
      description: Retrieve a list of files in a repository
      parameters:
        - in: query
          name: org
          required: true
          schema:
            type: string
          description: The organization name
        - in: query
          name: repo
          required: true
          schema:
            type: string
          description: The repository name
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  files:
                    type: array
                    items:
                      $ref: '#/components/schemas/File'
        '400':
          description: Bad request
        '500':
          description: Server error

  /api/readme:
    get:
      summary: Get README content
      description: Retrieve the README content of a repository
      parameters:
        - in: query
          name: org
          required: true
          schema:
            type: string
          description: The organization name
        - in: query
          name: repo
          required: true
          schema:
            type: string
          description: The repository name
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  content:
                    type: string
        '400':
          description: Bad request
        '500':
          description: Server error

  /api/move-repository:
    post:
      summary: Move repository
      description: Move a repository from one organization to another
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                repoId:
                  type: string
                repoName:
                  type: string
                sourceOrgId:
                  type: string
                targetOrgId:
                  type: string
              required:
                - repoId
                - repoName
                - sourceOrgId
                - targetOrgId
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '500':
          description: Server error

  /api/remove-repository:
    post:
      summary: Remove repository
      description: Remove a repository from GitHub
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                repoUrl:
                  type: string
                sourceOrgId:
                  type: string
              required:
                - repoUrl
                - sourceOrgId
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '500':
          description: Server error

  /api/rename-organization:
    post:
      summary: Rename organization
      description: Rename a GitHub organization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                orgId:
                  type: string
                newName:
                  type: string
              required:
                - orgId
                - newName
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '500':
          description: Server error

  /api/rename-repository:
    post:
      summary: Rename repository
      description: Rename a GitHub repository
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                orgName:
                  type: string
                oldName:
                  type: string
                newName:
                  type: string
              required:
                - orgName
                - oldName
                - newName
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request
        '500':
          description: Server error

  /api/repo:
    get:
      summary: Get current repository
      description: Get the current repository information
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  org:
                    type: string
                  repo:
                    type: string
    post:
      summary: Set current repository
      description: Set the current repository information
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                org:
                  type: string
                repo:
                  type: string
              required:
                - org
                - repo
      responses:
        '200':
          description: Successful response
        '400':
          description: Bad request

components:
  schemas:
    Organization:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        login:
          type: string
        public_repos:
          type: integer
        private_repos:
          type: integer
        forked_repos:
          type: integer
        total_repos:
          type: integer

    Repository:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
        full_name:
          type: string
        html_url:
          type: string
        description:
          type: string

    File:
      type: object
      properties:
        path:
          type: string
        size:
          type: integer
        type:
          type: string