x-logo vendor extension

• [Latest] What version of the library are you using? Is it the latest version? The latest released version is

What kind of issue is this?

• Question. Is this a question about how to do a certain thing?

• [x Feature Request. Start by telling us what problem you’re trying to solve. Often a solution already exists! Don’t send pull requests to implement new features without first getting our support. Sometimes we leave features out on purpose to keep the project small.

I’m trying to show custom logo in ReDoc API documentation by adding ObjectVendorExtension("x-logo") with required properties to the info section.

Expected result is:

"x-logo": {
...
}

However, the actual result is:

"extensions": {
   "x-logo": {
      ....
   }
}

How can I exclude “extensions”? Is there any workaround for this because now it is of course at variance with documentation of ReDoc?

Thank you for such a great API documentation tool.

[jamesbarnett91]

I’m also hitting this issue. I’ve implemented an OperationBuilderPlugin to add custom ObjectVendorExtensions and the value gets wrapped in an extensions object.

e.g. the following

@Order(SwaggerPluginSupport.SWAGGER_PLUGIN_ORDER)
public class TestOperationBuilderPlugin implements OperationBuilderPlugin {
  
  @Override
  public void apply(OperationContext context) {
      var extension = new ObjectVendorExtension("x-test");
      context.operationBuilder().extensions(List.of(extension));
  }

  @Override
  public boolean supports(DocumentationType delimiter) {
    return SwaggerPluginSupport.pluginDoesApply(delimiter);
  }
}

produces

"extensions": {
   "x-test": {}
}

The same issue also occurs when using the the @Extension param of the @ApiOperation annotation (and probably the other applicable annotations). e.g

@ApiOperation(value = "test", extensions = {
  @Extension(properties = @ExtensionProperty(name="x-test", value="test"))
})

produces

"extensions": {
   "x-test": "test"
}

This does seem to be a bug. Consumers expect the extension properties to be directly under the parent to which they apply. Not wrapped in an extensions object. e.g https://swagger.io/specification/#specification-extensions

It looks like this only affects the OpenAPI v3 document type. The Swagger v2 type generates correctly.

I have not been able to find a workaround for OpenAPI v3 (short of post-processing the json after generation).

Thanks for looking into it. 👍

[chendongyao]

I added a JacksonModuleRegistrar to solve this problem, such as public class MyOpenApiJacksonModule extends SimpleModule implements JacksonModuleRegistrar { … @Override public void setupModule(SetupContext context) { super.setupModule(context); … context.setMixInAnnotations(Operation.class, OperationMixin.class); …

}

private interface OperationMixin {
	@JsonAnyGetter
	java.util.Map<String, Object> getExtensions();
}

}