Package org.forgerock.api.models

ForgeRock API Descriptor models.

Class Summary

Class	Description
Action	Class that represents the Action operation type in API descriptor.
Action.Builder	Builder class for creating the Action.
ApiDescription	Class that represents the ApiDescription type in API descriptor.
ApiDescription.Builder	Builder for the ApiDescription.
ApiError	Class that represents the ApiError type in API descriptor.
ApiError.Builder	Builder for the ApiError.
Create	Class that represents the Create Operation type in API descriptor.
Create.Builder	Builder for the Create.
Definitions	Class that represents API descriptor Schema definitions.
Definitions.Builder	Builder to help construct the Definitions.
Delete	Class that represents the Delete operation type in API descriptor.
Delete.Builder	Builder for the Delete.
Errors	Class that represents API descriptor ApiError errors.
Errors.Builder	Builder to help construct the Errors.
Items	Class that represents the Items type in API descriptor.
Items.Builder	Builder to help construct the Items.
Operation	Class that represents the Operation type in API descriptor.
Operation.Builder<T extends Operation.Builder<T>>	Builder to help construct the Operation.
Parameter	Class that represents the Parameter type in API descriptor.
Parameter.Builder	Builder to construct Parameter object.
Patch	Class that represents the Patch operation type in API descriptor.
Patch.Builder	Builder to help construct the Patch.
Paths	Class that represents the Paths type in API descriptor.
Paths.Builder	Builder to help construct the Paths.
Query	Class that represents the Create Operation type in API descriptor.
Query.Builder	Builder to help construct the Read.
Read	Class that represents the Read Operation type in API descriptor.
Read.Builder	Builder to help construct the Read.
Reference	Class that represents the Reference type in API descriptor.
Reference.Builder	Builder to help construct the Reference.
Resource	Class that represents the Resource type in API descriptor.
Resource.Builder	Builder to help construct the Resource.
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.
SubResources	Sub-resources of a resource are declared here.
SubResources.Builder	Builder to help construct the SubResources.
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.
Update	Class that represents the Create Operation type in API descriptor.
Update.Builder	Builder to help construct Update.
VersionedPath	Class that represents versioned Resources on an API descriptor path.
VersionedPath.Builder	Builder to help construct the VersionedPath.

Enum Summary

Enum	Description
Resource.AnnotatedTypeVariant	The variant of the annotated type.