fix(core): do no set header example value when none is specified (#1468)

Author: timonback

springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/annotation/AsyncAnnotationUtil.java

@@ -69,8 +69,10 @@ public static SchemaObject getAsyncHeaders(AsyncOperation op, StringValueResolve
  property.setTitle(propertyName);
  property.setDescription(getDescription(headersValues, stringValueResolver));
  List<String> values = getHeaderValues(headersValues, stringValueResolver);
- property.setExamples(new ArrayList<>(values));
- property.setEnumValues(values);
+ if (!values.isEmpty()) {
+ property.setExamples(new ArrayList<>(values));
+ property.setEnumValues(values);
+ }
  headerSchema.getProperties().put(propertyName, property);
  });
 

springwolf-core/src/test/java/io/github/springwolf/core/asyncapi/scanners/common/annotation/AsyncAnnotationUtilTest.java

@@ -30,6 +30,7 @@
 import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.Mockito.mock;
@@ -68,8 +69,8 @@ void getAsyncHeaders(Class<?> classWithOperationBindingProcessor) throws NoSuchM
  SchemaObject headerWithoutValueResolved =
  (SchemaObject) headers.getProperties().get("headerWithoutValueResolved");
  assertEquals("string", headerWithoutValueResolved.getType());
- assertTrue(headerWithoutValueResolved.getExamples().isEmpty());
- assertTrue(headerWithoutValueResolved.getEnumValues().isEmpty());
+ assertNull(headerWithoutValueResolved.getExamples());
+ assertNull(headerWithoutValueResolved.getEnumValues());
  assertEquals("descriptionResolved", headerWithoutValueResolved.getDescription());
  }
 
@@ -120,6 +121,36 @@ void getAsyncHeadersWithoutSchemaName() throws NoSuchMethodException {
  .build());
  }
 
+ @Test
+ void getAsyncHeadersWithoutValue() throws NoSuchMethodException {
+ // given
+ Method m = ClassWithHeaders.class.getDeclaredMethod("withoutValue", String.class);
+ AsyncOperation operation = m.getAnnotation(AsyncListener.class).operation();
+
+ StringValueResolver stringValueResolver = mock(StringValueResolver.class);
+ when(stringValueResolver.resolveStringValue(any()))
+ .thenAnswer(invocation -> invocation.getArgument(0).toString() + "Resolved");
+
+ // when
+ SchemaObject headers = AsyncAnnotationUtil.getAsyncHeaders(operation, stringValueResolver);
+
+ // then
+ assertThat(headers)
+ .isEqualTo(SchemaObject.builder()
+ .type(SchemaType.OBJECT)
+ .title("Headers-472917891")
+ .properties(Map.of(
+ "headerResolved",
+ SchemaObject.builder()
+ .type(SchemaType.STRING)
+ .title("headerResolved")
+ .description("descriptionResolved")
+ .enumValues(null)
+ .examples(null)
+ .build()))
+ .build());
+ }
+
  @Test
  void generatedHeaderSchemaNameShouldBeUnique() throws NoSuchMethodException {
  // given
@@ -424,6 +455,20 @@ private void emptyHeaders(String payload) {}
  @TestOperationBindingProcessor.TestOperationBinding()
  private void withoutSchemaName(String payload) {}
 
+ @AsyncListener(
+ operation =
+ @AsyncOperation(
+ channelName = "${test.property.test-channel}",
+ headers =
+ @AsyncOperation.Headers(
+ values = {
+ @AsyncOperation.Headers.Header(
+ name = "header",
+ description = "description")
+ })))
+ @TestOperationBindingProcessor.TestOperationBinding()
+ private void withoutValue(String payload) {}
+
  @AsyncListener(
  operation =
  @AsyncOperation(