Annotation Type Parameters.PathDescription


  • @Retention(RUNTIME)
    @Target(FIELD)
    public static @interface Parameters.PathDescription
    This annotation defines readable descriptions for paths.
    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String aliasFieldName  
      boolean includeAuthority  
    • Element Detail

      • aliasFieldName

        java.lang.String aliasFieldName
        Returns:
        the field name that is the alias. If the alias exists, this description is skipped
        Default:
        ""
      • includeAuthority

        boolean includeAuthority
        Returns:
        true if the authority should be included in the path description
        Default:
        true