add identifer attribute to licence

eclipse · May 15, 2024 · 9e6909b · 9e6909b
1 parent 632268f
commit 9e6909b
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/License.java b/api/src/main/java/org/eclipse/microprofile/openapi/annotations/info/License.java
@@ -40,6 +40,13 @@
      **/
     String name();
 
+    /**
+     * The license identifier used for the API.
+     *
+     * @return the identifier of the license
+     **/
+    String identifier() default "";
+
     /**
      * A URL to the license used for the API. MUST be in the format of a URL.
      *

diff --git a/api/src/main/java/org/eclipse/microprofile/openapi/models/info/License.java b/api/src/main/java/org/eclipse/microprofile/openapi/models/info/License.java
@@ -54,6 +54,33 @@ default License name(String name) {
         return this;
     }
 
+    /**
+     * Returns the license identifier for this License instance that is used for the API.
+     *
+     * @return the license identifier used for the API
+     **/
+    String getIdentifier();
+
+    /**
+     * Sets the license identifier for this License instance that is used for the API.
+     *
+     * @param identifier
+     *            the license identifier used for the API
+     */
+    void setIdentifier(String identifier);
+
+    /**
+     * Sets this License instance's identifier used for the API and returns this instance of License.
+     *
+     * @param identifier
+     *            the license identifier used for the API
+     * @return this License instance
+     */
+    default License identifier(String identifier) {
+        setIdentifier(identifier);
+        return this;
+    }
+
     /**
      * Returns the URL for this License instance that is used for the API.
      *