Package | Description |
---|---|
org.forgerock.api.models |
ForgeRock API Descriptor models.
|
org.forgerock.api.util |
API Descriptor utility classes.
|
Modifier and Type | Method and Description |
---|---|
Schema |
Schema.Builder.build()
Builds the Schema instance.
|
static Schema |
Schema.fromAnnotation(Schema schema,
ApiDescription descriptor,
Class<?> relativeType)
Builds Schema object from the data in the annotation parameter.
|
Schema |
Definitions.get(String name)
Gets the
Schema for a given Schema-name. |
Schema |
Action.getRequest()
Getter of the request.
|
Schema |
Resource.getResourceSchema()
Getter of resource schema.
|
Schema |
Action.getResponse()
Getter of the response.
|
Schema |
ApiError.getSchema()
Getter of the error schema.
|
Modifier and Type | Method and Description |
---|---|
protected Map<String,Schema> |
Definitions.getDefinitions()
Gets a
Map of schema-names to Schema s. |
Modifier and Type | Method and Description |
---|---|
Resource |
Items.asResource(boolean mvccSupported,
Schema resourceSchema,
LocalizableString title,
LocalizableString description)
Builds a
Resource from this Items instance. |
Definitions.Builder |
Definitions.Builder.put(String name,
Schema schema)
Adds a
Schema . |
Action.Builder |
Action.Builder.request(Schema request)
Set the request.
|
Resource.Builder |
Resource.Builder.resourceSchema(Schema resourceSchema)
Set the resource schema.
|
Action.Builder |
Action.Builder.response(Schema response)
Set the response.
|
ApiError.Builder |
ApiError.Builder.schema(Schema schema)
Set the schema.
|
Modifier and Type | Method and Description |
---|---|
Schema |
ReferenceResolver.getDefinition(Reference reference)
Gets a
Definitions Schema by JSON reference. |
Copyright © 2010-2018, ForgeRock All Rights Reserved.