Skip to content

Commit 4445542

Browse files
authored
Update README.md
Add more documentation around headers
1 parent 276a6cc commit 4445542

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,7 @@ The `documentation` section of the event configuration can contain the following
271271
* `queryParams`: a list of query parameters (see [queryParams](#queryparams) below)
272272
* `pathParams`: a list of path parameters (see [pathParams](#pathparams) below)
273273
* `cookieParams`: a list of cookie parameters (see [cookieParams](#cookieparams) below)
274+
* `headerParams`: a list of headers (see [headerParams](#headerparams---request-headers) below)
274275
* `methodResponses`: an array of response models and applicable status codes
275276
* `statusCode`: applicable http status code (ie. 200/404/500 etc.)
276277
* `responseBody`: contains description of the response
@@ -318,12 +319,22 @@ functions:
318319
description: "A Session ID variable"
319320
schema:
320321
type: "string"
322+
headerParams:
323+
name: "Content-Type"
324+
description: "The content type"
325+
schema:
326+
type: "string"
321327
methodResponses:
322328
- statusCode: 201
323329
responseBody:
324330
description: "A user object along with generated API Keys"
325331
responseModels:
326332
application/json: "PutDocumentResponse"
333+
responseHeaders:
334+
X-Rate-Limit-Limit:
335+
description: The number of allowed requests in the current period
336+
schema:
337+
type: integer
327338
- statusCode: 500
328339
responseBody:
329340
description: "An error message when creating a new user"

0 commit comments

Comments
 (0)