Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#814 added support for descriptions from java interfaces #815

Merged
merged 6 commits into from
Feb 24, 2025
Merged

#814 added support for descriptions from java interfaces #815

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2cd8c2b
#814 added support for descriptions from java interfaces (only for me…
Bramaten Feb 17, 2025
c2209dc
#814 added definition support for inner definitions
Bramaten Feb 19, 2025
e661991
#814 added test for behaviour of adding descriptions and defaults to …
Bramaten Feb 24, 2025
1905424
#814 adjusted tests for descriptions and defaults
Bramaten Feb 24, 2025
c470c26
Merge branch 'refs/heads/master' into 814-json-schema-generator-shoul…
Bramaten Feb 24, 2025
d21435d
#814 merged master into branch and adjusted tests
Bramaten Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 20 additions & 10 deletions ...in/java/com/buschmais/jqassistant/core/runtime/api/configuration/JsonSchemaGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@
import java.io.InputStream;
import java.net.URI;
import java.net.URL;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.*;

import com.buschmais.jqassistant.core.shared.annotation.Description;

import com.fasterxml.classmate.ResolvedType;
import com.fasterxml.jackson.databind.JsonNode;
Expand Down Expand Up @@ -40,20 +39,31 @@ public static ObjectNode generateSchema(Class<?> clazz) {
.without(Option.VOID_METHODS, Option.GETTER_METHODS, Option.PUBLIC_STATIC_FIELDS);

configBuilder.forMethods()
.withTargetTypeOverridesResolver(target -> getResolvedTypes(target, target.getType()));
configBuilder.forMethods()
.withPropertyNameOverrideResolver(member -> mapToKebabCase(member.getName()));
configBuilder.forTypesInGeneral()
.withCustomDefinitionProvider(new MapDefinitionProvider());
configBuilder.forMethods()
.withTargetTypeOverridesResolver(target -> getResolvedTypes(target, target.getType()))
.withPropertyNameOverrideResolver(member -> mapToKebabCase(member.getName()))
.withDefaultResolver(method -> {
WithDefault annotation = method.getAnnotationConsideringFieldAndGetter(WithDefault.class);
if (annotation != null) {
return annotation.value();
}
return null;
})
.withDescriptionResolver(method -> {
Description annotation = method.getAnnotationConsideringFieldAndGetter(Description.class);
if (annotation != null) {
return annotation.value();
}
if (method.getType() != null) {
Description innerAnnotation = method.getType().getErasedType().getAnnotation(Description.class);
if (innerAnnotation != null) {
return innerAnnotation.value();
}
}
return null;
});

configBuilder.forTypesInGeneral()
.withCustomDefinitionProvider(new MapDefinitionProvider())
.withDefinitionNamingStrategy((definitionKey, context) -> mapToKebabCase(definitionKey.getType()
.getTypeName()));

Expand Down
Loading