Uses of Class
org.forgerock.api.models.ApiDescription

Packages that use ApiDescription

Package	Description
org.forgerock.api	ForgeRock API Descriptor models, builders, and utilities.
org.forgerock.api.commons	Data related to ForgeRock Commons API Descriptor.
org.forgerock.api.markup	Classes that generate CREST API Descriptor documentation.
org.forgerock.api.models	ForgeRock API Descriptor models.
org.forgerock.api.transform	Classes that transform ApiDescription into different API representations.
org.forgerock.api.util	API Descriptor utility classes.
org.forgerock.json.resource	Classes and interfaces for core types including connections, request handlers, resources, and their exceptions.

Uses of ApiDescription in org.forgerock.api

Methods in org.forgerock.api that return ApiDescription

Modifier and Type	Method and Description
ApiDescription	CrestApiProducer.addApiInfo(ApiDescription api)
ApiDescription	CrestApiProducer.merge(List<ApiDescription> descriptions)
ApiDescription	CrestApiProducer.withPath(ApiDescription api, String parentPath)
ApiDescription	CrestApiProducer.withVersion(ApiDescription api, Version version)

Methods in org.forgerock.api that return types with arguments of type ApiDescription

Modifier and Type	Method and Description
ApiProducer<ApiDescription>	CrestApiProducer.newChildProducer(String idFragment)

Methods in org.forgerock.api with parameters of type ApiDescription

Modifier and Type	Method and Description
ApiDescription	CrestApiProducer.addApiInfo(ApiDescription api)
ApiDescription	CrestApiProducer.withPath(ApiDescription api, String parentPath)
ApiDescription	CrestApiProducer.withVersion(ApiDescription api, Version version)

Method parameters in org.forgerock.api with type arguments of type ApiDescription

Modifier and Type	Method and Description
ApiDescription	CrestApiProducer.merge(List<ApiDescription> descriptions)

Uses of ApiDescription in org.forgerock.api.commons

Fields in org.forgerock.api.commons declared as ApiDescription

Modifier and Type	Field and Description
static ApiDescription	CommonsApi.COMMONS_API_DESCRIPTION The api description of "frapi:common" which only contains errors so far.

Uses of ApiDescription in org.forgerock.api.markup

Methods in org.forgerock.api.markup with parameters of type ApiDescription

Modifier and Type	Method and Description
static String	ApiDocGenerator.execute(String title, ApiDescription apiDescription, Path inputDirPath, ApiDescription... externalApiDescriptions) Generates AsciiDoc documentation for a CREST API Descriptor, to a String.
static String	ApiDocGenerator.execute(String title, ApiDescription apiDescription, Path inputDirPath, ApiDescription... externalApiDescriptions) Generates AsciiDoc documentation for a CREST API Descriptor, to a String.
static void	ApiDocGenerator.execute(String title, ApiDescription apiDescription, Path inputDirPath, Path outputDirPath, ApiDescription... externalApiDescriptions) Generates AsciiDoc documentation for a CREST API Descriptor, to an output-directory.
static void	ApiDocGenerator.execute(String title, ApiDescription apiDescription, Path inputDirPath, Path outputDirPath, ApiDescription... externalApiDescriptions) Generates AsciiDoc documentation for a CREST API Descriptor, to an output-directory.

Uses of ApiDescription in org.forgerock.api.models

Methods in org.forgerock.api.models that return ApiDescription

Modifier and Type	Method and Description
ApiDescription	ApiDescription.Builder.build() Builds the ApiDescription instance.

Methods in org.forgerock.api.models with parameters of type ApiDescription

Modifier and Type	Method and Description
T	Operation.Builder.detailsFromAnnotation(Operation operation, ApiDescription descriptor, Class<?> relativeType) Set all properties in the Builder using the data in the annotation.
static Items	Items.fromAnnotatedType(Class<?> type, ApiDescription descriptor, SubResources subResources) Build an Items from an annotated request handler.
static Resource	Resource.fromAnnotatedType(Class<?> type, Resource.AnnotatedTypeVariant variant, ApiDescription descriptor) Build a Resource from an annotated request handler.
static Resource	Resource.fromAnnotatedType(Class<?> type, Resource.AnnotatedTypeVariant variant, Items items, ApiDescription descriptor, Parameter... extraParameters) Build a Resource from an annotated request handler.
static Resource	Resource.fromAnnotatedType(Class<?> type, Resource.AnnotatedTypeVariant variant, SubResources subResources, ApiDescription descriptor, Parameter... extraParameters) Build a Resource from an annotated request handler.
static Action	Action.fromAnnotation(Action action, Method annotated, ApiDescription descriptor, Class<?> relativeType) Builds an Action object using the data in the annotation.
static ApiError	ApiError.fromAnnotation(ApiError apiError, ApiDescription descriptor, Class<?> relativeType) Builds an ApiError object from the data in the annotation.
static Create	Create.fromAnnotation(Create create, boolean instanceOperations, ApiDescription descriptor, Class<?> relativeType) Builds a Create object from the data in the annotation.
static Delete	Delete.fromAnnotation(Delete delete, ApiDescription descriptor, Class<?> relativeType) Builds a Delete object from the data in the Delete annotation.
static Patch	Patch.fromAnnotation(Patch patch, ApiDescription descriptor, Class<?> relativeType) Builds a Patch object from the data stored in the annotation.
static Query	Query.fromAnnotation(Query query, Method annotated, ApiDescription descriptor, Class<?> relativeType) Builds a Query object from the data stored in the annotation.
static Read	Read.fromAnnotation(Read read, ApiDescription descriptor, Class<?> relativeType) Builds a Read object from the data in the read annotation.
static Schema	Schema.fromAnnotation(Schema schema, ApiDescription descriptor, Class<?> relativeType) Builds Schema object from the data in the annotation parameter.
static Update	Update.fromAnnotation(Update update, ApiDescription descriptor, Class<?> relativeType) Builds an Update object from the data stored in the annotation.

Uses of ApiDescription in org.forgerock.api.transform

Methods in org.forgerock.api.transform with parameters of type ApiDescription

Modifier and Type	Method and Description
static io.swagger.models.Swagger	OpenApiTransformer.execute(ApiDescription apiDescription, ApiDescription... externalApiDescriptions) Transforms an ApiDescription into a Swagger model.
static io.swagger.models.Swagger	OpenApiTransformer.execute(ApiDescription apiDescription, ApiDescription... externalApiDescriptions) Transforms an ApiDescription into a Swagger model.
static io.swagger.models.Swagger	OpenApiTransformer.execute(LocalizableString title, String host, String basePath, boolean secure, ApiDescription apiDescription, ApiDescription... externalApiDescriptions) Transforms an ApiDescription into a Swagger model.
static io.swagger.models.Swagger	OpenApiTransformer.execute(LocalizableString title, String host, String basePath, boolean secure, ApiDescription apiDescription, ApiDescription... externalApiDescriptions) Transforms an ApiDescription into a Swagger model.

Uses of ApiDescription in org.forgerock.api.util

Methods in org.forgerock.api.util with parameters of type ApiDescription

Modifier and Type	Method and Description
ReferenceResolver	ReferenceResolver.register(ApiDescription apiDescription) Registers an external ApiDescription, for Reference lookup, and must not have previously been registered.
ReferenceResolver	ReferenceResolver.registerAll(ApiDescription... apiDescriptions) Registers external ApiDescriptions, for Reference lookup, and each must not have previously been registered.

Constructors in org.forgerock.api.util with parameters of type ApiDescription

Constructor and Description
ReferenceResolver(ApiDescription local) Creates a reference-resolver and defines the one ApiDescription that can be used for local (non-namespaced) reference lookups.

Uses of ApiDescription in org.forgerock.json.resource

Methods in org.forgerock.json.resource that return ApiDescription

Modifier and Type	Method and Description
ApiDescription	FilterChain.api(ApiProducer<ApiDescription> producer)
ApiDescription	DescribedSyncRequestHandlerAdapter.api(ApiProducer<ApiDescription> producer)
ApiDescription	AbstractConnectionWrapper.api(ApiProducer<ApiDescription> producer)
ApiDescription	Router.handleApiRequest(Context context, Request request)
ApiDescription	FilterChain.handleApiRequest(Context context, Request request)
ApiDescription	DescribedSyncRequestHandlerAdapter.handleApiRequest(Context context, Request request)
ApiDescription	AbstractConnectionWrapper.handleApiRequest(Context context, Request request)

Method parameters in org.forgerock.json.resource with type arguments of type ApiDescription

Modifier and Type	Method and Description
ApiDescription	FilterChain.api(ApiProducer<ApiDescription> producer)
ApiDescription	DescribedSyncRequestHandlerAdapter.api(ApiProducer<ApiDescription> producer)
ApiDescription	AbstractConnectionWrapper.api(ApiProducer<ApiDescription> producer)

Constructor parameters in org.forgerock.json.resource with type arguments of type ApiDescription

Constructor and Description
Router(AbstractRouter<Router,Request,RequestHandler,ApiDescription> router) Creates a new router containing the same routes and default route as the provided router.