dk.mada.jaxrs.generator.mpclient.api.tmpl.CtxApiOp Maven / Gradle / Ivy

Go to download
package dk.mada.jaxrs.generator.mpclient.api.tmpl;

import java.util.List;
import java.util.Optional;

import org.immutables.value.Value.Immutable;

/**
 * Template data for an API operation.
 */
@Immutable
public interface CtxApiOp {
    /** {@return a builder for this type} */
    static ImmutableCtxApiOp.Builder builder() {
        return ImmutableCtxApiOp.builder();
    }

    /** {@return the operation return type} */
    String returnType();

    /** {@return the operation nickname} */
    String nickname();

    /** {@return the operation http method} */
    String httpMethod();

    /** {@return the operation path} */
    Optional path();

    /** {@return the optional operation summary} */
    Optional summary();

    /** {@return the optional operation notes} */
    Optional notes();

    /** {@return all parameters of the operation} */
    List allParams();

    /** {@return all responses of the operation} */
    List responses();

    /** {@return additional custom template data for the operation} */
    CtxApiOpExt madaOp();
}