From e27ee52a4c02d5be93dfc881c52e06089d9afdce Mon Sep 17 00:00:00 2001 From: "anil.ustundag" Date: Wed, 16 Aug 2023 22:41:43 +0300 Subject: [PATCH] Get map of all header values as parameter --- docs/spec-explained/parameters.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/spec-explained/parameters.md b/docs/spec-explained/parameters.md index 3f8d7354..7452c583 100644 --- a/docs/spec-explained/parameters.md +++ b/docs/spec-explained/parameters.md @@ -117,6 +117,22 @@ paths: required: true ``` +Or, you would get all headers within a map as follows: + +``` +paths: + /ping: + get: + summary: Checks if the server is alive. + parameters: + - in: header + name: headers + schema: + type: object + additionalProperties: + type: string +``` + In a similar way, you can define [custom response headers](#header-parameters). **Note:** Swagger specification has special keywords for some headers: