summaryrefslogtreecommitdiffstats
path: root/src/main/java/org/onap/sdc/helmvalidator/config/DocsConfiguration.java
blob: c2c572f295bc9ba9f0bdab45a2f693a9117bc650 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
/*
 * ============LICENSE_START=======================================================
 * SDC-HELM-VALIDATOR
 * ================================================================================
 * Copyright (C) 2021 Nokia. All rights reserved.
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * ============LICENSE_END=========================================================
 */

package org.onap.sdc.helmvalidator.config;

import io.swagger.v3.oas.annotations.OpenAPIDefinition;
import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.media.ArraySchema;
import io.swagger.v3.oas.models.media.Schema;
import io.swagger.v3.oas.models.media.StringSchema;
import java.util.List;
import java.util.Map;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@OpenAPIDefinition
public class DocsConfiguration {

    /**
     * Create Open API definition.
     *
     * @return Custom Open API definition
     */
    @Bean
    public OpenAPI customOpenApi() {
        var versionsSchema = new Schema<Map<String, List<String>>>().addProperties("versions", getArraySchema());

        return new OpenAPI().info(
            new Info()
                .title("OpenAPI definition for SDC Helm validator")
                .version("v0")
                .description("Application for validating Helm charts."))
            .components(new Components()
                .addSchemas("VersionsResponse", versionsSchema));
    }

    private ArraySchema getArraySchema() {
        var arraySchema = new ArraySchema();
        arraySchema.setItems(new StringSchema());
        return arraySchema;
    }
}