kcgi-framework/swagger.in.json at master · kristapsdz/kcgi-framework · 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
{
	"swagger": "2.0",
	"info": {
		"title": "yourprog",
		"description": "a sample prog",
		"license": {
			"name": "ISC license",
			"url": "https://opensource.org/licenses/ISC"
		},
		"contact": {
			"name": "yourname",
			"email": "you@localhost"
		},
		"version": "@VERSION@"
	},
	"paths": {
		"/logout.json": {
			"get": {
				"description": "De-authenticate user session",
				"parameters": [
					{
						"name": "sessid",
						"in": "cookie",
						"description": "Session identifier",
						"type": "integer",
						"format": "int64",
						"required": true
					},
					{
						"name": "sesstok",
						"in": "cookie",
						"description": "Session token",
						"type": "integer",
						"format": "int64",
						"required": true
					}
				],
				"produces": [ "application/json" ],
				"responses": {
					"403": {
						"description": "User not logged in or bad session",
						"schema": { "$ref": "#/definitions/empty" }
					},
					"200": {
						"description": "User has been deauthenticated",
						"schema": { "$ref": "#/definitions/empty" }
					}
				}
			}
		},
		"/login.json": {
			"post": {
				"description": "Create an authenticated user session",
				"parameters": [
					{
						"name": "email",
						"in": "query",
						"description": "User identifier (e-mail)",
						"type": "string",
						"required": true
					},
					{
						"name": "password",
						"in": "query",
						"description": "User password",
						"type": "password",
						"required": true
					}
				],
				"produces": [ "application/json" ],
				"responses": {
					"400": {
						"description": "User not found (or disabled) or bad password",
						"schema": { "$ref": "#/definitions/empty" }
					},
					"200": {
						"description": "User was logged in",
						"schema": { "$ref": "#/definitions/empty" },
						"headers": {
							"Set-Cookie": {
								"description": "Key-value pairs for the authentication identifier and token",
								"type": "string"
							}
						}
					}
				}
			}
		},
		"/index.json": {
			"get": {
				"description": "Logged-in user information",
				"parameters": [
					{
						"name": "sessid",
						"in": "cookie",
						"description": "Session identifier",
						"type": "integer",
						"format": "int64",
						"required": false
					},
					{
						"name": "sesstok",
						"in": "cookie",
						"description": "Session token",
						"type": "integer",
						"format": "int64",
						"required": false
					}
				],
				"produces": [ "application/json" ],
				"responses": {
					"403": {
						"description": "Session invalid or user disabled",
						"schema": { "$ref": "#/definitions/empty" }
					},
					"200": {
						"description": "User information",
						"schema": { "$ref": "#/definitions/user" }
					}
				}
			}
		}
	},
	"definitions": {
		"empty": {
			"description": "An empty JSON document",
			"type": "object",
			"properties": { }
		},
		"user": {
			"description": "A user",
			"type": "object",
			"properties": {
				"email": {
					"description": "Public e-mail address (and system identifier)",
					"type": "string"
				},
				"id": {
					"description": "Unique numeric identifier",
					"type": "integer",
					"format": "int64"

				}
			},
			"required": ["email", "id"]
		}
	}
}