Interface CtxApiOp

All Known Implementing Classes:
ImmutableCtxApiOp
@Immutable public interface CtxApiOp
Template data for an API operation.

  • Method Details

    • builder

      static ImmutableCtxApiOp.Builder builder()
      Returns a builder for this type.
      Returns:
      a builder for this type

    • returnType

      String returnType()
      Returns the operation return type.
      Returns:
      the operation return type

    • nickname

      String nickname()
      Returns the operation nickname.
      Returns:
      the operation nickname

    • httpMethod

      String httpMethod()
      Returns the operation http method.
      Returns:
      the operation http method

    • path

      Optional<String> path()
      Returns the operation path.
      Returns:
      the operation path

    • summary

      Optional<String> summary()
      Returns the optional operation summary.
      Returns:
      the optional operation summary

    • notes

      Optional<String> notes()
      Returns the optional operation notes.
      Returns:
      the optional operation notes

    • allParams

      List<CtxApiParam> allParams()
      Returns all parameters of the operation.
      Returns:
      all parameters of the operation

    • responses

      List<CtxApiResponse> responses()
      Returns all responses of the operation.
      Returns:
      all responses of the operation

    • madaOp

      CtxApiOpExt madaOp()
      Returns additional custom template data for the operation.
      Returns:
      additional custom template data for the operation