naijun0403/kompendium
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

Default param values (#47)

Browse Source
This commit is contained in:
Ryan Brink
2021-05-05 21:33:17 -04:00
committed by GitHub
parent 938a604285
commit f23016e878
42 changed files with 679 additions and 490 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -79,15 +79,12 @@ integrated.
Currently, the annotations used by Kompendium are as follows
- `KompendiumField`
- `PathParam`
- `QueryParam`
- `HeaderParam`
- `CookieParam`
- `KompendiumParam`
The intended purpose of `KompendiumField` is to offer field level overrides such as naming conventions (ie snake instead of camel).
The 4 "param" annotations are to offer supplemental information in data classes that describe the set of parameters types
that a notarized route needs to analyze.
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.
## Examples