Skip to content

Commit

Permalink
Enum values should be valid to their schema (#212)
Browse files Browse the repository at this point in the history
  • Loading branch information
pvdbosch authored Nov 27, 2024
1 parent df44483 commit b0fa638
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions guide/src/main/asciidoc/api_specifications.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,8 @@ A fixed list of possible values of a property can be specified using `enum`.
However, this may make it harder to change the list of possible values, as client applications will often depend on the specified list e.g. by using code generation.
`enum` SHOULD only be used when the list of values is unlikely to change or when changing it has a big impact on clients of the API.
`enum` values SHOULD be valid to the schema in which they are defined.
====

.Enum declaration
Expand Down

0 comments on commit b0fa638

Please sign in to comment.