authz-core/src/main/java/com/att/cssa/rserv/doc/ApiDoc.java

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