All Classes and Interfaces

Class	Description
Action	Indicates an CREST action method on an annotated POJO.
Action	Class that represents the Action operation type in API descriptor.
Action.Builder	Builder class for creating the Action.
Actions	Declare an array of Action operations from a single method.
AdditionalProperties	Annotation to define JSON Schema additionalProperties, which is useful when working with key/value JSON data structures.
ApiDescription	Class that represents the ApiDescription type in API descriptor.
ApiDescription.Builder	Builder for the ApiDescription.
ApiDocGenerator	Generates static AsciiDoc documentation for CREST API Descriptors.
ApiDocGeneratorException	Signals that an error occurred while generating API documentation.
ApiError	Details of an error that could be returned.
ApiError	Class that represents the ApiError type in API descriptor.
ApiError.Builder	Builder for the ApiError.
ApiValidationException	Signals that API failed validation.
AsciiDoc	Root builder for AsciiDoc markup.
AsciiDocException	Signals that an error occurred while building AsciiDoc markup.
AsciiDocSymbols	Enumeration of AsciiDoc markup symbols.
AsciiDocTable	AsciiDoc table builder [ref], which defers insertion of the table, at the end of the parent document, until AsciiDocTable.tableEnd() is called.
AsciiDocTableColumnStyles	AsciiDoc table column-styles.
BigDecimalUtil	Common utility methods for dealing with BigDecimal values.
CollectionProvider	A marker annotation to indicate that the annotated class should be interpreted as an annotated CREST collection provider resource.
CommonsApi	Commons ForgeRock API description.
CommonsApi.Errors	Common api errors.
CountPolicy	Enum that represents the Query supported count-policy.
Create	Indicates an CREST create method on an annotated POJO.
Create	Class that represents the Create Operation type in API descriptor.
Create.Builder	Builder for the Create.
CreateMode	Enum that represents the Create modes.
CreateSingleton	Types of create that might be singletons.
CrestAnySchema	An extension to the Jackson AnySchema that includes the custom CREST JSON Schema attributes.
CrestApiProducer	An ApiProducer implementation for CREST resources, that provides ApiDescription descriptors.
CrestArraySchema	An extension to the Jackson ArraySchema that includes the custom CREST JSON Schema attributes.
CrestBooleanSchema	An extension to the Jackson BooleanSchema that includes the custom CREST JSON Schema attributes.
CrestJsonSchemaFactory	A JsonSchemaFactory that returns the extension schema objects rather than the default Jackson implementations.
CrestObjectSchema	An extension to the Jackson ObjectSchema that includes the custom CREST JSON Schema attributes.
CrestPropertyDetailsSchemaFactoryWrapper	A SchemaFactoryWrapper that adds the extra CREST schema attributes once the Jackson schema generation has been completed.
Default	Annotation to define JSON Schema property's default-value, represented as a String.
Definitions	Class that represents API descriptor Schema definitions.
Definitions.Builder	Builder to help construct the Definitions.
Delete	Indicates an CREST delete method on an annotated POJO.
Delete	Class that represents the Delete operation type in API descriptor.
Delete.Builder	Builder for the Delete.
Description	Annotation to define JSON Schema property's description.
EnumTitle	Annotation to provide a title for a given enum value.
Errors	Class that represents API descriptor ApiError errors.
Errors.Builder	Builder to help construct the Errors.
Example	Specify an example value for the JSON schema.
Format	Annotation to mark a JSON Schema property's format field.
Handler	Details of a handler.
Items	Class that represents the Items type in API descriptor.
Items.Builder	Builder to help construct the Items.
JacksonUtils	Some utilities for working with Jackson, JSON object mapping, and JSON schema.
LocalizableOperation	Localizable Operation.
LocalizableTag	Localizable Tag.
MultipleOf	Annotation to mark a numeric JSON Schema property's multipleOf field.
MultipleOfSchema	Interface defining support for multipleOf JSON Schema field.
OpenApiHelper	Helper methods for applying commonly needed changes to the OpenAPI model.
OpenApiHelper.OperationVisitor	Visits an OpenAPI Operation.
OpenApiTransformer	Transforms an ApiDescription into an OpenAPI 3.0 model.
Operation	The common details of an operation.
Operation	Class that represents the Operation type in API descriptor.
Operation.Builder<T extends Operation.Builder<T>>	Builder to help construct the Operation.
PagingMode	Enum that represents the Query paging mode.
Parameter	A extra parameter to an operation.
Parameter	Class that represents the Parameter type in API descriptor.
Parameter.Builder	Builder to construct Parameter object.
ParameterSource	Enum that represents where the Parameter comes from.
Patch	Indicates an CREST patch method on an annotated POJO.
Patch	Class that represents the Patch operation type in API descriptor.
Patch.Builder	Builder to help construct the Patch.
PatchOperation	Represents all Patch operations.
Path	Allocate a path to a component.
Paths	Class that represents the Paths type in API descriptor.
Paths.Builder	Builder to help construct the Paths.
PathsModule	Jackson Module that adds a serializer modifier for Paths.
PathUtil	Utilities for working with API Description paths and path-parameters.
PropertyOrder	Annotation to provide a property order for a given object property.
PropertyPolicies	An annotation to declare the policies for property access in the CREST API Descriptor schema elements.
Queries	Declare an array of Query operations from a single method.
Query	Indicates an CREST query method on an annotated POJO.
Query	Class that represents the Create Operation type in API descriptor.
Query.Builder	Builder to help construct the Read.
QueryType	Enum that represents the Query type.
Read	Indicates an CREST read method on an annotated POJO.
Read	Class that represents the Read Operation type in API descriptor.
Read.Builder	Builder to help construct the Read.
ReadOnly	Annotation to mark a JSON Schema property as read-only.
ReadPolicy	Enum that represents the Schema read policies.
Reference	Class that represents the Reference type in API descriptor.
Reference.Builder	Builder to help construct the Reference.
ReferenceResolver	Helper that registers one or more ApiDescription instances and provides a means to resolve References.
RequestHandler	A marker annotation to indicate that the annotated class should be interpreted as an annotated CREST request handler.
Resource	Class that represents the Resource type in API descriptor.
Resource.AnnotatedTypeVariant	The variant of the annotated type.
Resource.Builder	Builder to help construct the Resource.
Schema	Specify a schema for the element that is being described.
Schema	Class that represents the Schema type in API descriptor.
Schema.Builder	A builder class for Schema instances.
Services	Class that represents API descriptor's Service Resource definitions.
Services.Builder	Builder to help construct the Services.
SingletonProvider	A marker annotation to indicate that the annotated class should be interpreted as an annotated CREST singleton provider resource.
Stability	Represents API stability.
SubResources	Sub-resources of a resource are declared here.
SubResources.Builder	Builder to help construct the SubResources.
Title	Annotation to define JSON Schema property's title.
TransformerException	Signals that an error occurred while transforming an API Description to another format.
TranslateJsonSchema	Iterates over each JsonValue node in the JsonValue structure and if it's a String marked for translation, It replaces the String with a LocalizableString.
UniqueItems	Annotation to mark a JSON Schema array-items as unique.
Update	Indicates an CREST update method on an annotated POJO.
Update	Class that represents the Create Operation type in API descriptor.
Update.Builder	Builder to help construct Update.
ValidationUtil	API Descriptor model-validation utilities.
VersionedPath	Class that represents versioned Resources on an API descriptor path.
VersionedPath.Builder	Builder to help construct the VersionedPath.
WithExampleSchema<T>	Extension for CREST and OpenAPI schemas to express an example value.
WritePolicy	Enum that represents the Schema write policies.