com.getperka.flatpack.client.dto.package.json Maven / Gradle / Ivy
{
"com.getperka.flatpack.client.dto.ParameterDescription": "Describes a path or query parameter in {@link com.getperka.flatpack.client.dto.EndpointDescription EndpointDescription}.",
"com.getperka.flatpack.client.dto.EntityDescription": "A description of an entity type.",
"com.getperka.flatpack.client.dto.EntityDescription:isPersistent()": "Indicates that instance of the the type may be persisted by the server. This hint can be used\n to reduce payload sizes by transmitting only mutated properties.",
"com.getperka.flatpack.client.dto.EndpointDescription": "Describes an HTTP request endpoint.",
"com.getperka.flatpack.client.dto.EndpointDescription:getEntity()": "The expected entity type for the request. Generally, the HTTP POST body.",
"com.getperka.flatpack.client.dto.EndpointDescription:getMethod()": "The HTTP method used to access the endpoint.",
"com.getperka.flatpack.client.dto.EndpointDescription:getPath()": "The path used to access the endpoint.",
"com.getperka.flatpack.client.dto.EndpointDescription:getPathParameters()": "Describes any parameters embedded in {@link com.getperka.flatpack.client.dto.EndpointDescription:getPath() #getPath()}.",
"com.getperka.flatpack.client.dto.EndpointDescription:getQueryParameters()": "Describes any query parameters for the endpoint.",
"com.getperka.flatpack.client.dto.EndpointDescription:getReturnType()": "The expected contents for the HTTP response.",
"com.getperka.flatpack.client.dto.EndpointDescription:getRoleNames()": "Return the role names that are allowed to access the endpoint. A null value means that\n all roles are allowed, while a zero-length value means that no roles are allowed.",
"com.getperka.flatpack.client.dto.ApiDescription": "A description of the entities contained within an API."
}