001/*
002 * The contents of this file are subject to the terms of the Common Development and
003 * Distribution License (the License). You may not use this file except in compliance with the
004 * License.
005 *
006 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
007 * specific language governing permission and limitations under the License.
008 *
009 * When distributing Covered Software, include this CDDL Header Notice in each file and include
010 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
011 * Header, with the fields enclosed by brackets [] replaced by your own identifying
012 * information: "Portions copyright [year] [name of copyright owner]".
013 *
014 * Copyright 2016-2017 ForgeRock AS.
015 */
016
017package org.forgerock.api.annotations;
018
019import java.lang.annotation.Retention;
020import java.lang.annotation.RetentionPolicy;
021
022import org.forgerock.api.enums.Stability;
023
024/**
025 * The common details of an operation.
026 */
027@Retention(RetentionPolicy.RUNTIME)
028public @interface Operation {
029    /** The list of supported locales for the operation. */
030    String[] locales() default {};
031    /** Operation specific error definitions. Use this when standard error descriptions are not specific enough. */
032    ApiError[] errors() default {};
033    /**
034     * JSON references to previously declared errors (e.g., {@code frapi:common#/errors/badRequest}).
035     *
036     * @see org.forgerock.api.commons.CommonsApi#COMMONS_API_DESCRIPTION
037     */
038    String[] errorRefs() default {};
039    /** Parameters on operation paths and/or endpoints. */
040    Parameter[] parameters() default {};
041    /** The stability state for the operation. Defaults to {@code STABLE}. */
042    Stability stability() default Stability.STABLE;
043    /** A description of the operation. */
044    String description() default "";
045}