Annotation Type Operation

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean deprecated
      Allows an operation to be marked as deprecated.
      java.lang.String description
      A verbose description of the operation behaviour.
      boolean hidden
      Allows this operation to be marked as hidden
      java.lang.String operationId
      Unique string used to identify the operation.
      java.lang.String summary
      Provides a brief description of what this operation does.
    • Element Detail

      • summary

        java.lang.String summary
        Provides a brief description of what this operation does.
        Returns:
        a summary of this operation
        Default:
        ""
      • description

        java.lang.String description
        A verbose description of the operation behaviour. CommonMark syntax MAY be used for rich text representation.
        Returns:
        a description of this operation
        Default:
        ""
      • operationId

        java.lang.String operationId
        Unique string used to identify the operation. The id MUST be unique among all operations described in the API.

        Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.

        Returns:
        the ID of this operation
        Default:
        ""
      • deprecated

        boolean deprecated
        Allows an operation to be marked as deprecated. Alternatively use the @Deprecated annotation.

        Consumers SHOULD refrain from usage of a deprecated operation.

        Returns:
        whether or not this operation is deprecated
        Default:
        false
      • hidden

        boolean hidden
        Allows this operation to be marked as hidden
        Returns:
        whether or not this operation is hidden
        Default:
        false