Uses of Package
org.forgerock.api.models

Packages that use org.forgerock.api.models

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.

Classes in org.forgerock.api.models used by org.forgerock.api

Class and Description
ApiDescription Class that represents the ApiDescription type in API descriptor.

Classes in org.forgerock.api.models used by org.forgerock.api.commons

Class and Description
ApiDescription Class that represents the ApiDescription type in API descriptor.

Classes in org.forgerock.api.models used by org.forgerock.api.markup

Class and Description
ApiDescription Class that represents the ApiDescription type in API descriptor.

Classes in org.forgerock.api.models used by org.forgerock.api.models

Class and 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 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.AnnotatedTypeVariant The variant of the annotated type.
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.
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.

Classes in org.forgerock.api.models used by org.forgerock.api.transform

Class and Description
ApiDescription Class that represents the ApiDescription type in API descriptor.

Classes in org.forgerock.api.models used by org.forgerock.api.util

Class and Description
ApiDescription Class that represents the ApiDescription type in API descriptor.
ApiError Class that represents the ApiError type in API descriptor.
Parameter Class that represents the Parameter type in API descriptor.
Reference Class that represents the Reference type in API descriptor.
Resource Class that represents the Resource type in API descriptor.
Schema Class that represents the Schema type in API descriptor.

Classes in org.forgerock.api.models used by org.forgerock.json.resource

Class and Description
ApiDescription Class that represents the ApiDescription type in API descriptor.