Skip to content

Commit

Permalink
Add missing description field to operation params
Browse files Browse the repository at this point in the history
Parameter descriptions provide good insight on specificities of what values are expected for each parameter
  • Loading branch information
andresanches committed May 2, 2019
1 parent 311d704 commit a992199
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/book.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,13 @@ paths: # All HTTP paths are direct children
# parameter name.

in: path # Where to look for the parameter

description: The ID of the user # The optional `description` parameter is not used in guardrail,
# but is useful for providing a detailed explanation on what is
# expected as a value for the parameter. For example:
# `description: User IDs are strings comprised of the concatenation
# of the two upper-case letters ID and a UUID stripped of any dashes
# i.e. ID4d9b1c54e4664c9d92aba94151a7f59f`

required: true # Required fields cannot be missing. `required: false` fields are
# represented as `Option[T]`
Expand Down

0 comments on commit a992199

Please sign in to comment.