main/src/main/java/org/onap/policy/pap/main/config/SpringDocBean.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2021-2022 Nordix Foundation.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.pap.main.config;
  22
  23 import io.swagger.v3.oas.models.ExternalDocumentation;
  24 import io.swagger.v3.oas.models.OpenAPI;
  25 import io.swagger.v3.oas.models.info.Info;
  26 import io.swagger.v3.oas.models.info.License;
  27 import org.springframework.context.annotation.Bean;
  28 import org.springframework.context.annotation.Configuration;
  29
  30 @Configuration
  31 public class SpringDocBean {
  32
  33     /**
  34      * Bean to configure Springdoc.
  35      *
  36      * @return the OpenAPI specification
  37      */
  38     @Bean
  39     public OpenAPI policyFrameworkLifecycleOpenApi() {
  40         return new OpenAPI()
  41             .info(new Info().title("Policy Framework Policy Administration (PAP)")
  42                 .description(
  43                     "The Policy Framework Policy Administration (PAP) allows"
  44                         + " Policies to be grouped, deployed, and monitored")
  45                 .license(new License().name("Apache 2.0").url("http://www.apache.org/licenses/LICENSE-2.0")))
  46             .externalDocs(new ExternalDocumentation()
  47                 .description("Policy Framework Documentation")
  48                 .url("https://docs.onap.org/projects/onap-policy-parent/en/latest"));
  49     }
  50 }