Method Detail

• java.lang.Class openAPIDefinition()

  To populate OpenAPI Object fields info, tags, servers, security and externalDocs.

  See Also:

  io.swagger.v3.oas.annotations.OpenAPIDefinition

  Default:

  }

• java.lang.Class operation()

  open api document closure of action.

  See Also:

  io.swagger.v3.oas.annotations.Operation

  Default:

  }

• java.lang.Class securityScheme()

  document closure for security.

  See Also:

  io.swagger.v3.oas.annotations.security.SecurityScheme

  Default:

  }

• java.lang.Class tag()

  The annotation may be applied at class or method level, or in io.swagger.v3.oas.annotations.Operation#tags() to define tags for the single operation (when applied at method level) or for all operations of a class (when applied at class level).

  It can also be used in io.swagger.v3.oas.annotations.OpenAPIDefinition#tags() to define spec level tags.

  When applied at method or class level, if only a name is provided, the tag will be added to operation only; if additional fields are also defined, like description or externalDocs, the Tag will also be added to openAPI.tags field

  reference: Tag (OpenAPI specification)

  See Also:

  io.swagger.v3.oas.annotations.tags.Tag

  Default:

  }

• java.lang.String value()

  place-holder for any place that need a string content. Used in Command object field description annotation.

  Default:

  ""