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.

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

refs #3853- fix composed schemas ref with fqn TypeNameResolver #4146

Merged
merged 2 commits into from
Mar 22, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -1428,7 +1428,7 @@ private boolean resolveSubtypes(Schema model, BeanDescription bean, ModelConvert
} else {
composedSchema = (ComposedSchema) subtypeModel;
}
Schema refSchema = new Schema().$ref(model.getName());
Schema refSchema = new Schema().$ref(Components.COMPONENTS_SCHEMAS_REF + model.getName());
// allOf could have already being added during type resolving when @Schema(allOf..) is declared
if (composedSchema.getAllOf() == null || !composedSchema.getAllOf().contains(refSchema)) {
composedSchema.addAllOfItem(refSchema);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
package io.swagger.v3.core.resolving;

import static org.testng.Assert.assertNotNull;

import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.databind.ObjectMapper;
import io.swagger.v3.core.converter.AnnotatedType;
import io.swagger.v3.core.converter.ModelConverterContextImpl;
import io.swagger.v3.core.jackson.ModelResolver;
import io.swagger.v3.core.jackson.TypeNameResolver;
import io.swagger.v3.core.matchers.SerializationMatchers;
import io.swagger.v3.oas.models.media.Schema;
import org.testng.annotations.BeforeTest;
import org.testng.annotations.Test;

public class Ticket3853Test extends SwaggerTestBase {

private ModelResolver modelResolver;
private ModelConverterContextImpl context;

@BeforeTest
public void setup() {
modelResolver = new ModelResolver(new ObjectMapper(), new FqnTypeNameResolver());
context = new ModelConverterContextImpl(modelResolver);
}

@Test
public void testTicket3853() {
final Schema model = context.resolve(new AnnotatedType(BaseClass.class));

assertNotNull(model);
String yaml = "io.swagger.v3.core.resolving.Ticket3853Test$BaseClass:\n" +
" type: object\n" +
" properties:\n" +
" property:\n" +
" type: string\n" +
" type:\n" +
" type: string\n" +
"io.swagger.v3.core.resolving.Ticket3853Test$SubClass:\n" +
" type: object\n" +
" allOf:\n" +
" - $ref: '#/components/schemas/io.swagger.v3.core.resolving.Ticket3853Test$BaseClass'\n" +
" - type: object\n" +
" properties:\n" +
" subClassProperty:\n" +
" type: string";

SerializationMatchers.assertEqualsToYaml(context.getDefinedModels(), yaml);
}

static class SubClass extends BaseClass {
public String subClassProperty;
}

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME)
@JsonSubTypes({
@JsonSubTypes.Type(value = SubClass.class, name = "SubClass"),
@JsonSubTypes.Type(value = BaseClass.class, name = "BaseClass"),
})
static class BaseClass {
public String property;
public String type;
}

static class FqnTypeNameResolver extends TypeNameResolver {

@Override
protected String getNameOfClass(Class<?> cls) {
return cls.getName();
}
}
}