-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathapiary.apib
157 lines (84 loc) · 2.37 KB
/
apiary.apib
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
FORMAT: 1A
HOST: https://private-b77a0-fallballconnector.apiary-mock.com
# FallBall Connector
FallBall Connector implements the APS Lite connector API for FallBall sample application
## Top level [/]
### Health Check [GET /]
+ Response 200 (application/json)
{
"status": "ok"
}
## Application [/app]
### Partner creates new application instance [POST /app]
+ Response 200 (application/json)
{
}
### Partner deinstall application [DELETE /app/{id}]
+ Response 200 (application/json)
{
}
### Partner upgrades application [POST /app/{id}/upgrade]
+ Response 200 (application/json)
{
}
### Application subscriptions populated [POST /app/{app}/tenants]
+ Response 200 (application/json)
{
}
### Subscription removed from application collection [DELETE /app/{app}/tenants/{id}]
+ Response 200 (application/json)
{
}
## Tenant [/tenant]
Resources related to subscription API
### Create a new subscription [POST /tenant]
+ Response 200 (application/json)
{
}
### Get application resource usage [GET /tenant/{id}]
+ Response 200 (application/json)
{
}
### Update application resource limits [PUT /tenant/{id}]
+ Response 200 (application/json)
{
}
### Delete subscription [DELETE /tenant/{id}]
+ Response 200 (application/json)
{
}
### Suspend subscription [PUT /tenant/{id}/disable]
+ Response 200 (application/json)
{
}
### Resume subscription [PUT /tenant/{id}/enable]
+ Response 200 (application/json)
{
}
### Login to application [GET /tenant/{id}/adminlogin]
+ Response 200 (text/plain)
http://www.odin.com
### New user notification [POST /tenant/{id}/users]
+ Response 200 (application/json)
{
}
### User removed notification [DELETE /tenant/{id}/users/{user_id}]
+ Response 200 (application/json)
{
}
## User [/user]
### Create new user [POST /user]
+ Response 200 (application/json)
{
}
### Remove user [DELETE /user/{id}]
+ Response 200 (application/json)
{
}
### Update user [PUT /user/{id}]
+ Response 200 (application/json)
{
}
### Log user in [GET /user/{id}/login]
+ Response 200 (text/plain)
http://www.odin.com