Extensions in ApiModelProperty

Hi,

I am using springfox v2.9.2 and I have been able to use extensions on @ApiOperation annotations, but I can’t use them on @ApiModelProperty annotations. Is there something I am missing in this as I can see that the Extensions items are in the Swagger code for ApiModelProperty but they don’t get carried across to the Swagger documentation like they do when they are in the ApiOperation annotation. Below is what I am adding as the extensions.

@ApiModelProperty(name = "preference",
 value = "Specifies the preference.\n" +
     "Default: fastest.", extensions = {
       @Extension(name = "test", properties = {
         @ExtensionProperty(name="test-prop", value="val")
 })
})

Thanks

[drzaiusx11]

I got this working by making a ModelPropertyBuilderPlugin that looks at the annotations:

public void apply(final ModelPropertyContext context) {
	final ModelPropertyBuilder builder = context.getBuilder();

	final Optional<BeanPropertyDefinition> beanPropDef = context.getBeanPropertyDefinition();

	if (!beanPropDef.isPresent()) {
		return;
	}

	final BeanPropertyDefinition beanDef = beanPropDef.get();
	final AnnotatedMethod method = beanDef.getGetter();
	if (method == null) {
		return;
	}

	final ApiModelProperty apiModelProperty = method.getAnnotation(ApiModelProperty.class);
	if (apiModelProperty == null) {
		return;
	}

	List<VendorExtension> vendorExtensions = new ArrayList<>();

	if (apiModelProperty.extensions().length > 0) {
		Extension[] extensionAnnotations = apiModelProperty.extensions();
		for (Extension extensionAnnotation : extensionAnnotations) {
			for (ExtensionProperty prop : extensionAnnotation.properties()) {
				vendorExtensions.add(new StringVendorExtension("x-"+prop.name(), prop.value()));
			}
		}
	}

	builder.extensions(vendorExtensions);
}

[rabidllama]

It’s basically so that we can add extra information to the documentation, such as saying that this property is dependant on another, for example

@ApiModelProperty(name = "preference",
 value = "Specifies the preference.\n" +
     "Default: fastest.", extensions = {
       @Extension(name = "dependencies", properties = {
         @ExtensionProperty(name="vehicle", value="car")
 })
})

which could then be used by a secondary swagger parser to highlight in documentation that providing a preference property is dependent on the vehicle property being set to car, as then the swagger output would be something like:

vehicle:
    type: "string",
    default: "car"
preference:
    type: "string"
    x-dependencies: 
       vehicle: "car"
    

I believe that it was implemented into Swagger here: https://github.com/swagger-api/swagger-core/pull/2424