Skip to content

Commit 4ed3db7

Browse files
yunkon-kimyunkon-kim
committed
Tidy up pkgs and API docs
1 parent 7010939 commit 4ed3db7

File tree

11 files changed

+148
-728
lines changed

11 files changed

+148
-728
lines changed

‎api/docs.go

Lines changed: 0 additions & 198 deletions
Original file line numberDiff line numberDiff line change
@@ -190,167 +190,6 @@ const docTemplate = `{
190190
}
191191
}
192192
},
193-
"/ns": {
194-
"get": {
195-
"description": "List all namespaces or namespaces' ID",
196-
"consumes": [
197-
"application/json"
198-
],
199-
"produces": [
200-
"application/json"
201-
],
202-
"tags": [
203-
"[Namespace] Namespace management (To be used)"
204-
],
205-
"summary": "List all namespaces or namespaces' ID",
206-
"responses": {
207-
"200": {
208-
"description": "Different return structures by the given option param",
209-
"schema": {
210-
"$ref": "#/definitions/common.RestGetAllNsResponse"
211-
}
212-
},
213-
"404": {
214-
"description": "Not Found",
215-
"schema": {
216-
"$ref": "#/definitions/github_com_cloud-barista_cm-beetle_pkg_core_common.SimpleMsg"
217-
}
218-
},
219-
"500": {
220-
"description": "Internal Server Error",
221-
"schema": {
222-
"$ref": "#/definitions/github_com_cloud-barista_cm-beetle_pkg_core_common.SimpleMsg"
223-
}
224-
}
225-
}
226-
},
227-
"post": {
228-
"description": "Create namespace",
229-
"consumes": [
230-
"application/json"
231-
],
232-
"produces": [
233-
"application/json"
234-
],
235-
"tags": [
236-
"[Namespace] Namespace management (To be used)"
237-
],
238-
"summary": "Create namespace",
239-
"parameters": [
240-
{
241-
"description": "Details for a new namespace",
242-
"name": "nsReq",
243-
"in": "body",
244-
"required": true,
245-
"schema": {
246-
"$ref": "#/definitions/github_com_cloud-barista_cm-beetle_pkg_core_common.NsReq"
247-
}
248-
}
249-
],
250-
"responses": {
251-
"200": {
252-
"description": "OK",
253-
"schema": {
254-
"$ref": "#/definitions/github_com_cloud-barista_cm-beetle_pkg_core_common.NsInfo"
255-
}
256-
},
257-
"404": {
258-
"description": "Not Found",
259-
"schema": {
260-
"$ref": "#/definitions/github_com_cloud-barista_cm-beetle_pkg_core_common.SimpleMsg"
261-
}
262-
},
263-
"500": {
264-
"description": "Internal Server Error",
265-
"schema": {
266-
"$ref": "#/definitions/github_com_cloud-barista_cm-beetle_pkg_core_common.SimpleMsg"
267-
}
268-
}
269-
}
270-
}
271-
},
272-
"/ns/{nsId}": {
273-
"get": {
274-
"description": "Get namespace",
275-
"consumes": [
276-
"application/json"
277-
],
278-
"produces": [
279-
"application/json"
280-
],
281-
"tags": [
282-
"[Namespace] Namespace management (To be used)"
283-
],
284-
"summary": "Get namespace",
285-
"parameters": [
286-
{
287-
"type": "string",
288-
"default": "ns01",
289-
"description": "Namespace ID",
290-
"name": "nsId",
291-
"in": "path",
292-
"required": true
293-
}
294-
],
295-
"responses": {
296-
"200": {
297-
"description": "Namespace information",
298-
"schema": {
299-
"$ref": "#/definitions/github_com_cloud-barista_cm-beetle_pkg_core_common.NsInfo"
300-
}
301-
},
302-
"404": {
303-
"description": "Not Found",
304-
"schema": {
305-
"$ref": "#/definitions/github_com_cloud-barista_cm-beetle_pkg_core_common.SimpleMsg"
306-
}
307-
},
308-
"500": {
309-
"description": "Internal Server Error",
310-
"schema": {
311-
"$ref": "#/definitions/github_com_cloud-barista_cm-beetle_pkg_core_common.SimpleMsg"
312-
}
313-
}
314-
}
315-
},
316-
"delete": {
317-
"description": "Delete namespace",
318-
"consumes": [
319-
"application/json"
320-
],
321-
"produces": [
322-
"application/json"
323-
],
324-
"tags": [
325-
"[Namespace] Namespace management (To be used)"
326-
],
327-
"summary": "Delete namespace",
328-
"parameters": [
329-
{
330-
"type": "string",
331-
"default": "ns01",
332-
"description": "Namespace ID",
333-
"name": "nsId",
334-
"in": "path",
335-
"required": true
336-
}
337-
],
338-
"responses": {
339-
"200": {
340-
"description": "OK",
341-
"schema": {
342-
"$ref": "#/definitions/github_com_cloud-barista_cm-beetle_pkg_core_common.SimpleMsg"
343-
}
344-
},
345-
"404": {
346-
"description": "Not Found",
347-
"schema": {
348-
"$ref": "#/definitions/github_com_cloud-barista_cm-beetle_pkg_core_common.SimpleMsg"
349-
}
350-
}
351-
}
352-
}
353-
},
354193
"/readyz": {
355194
"get": {
356195
"description": "Check Beetle is ready",
@@ -671,18 +510,6 @@ const docTemplate = `{
671510
}
672511
},
673512
"definitions": {
674-
"common.RestGetAllNsResponse": {
675-
"type": "object",
676-
"properties": {
677-
"ns": {
678-
"description": "Name string ` + "`" + `json:\"name\"` + "`" + `",
679-
"type": "array",
680-
"items": {
681-
"$ref": "#/definitions/github_com_cloud-barista_cm-beetle_pkg_core_common.NsInfo"
682-
}
683-
}
684-
}
685-
},
686513
"common.SimpleMessage": {
687514
"type": "object",
688515
"properties": {
@@ -930,31 +757,6 @@ const docTemplate = `{
930757
}
931758
}
932759
},
933-
"github_com_cloud-barista_cm-beetle_pkg_core_common.NsInfo": {
934-
"type": "object",
935-
"properties": {
936-
"description": {
937-
"type": "string"
938-
},
939-
"id": {
940-
"type": "string"
941-
},
942-
"name": {
943-
"type": "string"
944-
}
945-
}
946-
},
947-
"github_com_cloud-barista_cm-beetle_pkg_core_common.NsReq": {
948-
"type": "object",
949-
"properties": {
950-
"description": {
951-
"type": "string"
952-
},
953-
"name": {
954-
"type": "string"
955-
}
956-
}
957-
},
958760
"github_com_cloud-barista_cm-beetle_pkg_core_common.SimpleMsg": {
959761
"type": "object",
960762
"properties": {

0 commit comments

Comments
 (0)