document requirement that default server variable must be in the enum…

…eration if it is set
microprofile · May 14, 2024 · 4d7e51d · 4d7e51d
1 parent 632268f
commit 4d7e51d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/ServerVariable.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/servers/ServerVariable.java
@@ -52,8 +52,10 @@
 
     /**
      * The default value of this server variable. This is a REQUIRED property.
+     * <p>
+     * If {@code enumeration} is set the default value MUST be one of the values in {@code enumeration}.
      *
-     * @return the defualt value of this server variable
+     * @return the default value of this server variable
      **/
     String defaultValue();
 

diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/servers/ServerVariable.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/servers/ServerVariable.java
@@ -105,6 +105,8 @@ default ServerVariable enumeration(List<String> enumeration) {
      * The default value to use for substitution, and to send, if an alternate value is not supplied. This value MUST be
      * provided by the consumer and is REQUIRED.
      * <p>
+     * If {@code enumeration} is set the default value MUST be one of the values in {@code enumeration}.
+     * <p>
      * This method sets the defaultValue property of ServerVariable instance to the given defaultValue argument.
      * </p>
      *
@@ -117,6 +119,8 @@ default ServerVariable enumeration(List<String> enumeration) {
      * The default value to use for substitution, and to send, if an alternate value is not supplied. This value MUST be
      * provided by the consumer and is REQUIRED.
      * <p>
+     * If {@code enumeration} is set the default value MUST be one of the values in {@code enumeration}.
+     * <p>
      * This method sets the defaultValue property of ServerVariable instance to the given defaultValue argument and
      * returns the modified instance.
      * </p>