Package | Description |
---|---|
org.forgerock.api |
ForgeRock API Descriptor models, builders, and utilities.
|
org.forgerock.api.models |
ForgeRock API Descriptor models.
|
org.forgerock.api.transform |
Classes that transform
ApiDescription into different API representations. |
org.forgerock.util.i18n |
Utility classes for dealing with internationalization (i18n).
|
Constructor and Description |
---|
CrestApiProducer(String id,
String apiVersion,
LocalizableString description)
Construct a new producer.
|
Modifier and Type | Method and Description |
---|---|
LocalizableString |
Resource.getDescription()
Getter of description.
|
LocalizableString |
Parameter.getDescription()
Getter of the parameter description.
|
LocalizableString |
Operation.getDescription()
Getter of the description.
|
LocalizableString |
ApiError.getDescription()
Getter of the error description.
|
LocalizableString |
ApiDescription.getDescription()
Gets description of API Descriptor.
|
LocalizableString |
Resource.getTitle()
Getter of title.
|
Modifier and Type | Method and Description |
---|---|
Resource |
Items.asResource(boolean mvccSupported,
Schema resourceSchema,
LocalizableString title,
LocalizableString description)
Builds a
Resource from this Items instance. |
Resource.Builder |
Resource.Builder.description(LocalizableString description)
Set the description.
|
Parameter.Builder |
Parameter.Builder.description(LocalizableString description)
Set the parameter description.
|
T |
Operation.Builder.description(LocalizableString description)
Set the description.
|
ApiError.Builder |
ApiError.Builder.description(LocalizableString description)
Set the error description.
|
ApiDescription.Builder |
ApiDescription.Builder.description(LocalizableString description)
Sets the description.
|
Resource.Builder |
Resource.Builder.title(LocalizableString title)
Set the title.
|
Modifier and Type | Method and Description |
---|---|
LocalizableString |
LocalizableTag.getLocalizableDescription() |
LocalizableString |
LocalizableRefProperty.getLocalizableDescription() |
LocalizableString |
LocalizableOperation.getLocalizableDescription() |
LocalizableString |
LocalizableTag.getLocalizableName()
Returns the name of a Tag, a LocalizableString.
|
LocalizableString |
LocalizableRefProperty.getLocalizableTitle() |
Modifier and Type | Method and Description |
---|---|
List<LocalizableString> |
LocalizableOperation.getLocalizableTags()
Returns the localizable tags for this operation.
|
Modifier and Type | Method and Description |
---|---|
void |
LocalizableOperation.addTag(LocalizableString tag)
Adds a Tag, a String value that is metadata related to the Operation.
|
LocalizableTag |
LocalizableTag.description(LocalizableString desc) |
LocalizableRefProperty |
LocalizableRefProperty.description(LocalizableString description) |
LocalizableOperation |
LocalizableOperation.description(LocalizableString desc) |
static io.swagger.models.Swagger |
OpenApiTransformer.execute(LocalizableString title,
String host,
String basePath,
boolean secure,
ApiDescription apiDescription,
ApiDescription... externalApiDescriptions)
Transforms an
ApiDescription into a Swagger model. |
LocalizableTag |
LocalizableTag.name(LocalizableString name)
Sets the name of the Tag.
|
LocalizableRefProperty |
LocalizableRefProperty.title(LocalizableString title) |
Constructor and Description |
---|
LocalizableString(String key,
ClassLoader loader,
LocalizableString defaultValue)
Constructor for potentially localizable
String . |
Copyright © 2010-2018, ForgeRock All Rights Reserved.