description (string)

The @ApiOperation notes attribute. The notes attribute has some limited support for GFM syntax, for example, ** for bolding and ~~ for strikethrough. You can use the notes attribute to describe anything about the endpoint’s behavior that is not obvious from the value attribute and the endpoint’s input parameters.

operationId (string)

The endpoint’s Java method name, which can be overridden by the @ApiOperation nickname attribute.

parameter (array of objects)

A parameter array is added for each parameter in the method signature. Refer to the Using Endpoint Parameters section for further information.

responses (map keyed by response status codes)

Every endpoint must contain at least one response entry. Refer to the Using Endpoint Responses for further information.

summary (string)

The @ApiOperation value attribute. Can be up to 120 characters.

tags (array of strings)

The @APIOperation tags attribute or, if there are no @APIOperation tags, resource tags and ancestor resource tags.

description (string)

The @ApiParam value attribute.

enum (string)

The @ApiParam allowableValues attribute. Supply allowableValues for any non-body parameter that accepts a specific set of values.

in (body, path, query)

Uses path if @PathParam is present or query if @QueryParam is present or formData if @FormParam is present. Otherwise uses body. Note that there are additional choices for the in property, however they are not used.

name (string)

Uses body for in body, the @PathParam value for in path, or the @QueryParam value for in query or @FormParam value for in formData. It is overridden by the @ApiParam name attribute.

required (true, false)

The @ApiParam required attribute, which defaults to false.

schema (string)

The @APIOperation value attribute. This string can contain up to 120 characters. This property is required when using in body.