Package org.forgerock.api.annotations

package org.forgerock.api.annotations

Annotations that can be used to specify information to be included in the API Descriptor.

Related Packages

Package	Description
org.forgerock.api	ForgeRock API Descriptor models, builders, and utilities.

Annotation Interfaces

Class	Description
Action	Indicates an CREST action method on an annotated POJO.
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.
ApiError	Details of an error that could be returned.
CollectionProvider	A marker annotation to indicate that the annotated class should be interpreted as an annotated CREST collection provider resource.
Create	Indicates an CREST create method on an annotated POJO.
Default	Annotation to define JSON Schema property's default-value, represented as a String.
Delete	Indicates an CREST delete method on an annotated POJO.
Description	Annotation to define JSON Schema property's description.
EnumTitle	Annotation to provide a title for a given enum value.
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.
MultipleOf	Annotation to mark a numeric JSON Schema property's multipleOf field.
Operation	The common details of an operation.
Parameter	A extra parameter to an operation.
Patch	Indicates an CREST patch method on an annotated POJO.
Path	Allocate a path to a component.
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.
Read	Indicates an CREST read method on an annotated POJO.
ReadOnly	Annotation to mark a JSON Schema property as read-only.
RequestHandler	A marker annotation to indicate that the annotated class should be interpreted as an annotated CREST request handler.
Schema	Specify a schema for the element that is being described.
SingletonProvider	A marker annotation to indicate that the annotated class should be interpreted as an annotated CREST singleton provider resource.
Title	Annotation to define JSON Schema property's title.
UniqueItems	Annotation to mark a JSON Schema array-items as unique.
Update	Indicates an CREST update method on an annotated POJO.