Annotation Type 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
      java.lang.String title  
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String description  
      int successStatus  
    • Element Detail

      • title

        java.lang.String title
      • description

        java.lang.String description
        Default:
        ""
      • successStatus

        int successStatus
        Default:
        -1