GH-217 Support all utility OpenApi annotations on field (Resolves #217)

Author: dzikoysk

build.gradle.kts

@@ -5,7 +5,7 @@ plugins {
     kotlin("jvm") version "1.9.22"
     `maven-publish`
     signing
-    id("io.github.gradle-nexus.publish-plugin") version "1.3.0"
+    id("io.github.gradle-nexus.publish-plugin") version "2.0.0"
 }
 
 description = "Javalin OpenAPI Parent | Parent"
@@ -134,6 +134,8 @@ subprojects {
 nexusPublishing {
     repositories {
         sonatype {
+            nexusUrl.set(uri("https://ossrh-staging-api.central.sonatype.com/service/local/"))
+            snapshotRepositoryUrl.set(uri("https://central.sonatype.com/repository/maven-snapshots/"))
             username.set(getEnvOrProperty("SONATYPE_USER", "sonatypeUser"))
             password.set(getEnvOrProperty("SONATYPE_PASSWORD", "sonatypePassword"))
         }

examples/javalin-gradle-kotlin/src/main/java/io/javalin/openapi/plugin/test/JavalinTest.java

@@ -443,9 +443,22 @@ public String getProperty() {
 
     // should work with properties generated by another annotation processor
     @Data
+    @OpenApiByFields(Visibility.PRIVATE)
     static final class LombokEntity {
-
+        @OpenApiExample("example")
+        @OpenApiDescription("description")
+        @OpenApiPropertyType(definedBy = Integer.class)
+        @OpenApiRequired
+        @OpenApiName("customPropertyName")
+        @OpenApiStringValidation(
+            minLength = "2",
+            maxLength = "10",
+            pattern = "^[a-zA-Z]+$"
+        )
         private String property;
+
+        @OpenApiIgnore
+        public String test;
     }
 
     // should pick upper/lower bound type for generics

openapi-specification/src/main/kotlin/io/javalin/openapi/OpenApiAnnotations.kt

@@ -212,21 +212,21 @@ annotation class OpenApiSecurity(
     val scopes: Array<String> = []
 )
 
-@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER)
+@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, FIELD)
 @Retention(RUNTIME)
 annotation class OpenApiIgnore
 
-@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER)
+@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, FIELD)
 @Retention(RUNTIME)
 annotation class OpenApiRequired
 
-@Target(CLASS, FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER)
+@Target(CLASS, FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, FIELD)
 @Retention(RUNTIME)
 annotation class OpenApiName(
     val value: String
 )
 
-@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER)
+@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, FIELD)
 @Retention(RUNTIME)
 annotation class OpenApiExample(
     val value: String = NULL_STRING,
@@ -241,14 +241,14 @@ annotation class OpenApiExampleProperty(
     val objects: Array<OpenApiExampleProperty> = []
 )
 
-@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER)
+@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, FIELD)
 @Retention(RUNTIME)
 @CustomAnnotation
 annotation class OpenApiNullable(
     val nullable: Boolean = true
 )
 
-@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, CLASS)
+@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, CLASS, FIELD)
 @Retention(RUNTIME)
 annotation class OpenApiDescription(
     val value: String
@@ -260,7 +260,7 @@ enum class Nullability {
     AUTO
 }
 
-@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER)
+@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, FIELD)
 @Retention(RUNTIME)
 annotation class OpenApiNumberValidation(
     val minimum: String = NULL_STRING,
@@ -270,7 +270,7 @@ annotation class OpenApiNumberValidation(
     val multipleOf: String = NULL_STRING
 )
 
-@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER)
+@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, FIELD)
 @Retention(RUNTIME)
 annotation class OpenApiStringValidation(
     val minLength: String = NULL_STRING,
@@ -279,22 +279,22 @@ annotation class OpenApiStringValidation(
     val pattern: String = NULL_STRING
 )
 
-@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER)
+@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, FIELD)
 @Retention(RUNTIME)
 annotation class OpenApiArrayValidation(
     val minItems: String = NULL_STRING,
     val maxItems: String = NULL_STRING,
     val uniqueItems: Boolean = false
 )
 
-@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER)
+@Target(FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, FIELD)
 @Retention(RUNTIME)
 annotation class OpenApiObjectValidation(
     val minProperties: String = NULL_STRING,
     val maxProperties: String = NULL_STRING,
 )
 
-@Target(CLASS, FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER)
+@Target(CLASS, FUNCTION, PROPERTY_GETTER, PROPERTY_SETTER, FIELD)
 @Retention(RUNTIME)
 annotation class OpenApiPropertyType(
     val definedBy: KClass<*>,