Package org.alfresco.rest.framework

Annotation Interface WebApiDescription

@Target(METHOD) @Retention(RUNTIME) public @interface WebApiDescription
Used to describe a resource method operation in the Rest API
Author:
Gethin James

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    title
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
     
    int
    successStatus
     

  • Element Details

    • description

      String description
      Default:
      ""

    • successStatus

      int successStatus
      Default:
      -1