A B C D E F G H I J L N P R S T U W
All Classes All Packages

A

addAttribute(String, Property) - Method in class com.yahoo.elide.swagger.model.Resource

addRelationship(String, Property) - Method in class com.yahoo.elide.swagger.model.Resource

allClasses - Variable in class com.yahoo.elide.swagger.SwaggerBuilder

B

build() - Method in class com.yahoo.elide.swagger.SwaggerBuilder

Builds a swagger object.

C

com.yahoo.elide.swagger - package com.yahoo.elide.swagger

com.yahoo.elide.swagger.model - package com.yahoo.elide.swagger.model

com.yahoo.elide.swagger.property - package com.yahoo.elide.swagger.property

com.yahoo.elide.swagger.resources - package com.yahoo.elide.swagger.resources

D

Data - Class in com.yahoo.elide.swagger.model

Represents a JSON-API collection of resources or resource identifiers.

Data - Class in com.yahoo.elide.swagger.property

Represents a JSON-API collection of resources or resource identifiers.

Data(Relationship) - Constructor for class com.yahoo.elide.swagger.model.Data

Used to construct a collection of resource identifiers.

Data(Relationship) - Constructor for class com.yahoo.elide.swagger.property.Data

Used to construct a collection of resource identifiers.

Data(String) - Constructor for class com.yahoo.elide.swagger.model.Data

Data(String) - Constructor for class com.yahoo.elide.swagger.property.Data

Used to construct a collection of resources (referenced by the resource type).

Data(String, boolean) - Constructor for class com.yahoo.elide.swagger.property.Data

Used to construct a collection of resources (referenced by the resource type).

Datum - Class in com.yahoo.elide.swagger.model

Represents a JSON-API singular resource or resource identifier.

Datum - Class in com.yahoo.elide.swagger.property

Represents a JSON-API single resource or resource identifier.

Datum(Relationship) - Constructor for class com.yahoo.elide.swagger.model.Datum

Constructs a singular resource identifier.

Datum(Relationship) - Constructor for class com.yahoo.elide.swagger.property.Datum

Constructs a singular resource identifier.

Datum(String) - Constructor for class com.yahoo.elide.swagger.model.Datum

Datum(String) - Constructor for class com.yahoo.elide.swagger.property.Datum

Constructs a singular resource (referenced by type).

Datum(String, boolean) - Constructor for class com.yahoo.elide.swagger.property.Datum

Constructs a singular resource (referenced by type).

dictionary - Variable in class com.yahoo.elide.swagger.SwaggerBuilder

DocEndpoint - Class in com.yahoo.elide.swagger.resources

A convenience endpoint to expose a swagger document.

DocEndpoint(List<DocEndpoint.SwaggerRegistration>) - Constructor for class com.yahoo.elide.swagger.resources.DocEndpoint

Constructs the resource.

DocEndpoint.SwaggerRegistration - Class in com.yahoo.elide.swagger.resources

documents - Variable in class com.yahoo.elide.swagger.resources.DocEndpoint

E

equals(Object) - Method in class com.yahoo.elide.swagger.SwaggerBuilder.PathMetaData

F

filterOperators - Variable in class com.yahoo.elide.swagger.SwaggerBuilder

find(Type<?>) - Method in class com.yahoo.elide.swagger.SwaggerBuilder

Finds all the paths by navigating the entity relationship graph - starting at the given root entity.

FORBIDDEN_RESPONSE - Static variable in class com.yahoo.elide.swagger.SwaggerBuilder

G

get(String, String) - Method in class com.yahoo.elide.swagger.resources.DocEndpoint

Read handler.

getClassPermissions(Type<?>) - Method in class com.yahoo.elide.swagger.JsonApiModelResolver

Get the class-level permission annotation value.

getCollectionPath() - Method in class com.yahoo.elide.swagger.SwaggerBuilder.PathMetaData

Returns the Swagger Path for a collection URL.

getCollectionUrl() - Method in class com.yahoo.elide.swagger.SwaggerBuilder.PathMetaData

Returns a URL that represents the collection.

getCreatePermission(Type<?>) - Method in class com.yahoo.elide.swagger.JsonApiModelResolver

Get the calculated CreatePermission value for the field.

getDeletePermission(Type<?>) - Method in class com.yahoo.elide.swagger.JsonApiModelResolver

Get the calculated DeletePermission value for the field.

getDocument(Swagger) - Static method in class com.yahoo.elide.swagger.SwaggerBuilder

Converts a swagger document to human-formatted JSON.

getFieldPermissions(Type<?>, String) - Method in class com.yahoo.elide.swagger.JsonApiModelResolver

Get the field level permission annotation value.

getFullLineage() - Method in class com.yahoo.elide.swagger.SwaggerBuilder.PathMetaData

Constructs a new lineage including the current path element.

getInstancePath() - Method in class com.yahoo.elide.swagger.SwaggerBuilder.PathMetaData

Returns the Swagger Path for an instance URL.

getReadPermission(Type<?>, String) - Method in class com.yahoo.elide.swagger.JsonApiModelResolver

Get the calculated ReadPermission value for the field.

getRelationshipPath() - Method in class com.yahoo.elide.swagger.SwaggerBuilder.PathMetaData

Returns the swagger path for a relationship URL.

getRelationshipUrl() - Method in class com.yahoo.elide.swagger.SwaggerBuilder.PathMetaData

Constructs a URL that returns a relationship collection.

getRootType() - Method in class com.yahoo.elide.swagger.SwaggerBuilder.PathMetaData

Returns the root type (first collection) of this path.

getUpdatePermission(Type<?>, String) - Method in class com.yahoo.elide.swagger.JsonApiModelResolver

Get the calculated UpdatePermission value for the field.

globalParams - Variable in class com.yahoo.elide.swagger.SwaggerBuilder

globalResponses - Variable in class com.yahoo.elide.swagger.SwaggerBuilder

H

hashCode() - Method in class com.yahoo.elide.swagger.SwaggerBuilder.PathMetaData

I

IncludedResource - Class in com.yahoo.elide.swagger.property

Represents the schema for the 'included' section of a JSON-API compound document.

IncludedResource() - Constructor for class com.yahoo.elide.swagger.property.IncludedResource

J

JSON_API_MIME - Static variable in class com.yahoo.elide.swagger.JsonApiOperation

JsonApiModelResolver - Class in com.yahoo.elide.swagger

Swagger ModelResolvers map POJO classes to Swagger example.models.

JsonApiModelResolver(EntityDictionary) - Constructor for class com.yahoo.elide.swagger.JsonApiModelResolver

JsonApiOperation - Class in com.yahoo.elide.swagger

Operation that consumes and produces JSON API mime type.

JsonApiOperation() - Constructor for class com.yahoo.elide.swagger.JsonApiOperation

L

list(String) - Method in class com.yahoo.elide.swagger.resources.DocEndpoint

N

NOT_FOUND_RESPONSE - Static variable in class com.yahoo.elide.swagger.SwaggerBuilder

P

PathMetaData(Type<?>) - Constructor for class com.yahoo.elide.swagger.SwaggerBuilder.PathMetaData

Constructs a PathMetaData for a 'root' entity.

PathMetaData(Stack<SwaggerBuilder.PathMetaData>, String, Type<?>) - Constructor for class com.yahoo.elide.swagger.SwaggerBuilder.PathMetaData

Required argument constructor.

R

Relationship - Class in com.yahoo.elide.swagger.property

Represents a JSON-API resource identifier.

Relationship(String) - Constructor for class com.yahoo.elide.swagger.property.Relationship

Constructs a singular resource identifier.

REQUEST_TIMEOUT_RESPONSE - Static variable in class com.yahoo.elide.swagger.SwaggerBuilder

resolve(Type, ModelConverterContext, Iterator<ModelConverter>) - Method in class com.yahoo.elide.swagger.JsonApiModelResolver

Resource - Class in com.yahoo.elide.swagger.model

Represents a Swagger Model that was mapped from a POJO.

Resource() - Constructor for class com.yahoo.elide.swagger.model.Resource

rootClasses - Variable in class com.yahoo.elide.swagger.SwaggerBuilder

S

setSecurityDescription(String) - Method in class com.yahoo.elide.swagger.model.Resource

shorterThan(SwaggerBuilder.PathMetaData) - Method in class com.yahoo.elide.swagger.SwaggerBuilder.PathMetaData

Returns true if this path is a shorter path to the same entity than the given path.

supportLegacyDialect - Variable in class com.yahoo.elide.swagger.SwaggerBuilder

supportRSQLDialect - Variable in class com.yahoo.elide.swagger.SwaggerBuilder

swagger - Variable in class com.yahoo.elide.swagger.SwaggerBuilder

SwaggerBuilder - Class in com.yahoo.elide.swagger

Builds a 'Swagger' object from Swagger-Core by walking the static Elide entity metadata contained in the 'EntityDictionary'.

SwaggerBuilder(EntityDictionary, Info) - Constructor for class com.yahoo.elide.swagger.SwaggerBuilder

Constructor.

SwaggerBuilder.PathMetaData - Class in com.yahoo.elide.swagger

Metadata for constructing URLs and Swagger 'Path' objects.

SwaggerRegistration() - Constructor for class com.yahoo.elide.swagger.resources.DocEndpoint.SwaggerRegistration

T

TOO_MANY_REQUESTS_RESPONSE - Static variable in class com.yahoo.elide.swagger.SwaggerBuilder

toString() - Method in class com.yahoo.elide.swagger.SwaggerBuilder.PathMetaData

U

UNAUTHORIZED_RESPONSE - Static variable in class com.yahoo.elide.swagger.SwaggerBuilder

W

withExplicitClassList(Set<Type<?>>) - Method in class com.yahoo.elide.swagger.SwaggerBuilder

The classes for which API paths will be generated.

withFilterOps(Set<Operator>) - Method in class com.yahoo.elide.swagger.SwaggerBuilder

Assigns a subset of the complete set of filter operations to support for each GET operation.

withGlobalParameter(Parameter) - Method in class com.yahoo.elide.swagger.SwaggerBuilder

Decorates every path with the given parameter.

withGlobalResponse(int, Response) - Method in class com.yahoo.elide.swagger.SwaggerBuilder

Decorates every operation on every path with the given response.

withLegacyFilterDialect(boolean) - Method in class com.yahoo.elide.swagger.SwaggerBuilder

Turns on or off the legacy filter dialect.

withRSQLFilterDialect(boolean) - Method in class com.yahoo.elide.swagger.SwaggerBuilder

Turns on or off the RSQL filter dialect.

A B C D E F G H I J L N P R S T U W
All Classes All Packages