backend-api/api-swagger.json at master · uberCad/backend-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
{
	"swagger": "2.0",
	"basePath": "/_db/cad/api",
	"paths": {
		"/docs/*": {
			"get": {
				"produces": [
					"application/json"
				],
				"parameters": [],
				"tags": [],
				"consumes": [],
				"responses": {
					"500": {
						"description": "Default error response.",
						"schema": {
							"type": "object",
							"properties": {
								"error": {
									"enum": [
										true
									],
									"type": [
										"array",
										"boolean",
										"number",
										"object",
										"string",
										"null"
									]
								},
								"errorNum": {
									"type": "integer"
								},
								"errorMessage": {
									"type": "string"
								},
								"code": {
									"type": "integer"
								}
							},
							"additionalProperties": false,
							"required": [
								"error"
							]
						}
					}
				}
			}
		},
		"/project/{key}": {
			"get": {
				"produces": [
					"application/json"
				],
				"parameters": [
					{
						"required": true,
						"description": "Key of the project.",
						"type": "string",
						"name": "key",
						"in": "path"
					}
				],
				"description": "Retrieves an project from the \"projects\" collection by key.",
				"summary": "Retrieve an project by key",
				"tags": [],
				"consumes": [],
				"responses": {
					"200": {
						"schema": {
							"type": "object",
							"properties": {},
							"additionalProperties": false
						},
						"description": "Project stored in the collection \"projects\"."
					},
					"500": {
						"description": "Default error response.",
						"schema": {
							"type": "object",
							"properties": {
								"error": {
									"enum": [
										true
									],
									"type": [
										"array",
										"boolean",
										"number",
										"object",
										"string",
										"null"
									]
								},
								"errorNum": {
									"type": "integer"
								},
								"errorMessage": {
									"type": "string"
								},
								"code": {
									"type": "integer"
								}
							},
							"additionalProperties": false,
							"required": [
								"error"
							]
						}
					}
				}
			}
		}
	},
	"info": {
		"description": "",
		"license": {}
	}
}