de.fraunhofer.iosb.ilt.frostserver.plugin.openapi.spec.OAHeader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of FROST-Server.Plugin.OpenApi Show documentation

OpenAPI definition generator for the SensorThings API interface.

There is a newer version: 2.5.0

Show newest version

/*
 * Copyright (C) 2024 Fraunhofer Institut IOSB, Fraunhoferstr. 1, D 76131
 * Karlsruhe, Germany.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see .
 */
package de.fraunhofer.iosb.ilt.frostserver.plugin.openapi.spec;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * An OpenAPI header object.
 *
 * @author scf
 */
@JsonInclude(JsonInclude.Include.NON_EMPTY)
public final class OAHeader {

    private String ref;
    private String description;
    private OASchema schema;

    public OAHeader(String ref) {
        this.ref = ref;
    }

    public OAHeader(String description, OASchema schema) {
        this.description = description;
        this.schema = schema;
    }

    /**
     * @return the ref
     */
    @JsonProperty(value = "$ref")
    public String getRef() {
        return ref;
    }

    /**
     * @return the description
     */
    public String getDescription() {
        return description;
    }

    /**
     * @return the schema
     */
    public OASchema getSchema() {
        return schema;
    }

}