Skip to content
This repository was archived by the owner on Oct 20, 2023. It is now read-only.

Commit 4702c96

Browse files
committed
Readme tweaks
1 parent c6048da commit 4702c96

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -172,13 +172,13 @@ The configuration object in Detail:
172172
* You need to add at least one url object.
173173
* `urls.params`
174174
* Optional
175-
* In this example a valid URL might be:
176-
`http://localhost:8081/api/articles/foo/bar/baz`
177-
whereas:
178-
`http://localhost:8081/api/articles` will return a 404 error.
175+
* URL path parameters with fixed and/or variable path segments.
176+
* Example:
177+
* `params: '/update/{id}'`
179178
* See hapi docs. For example regarding optional [path parameters](http://hapijs.com/api#path-parameters).
180179
* `urls.requests`
181180
* You need to add at least one request object.
181+
* Multiple request objects are needed in case you like to serve different responses via different HTTP methods with the same URL.
182182
* `urls.requests.method`
183183
* optional. Uses `GET` when not defined.
184184
* `string`, or `array` of strings.
@@ -196,7 +196,7 @@ The configuration object in Detail:
196196
* a status code with a predefined error object provided by [boom](https://github.com/hapijs/boom) if you dont provide a response property for that request.
197197
* `statusCode`
198198
* Optional
199-
* Every route of this endpoint will return a HTTP error with the given status code provided by [boom](https://github.com/hapijs/boom).
199+
* Every subroute of this endpoint will return a HTTP error with the given status code provided by [boom](https://github.com/hapijs/boom).
200200

201201
## Configuration
202202

0 commit comments

Comments
 (0)