-
Notifications
You must be signed in to change notification settings - Fork 1
/
docs-bundle.zzb
58 lines (50 loc) · 1.74 KB
/
docs-bundle.zzb
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
# yaml-language-server: $schema=../schemas/zzapi-bundle.schema.json
common:
baseUrl: https://example.com
requests:
Login:
method: POST
url: /login
body:
userId: 123456
password: secret
verify: false
response:
status: OK
responseData:
authToken: DNsity!k8HGyeY
permissions: [ read: true, write: true, admin: false ]
capture:
$.responseData.authToken: authToken
doc: |-
# Purpose:
To provide the login credentials and retrive the authToken which can be used
in further API calls.
# Request Notes:
* userId and password are mandatory. A 422 status will be returned if either of
them are missing.
* If verify is specified and true, additional checks will be performed.
# Response Notes:
* The returned authToken must be used in the header X-Authorized-Token for
all subsequent calls.
* Permissions may be used to enable/disable UI elements.
Employee Details:
method: GET
url: /employeedetails
headers:
- { name: X-Authorized-Token, value: $authToken, doc: Use the value returned from /login request }
params:
- { name: employeeId, value: "34567", doc: Required. Identifies the employee }
- name: state
value: Madhya%20Pradesh
doc: Optional. If specified, will restrict the details to that state's information.
options:
rawParams: true
response: <employee_resp.json
doc: |-
# Purpose:
To get the details of the employee record.
# Response Notes:
* Depending on the user's permission, certail fields in the record may be
anonymysed, and others may be hidden. Admins will have access to all details
of the employee.