This repository was archived by the owner on Oct 3, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocumentation.apib
More file actions
60 lines (36 loc) · 2.18 KB
/
documentation.apib
File metadata and controls
60 lines (36 loc) · 2.18 KB
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
FORMAT: 1A
HOST: https://strv-addressbook-pazdernik.ew.r.appspot.com
# STRV Test project
STRV test project bringing address book with basic elements of authentication and contact storing in Firebase. Application is being hosted on Google Cloud Platform.
# Group Authentication
### Sign-up [POST /api/v1/auth/signup]
+ Request (application/json)
+ Attributes
+ `email`: `email@example.com` (string, required)
+ `password`: `hVvhrnGP` (string, required)
+ Response 201
+ Body
{
"accessToken": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVmMGNkNTZhMzVmMWQ4M2I3NTI0NGZjNiIsImVtYWlsIjoicGF2ZWxAZGlydHltaW5kcy5nZyIsIm5hbWUiOiJQYXZlbCIsInN1cm5hbWUiOiJQYXpkZXJuw61rIiwicm9sZSI6ImFkbWluIiwiaWF0IjoxNjAzMzAwMDQyLCJleHAiOjE2MDMzMDE4NDJ9.o7VRIsHt4AY3krQYBxDxDmdvwl6t7jawHE0JwWPIrQdoJSOpc9Q7FqLdZZlf78cIqOJ0-C2r8lGK7odFsMZffg"
}
### Sign-in [POST /api/v1/auth/signin]
+ Request (application/json)
+ Attributes
+ `email`: `email@example.com` (string, required)
+ `password`: `hVvhrnGP` (string, required)
+ Response 200
+ Body
{
"accessToken": "eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVmMGNkNTZhMzVmMWQ4M2I3NTI0NGZjNiIsImVtYWlsIjoicGF2ZWxAZGlydHltaW5kcy5nZyIsIm5hbWUiOiJQYXZlbCIsInN1cm5hbWUiOiJQYXpkZXJuw61rIiwicm9sZSI6ImFkbWluIiwiaWF0IjoxNjAzMzAwMDQyLCJleHAiOjE2MDMzMDE4NDJ9.o7VRIsHt4AY3krQYBxDxDmdvwl6t7jawHE0JwWPIrQdoJSOpc9Q7FqLdZZlf78cIqOJ0-C2r8lGK7odFsMZffg"
}
# Group Contact
### Create [POST /api/v1/contact]
+ Request (application/json)
+ Headers
Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVmMGNkNTZhMzVmMWQ4M2I3NTI0NGZjNiIsImVtYWlsIjoicGF2ZWxAZGlydHltaW5kcy5nZyIsIm5hbWUiOiJQYXZlbCIsInN1cm5hbWUiOiJQYXpkZXJuw61rIiwicm9sZSI6ImFkbWluIiwiaWF0IjoxNjAzMzAwMDQyLCJleHAiOjE2MDMzMDE4NDJ9.o7VRIsHt4AY3krQYBxDxDmdvwl6t7jawHE0JwWPIrQdoJSOpc9Q7FqLdZZlf78cIqOJ0-C2r8lGK7odFsMZffg
+ Attributes
+ `firstName`: `Bruce` (string, required)
+ `lastName`: `Wayne` (string, required)
+ `phoneNumber`: `202-555-0042` (string, required)
+ `address`: `1007 Mountain Drive, Gotham` (string, required)
+ Response 201