Skip to content
This repository was archived by the owner on Jun 11, 2022. It is now read-only.

Commit cfd4f08

Browse files
authored
Update README.md
1 parent fe23fc0 commit cfd4f08

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

README.md

+12-11
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Tested on **H2Database** v1.4.196.
2727
username=*login for your database*
2828
password=*password for your database*
2929
```
30+
3031
* Run application with the following parameters:
3132
* `-port [1024..49151]` - port number that will be used by server
3233
* `-dbProps path` - **relative** path to _.properties_ file
@@ -96,7 +97,7 @@ All of the routes mentioned above provide:
9697
9798
#### Route-specific parameters
9899
99-
##### /actor
100+
##### /actors
100101
101102
* firstName
102103
@@ -107,7 +108,7 @@ All of the routes mentioned above provide:
107108
/actors?lastName=Williams...
108109
109110
110-
##### /film
111+
##### /films
111112
112113
You can mix title and language with both minLength and maxLength.
113114
@@ -127,45 +128,45 @@ You can mix title and language with both minLength and maxLength.
127128
128129
/films?language=mandarin&maxLength=99...
129130
130-
##### /language
131+
##### /languages
131132
132133
* name
133134
134-
/language?name=english...
135+
/languages?name=english...
135136
136137
## Admin routes
137138
138139
Non-public (accessible only to application's admins) part of the API has 2 routes:
139-
* **/user** - provides access to users data
140+
* **/users** - provides access to users data
140141
* **/admin** - provides access to mechanisms of user management
141142
142143
Operations on these routes don't subtract from your usage limit.
143144
144145
### GET Parameters
145146
146-
##### /user
147+
##### /users
147148
148149
* as well as in public API, you can order and paginate the results as well as get multiple results
149150
by listing many ids
150151
151-
/user?page=1&perPage=5&order=asc
152+
/users?page=1&perPage=5&order=asc
152153
153154
* filter
154155
* all (returns all users)
155156
156-
/user?filter=all...
157+
/users?filter=all...
157158
158159
* admin (filters by role)
159160
160-
/user?filter=admin...
161+
/users?filter=admin...
161162
162163
* user (filters by role)
163164
164-
/user?filter=user...
165+
/users?filter=user...
165166
166167
* noaccess (returns users that have exhausted their usage limit)
167168
168-
/user?filter=noaccess...
169+
/users?filter=noaccess...
169170
170171
171172
##### /admin

0 commit comments

Comments
 (0)