org.forgerock.api.annotations

Annotation Type Operation

@Retention(value=RUNTIME)
public @interface Operation

The common details of an operation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description A description of the operation.
String[]	errorRefs JSON references to previously declared errors (e.g., frapi:common#/errors/badRequest).
ApiError[]	errors Operation specific error definitions.
String[]	locales The list of supported locales for the operation.
Parameter[]	parameters Parameters on operation paths and/or endpoints.
Stability	stability The stability state for the operation.

Element Detail

locales

public abstract String[] locales

The list of supported locales for the operation.

Default:

{}

errors

public abstract ApiError[] errors

Operation specific error definitions. Use this when standard error descriptions are not specific enough.

Default:

{}

errorRefs

public abstract String[] errorRefs

JSON references to previously declared errors (e.g., frapi:common#/errors/badRequest).

See Also:

CommonsApi.COMMONS_API_DESCRIPTION

Default:

{}

parameters

public abstract Parameter[] parameters

Parameters on operation paths and/or endpoints.

Default:

{}

stability

public abstract Stability stability

The stability state for the operation. Defaults to STABLE.

Default:

org.forgerock.api.enums.Stability.STABLE

description

public abstract String description

A description of the operation.

Default:

""