auth/auth-core/src/main/java/org/onap/aaf/auth/rserv/doc/ApiDoc.java

   1 /**
   2  * ============LICENSE_START====================================================
   3  * org.onap.aaf
   4  * ===========================================================================
   5  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
   6  * ===========================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END====================================================
  19  *
  20  */
  21 package org.onap.aaf.auth.rserv.doc;
  22
  23 import java.lang.annotation.ElementType;
  24 import java.lang.annotation.Retention;
  25 import java.lang.annotation.RetentionPolicy;
  26 import java.lang.annotation.Target;
  27
  28 import org.onap.aaf.auth.rserv.HttpMethods;
  29 @Retention(RetentionPolicy.RUNTIME)
  30 @Target({ElementType.METHOD})
  31 public @interface ApiDoc {
  32     HttpMethods method();
  33     String path();
  34     int expectedCode();
  35     int[] errorCodes();
  36     String[] text();
  37     /** Format with name|type|[true|false] */
  38     String[] params();
  39
  40 }