Enunciate Specific Annotations (Version 1)

Note: The following applies to Enunciate version 1.x. For applying a custom skin to Enunciate 2, see Enunciate Specific Annotations

Enunciate-Specific Annotations

This document serves as a reference for the set of Enunciate-specific annotations that can be used to enhance the documentation for your Web service API.

Enhancements to JAX-RS

Annotation	Description
org.codehaus.enunciate.jaxrs.StatusCodes	Applied to a resource class or a resource method. Used to document the set of status codes that may be responses to the operation. The status codes annotated on a method are appended to the status codes annotated on the defining resource class.
org.codehaus.enunciate.jaxrs.Warnings	Applied to a resource class or a resource method. Used to document the set of warning headers that may be included upon invocation of the operation. The warnings annotated on a method are appended to the warnings annotated on the defining resource class.
org.codehaus.enunciate.jaxrs.TypeHint	Applied to a resource method. Some JAX-RS methods may return jakarta.ws.rs.core.Response and so Enunciate can't tell what kind of a response is expected in the response body. The TypeHint annotation is used to give Enunciate a hint about what is to be returned.
org.codehaus.enunciate.jaxrs.ResponseHeaders	Applied to a resource class or a resource method. Used to document the set of response headers that may be included upon invocation of the operation. The response headers annotated on a method are appended to the warnings annotated on the defining resource class.