au.org.consumerdatastandards.api.common.models.LinksPaginated 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.api.common.models;

import au.org.consumerdatastandards.support.data.*;

@DataDefinition
@CustomAttributes({
    @CustomAttribute(name = "x-conditional", value = "prev", multiple = true),
    @CustomAttribute(name = "x-conditional", value = "next", multiple = true),
    @CustomAttribute(name = "x-conditional", value = "first", multiple = true),
    @CustomAttribute(name = "x-conditional", value = "last", multiple = true)
})
public class LinksPaginated {

    @Property(
        description = "Fully qualified link that generated the current response document",
        required = true
    )
    @CDSDataType(CustomDataType.URI)
    String self;

    @Property(
        description = "URI to the first page of this set. Mandatory if this response is not the first page"
    )
    @CDSDataType(CustomDataType.URI)
    String first;

    @Property(
        description = "URI to the previous page of this set. Mandatory if this response is not the first page"
    )
    @CDSDataType(CustomDataType.URI)
    String prev;

    @Property(
        description = "URI to the next page of this set. Mandatory if this response is not the last page"
    )
    @CDSDataType(CustomDataType.URI)
    String next;

    @Property(
        description = "URI to the last page of this set. Mandatory if this response is not the last page"
    )
    @CDSDataType(CustomDataType.URI)
    String last;
}