Package com.onenetwork.platform.integ.rest.annotation

REST annotations, used primarily for documentation purposes when running the "rest-doc" target in ant.
  • Annotation Types Summary 
    Annotation Type Description
    RestEnumeration
    Used to document all enumerations used by the REST APIs of a module.
    RestException
    Any exception thrown by a REST API which includes this annotation will set the supplied errorCode and message as properties on a JSON in the HTTP 500 response.
    RestFooter
    Used to append documentation at the end of the generated HTML REST documentation.
    RestObjectProperty
    Used to document request or response body properties, i.e.
    RestParam
    Used to document QueryParam, PathParam or FormParam.
    Cannot be used alone.
    RestRequest
    Used to describe the Request Body for REST resources which accept input using the entire body without specifically indexed parameter names.
    RestResponse
    Used to describe the Response Body for a REST resource.