Module neberus.core
Package net.oneandone.neberus.annotation

Annotation Type ApiUsecaseParam

  • @Target({})
@Retention(SOURCE)
public @interface ApiUsecaseParam
    Parameter used by a REST method in a usecase.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String name
      Name of the parameter.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String value
      Exact value to use.
      java.lang.String valueHint
      Hint about the value to be used.

    • Element Detail

      • name

        java.lang.String name
        Name of the parameter. If the method is linked to an actual REST method, the name must exist in the linked method. Use dot-syntax for nested parameters, e.g. 'myDto.myField'.
        Returns:
        the name

      • value

        java.lang.String value
        Exact value to use. For 'path' and 'query' params this value will be replaced in the shown REST-path and curl.
        Returns:
        the value
        Default:
        ""

      • valueHint

        java.lang.String valueHint
        Hint about the value to be used.
        Returns:
        the value hint
        Default:
        ""