Skip to content

Commit 7ec4dbe

Browse files
authored
Update README.md
better descriptions on parameters
1 parent 4445542 commit 7ec4dbe

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -364,8 +364,8 @@ queryParams:
364364

365365
Path parameters can be described as follow:
366366

367-
* `name`: the name of the query variable
368-
* `description`: a description of the query variable
367+
* `name`: the name of the path parameter
368+
* `description`: a description of the path parameter
369369
* `schema`: JSON schema (inline, file or externally hosted)
370370

371371
```yml
@@ -380,9 +380,9 @@ pathParams:
380380

381381
Cookie parameters can be described as follow:
382382

383-
* `name`: the name of the query variable
384-
* `description`: a description of the query variable
385-
* `required`: whether the query parameter is mandatory (boolean)
383+
* `name`: the name of the cookie parameter
384+
* `description`: a description of the cookie parameter
385+
* `required`: whether the cookie parameter is mandatory (boolean)
386386
* `schema`: JSON schema (inline, file or externally hosted)
387387

388388
```yml
@@ -398,9 +398,9 @@ cookieParams:
398398

399399
Request Headers can be described as follow:
400400

401-
* `name`: the name of the query variable
402-
* `description`: a description of the query variable
403-
* `required`: whether the query parameter is mandatory (boolean)
401+
* `name`: the name of the header
402+
* `description`: a description of the header
403+
* `required`: whether the header is mandatory (boolean)
404404
* `schema`: JSON schema (inline, file or externally hosted)
405405

406406
```yml

0 commit comments

Comments
 (0)