io.openapitools.swagger.config.SwaggerServerVariable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of swagger-maven-plugin Show documentation

Maven plugin to generate OpenAPI documentation using Swagger.

The newest version!

package io.openapitools.swagger.config;

import java.util.Collections;
import java.util.List;
import java.util.Map;

import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import io.swagger.v3.oas.models.servers.ServerVariable;
import org.apache.maven.plugins.annotations.Parameter;

public class SwaggerServerVariable {

    /**
     * REQUIRED. The default value to use for substitution, and to send, if an
     * alternate value is not supplied. Unlike the Schema Object's default, this
     * value MUST be provided by the consumer.
     */
    @Parameter(required = true)
    private String defaultValue;

    /**
     * An enumeration of string values to be used if the substitution options are
     * from a limited set.
     */
    @Parameter
    private List enumValues = Collections.emptyList();

    /**
     * An optional description for the server variable. CommonMark syntax MAY be
     * used for rich text representation.
     */
    @Parameter
    private String description;

    @Parameter
    private Map extensions;

    public ServerVariable createServerVariableModel() {
        ServerVariable serverVar = new ServerVariable();

        serverVar.setDefault(defaultValue);
        if (enumValues != null && !enumValues.isEmpty()) {
            serverVar.setEnum(enumValues);
        }
        serverVar.setDescription(description);

        if (extensions != null && !extensions.isEmpty()) {
            serverVar.setExtensions(extensions);
        }

        return serverVar;
    }

    @JsonPropertyOrder({"description", "default", "enum"})
    public static abstract class ServerVariableMixin {
        @JsonAnyGetter
        public abstract Map getExtensions();
    }

}