pmlog/src/main/java/org/oran/pmlog/SwaggerConfig.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2023 Nordix Foundation
   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.oran.pmlog;
  22
  23 import io.swagger.v3.oas.annotations.OpenAPIDefinition;
  24 import io.swagger.v3.oas.annotations.info.Info;
  25 import io.swagger.v3.oas.annotations.info.License;
  26
  27 /**
  28  * Swagger configuration class that uses swagger documentation type and scans
  29  * all the controllers. To access the swagger gui go to
  30  * http://ip:port/swagger-ui.html
  31  */
  32 @OpenAPIDefinition( //
  33         info = @Info(title = SwaggerConfig.API_TITLE, //
  34                 version = "1.0", //
  35                 description = SwaggerConfig.DESCRIPTION, //
  36                 license = @License(name = "Copyright (C) 2023 Nordix Foundation. Licensed under the Apache License.",
  37                         url = "http://www.apache.org/licenses/LICENSE-2.0")))
  38 public class SwaggerConfig {
  39     private SwaggerConfig() {}
  40
  41     static final String API_TITLE = "PM Logger";
  42     static final String DESCRIPTION =
  43             "Receives PM reports from a Kafka topic and writes the PM counters into an Influx database.";
  44 }