au.org.consumerdatastandards.support.Endpoint Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api-model Show documentation

This artefact describes the Consumer Data Standards using Java classes and annotations in a way suitable for automatic generation of Open API Specification, documentation, Server Stub, Client Libraries and Reference Test.

There is a newer version: 1.1.1

Show newest version

package au.org.consumerdatastandards.support;

import au.org.consumerdatastandards.support.security.EndpointAuth;

import java.lang.annotation.*;

@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Endpoint {

    String summary();

    String description();

    RequestMethod requestMethod();

    String path();

    EndpointResponse[] responses();

    EndpointAuth[] requiredAuth() default {};

    String operationId();
}