1 /*
2 * The contents of this file are subject to the terms of the Common Development and
3 * Distribution License (the License). You may not use this file except in compliance with the
4 * License.
5 *
6 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
7 * specific language governing permission and limitations under the License.
8 *
9 * When distributing Covered Software, include this CDDL Header Notice in each file and include
10 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
11 * Header, with the fields enclosed by brackets [] replaced by your own identifying
12 * information: "Portions copyright [year] [name of copyright owner]".
13 *
14 * Copyright 2016-2017 ForgeRock AS.
15 */
16
17 package org.forgerock.api.annotations;
18
19 import java.lang.annotation.Retention;
20 import java.lang.annotation.RetentionPolicy;
21
22 import org.forgerock.api.enums.Stability;
23
24 /**
25 * The common details of an operation.
26 */
27 @Retention(RetentionPolicy.RUNTIME)
28 public @interface Operation {
29 /** The list of supported locales for the operation. */
30 String[] locales() default {};
31 /** Operation specific error definitions. Use this when standard error descriptions are not specific enough. */
32 ApiError[] errors() default {};
33 /**
34 * JSON references to previously declared errors (e.g., {@code frapi:common#/errors/badRequest}).
35 *
36 * @see org.forgerock.api.commons.CommonsApi#COMMONS_API_DESCRIPTION
37 */
38 String[] errorRefs() default {};
39 /** Parameters on operation paths and/or endpoints. */
40 Parameter[] parameters() default {};
41 /** The stability state for the operation. Defaults to {@code STABLE}. */
42 Stability stability() default Stability.STABLE;
43 /** A description of the operation. */
44 String description() default "";
45 }