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 ForgeRock AS.
15 */
16
17 package org.forgerock.api.annotations;
18
19 /**
20 * Details of an error that could be returned.
21 */
22 public @interface ApiError {
23 /**
24 * An identifier for this error condition. If specified, this error will be defined at the top-level and
25 * referenced when used. If not specified, this error will be declared inline.
26 */
27 String id() default "";
28 /** The error code that will be returned in this situation. */
29 int code();
30 /** A description of the error condition, and what may have caused it. */
31 String description();
32 /** The schema for the error detail, if relevant. */
33 Schema detailSchema() default @Schema;
34 }