doc: example header parameter (#114)

This commit is contained in:
Ryan Brink
2021-11-25 18:16:35 -05:00
committed by GitHub
parent 5e070e1875
commit d66880f9b2
9 changed files with 128 additions and 1 deletions

View File

@ -109,6 +109,14 @@ of camel).
The purpose of `KompendiumParam` is to provide supplemental information needed to properly assign the type of parameter
(cookie, header, query, path) as well as other parameter-level metadata.
Using backticks, users can use data classes to represent things like header names as follows
```kotlin
data class HeaderNameTest(
@KompendiumParam(type = ParamType.HEADER) val `X-UserEmail`: String
)
```
### Undeclared Field
There is also a final `UndeclaredField` annotation. This should be used only in an absolutely emergency. This annotation