view common/src/main/java/com/redhat/thermostat/common/json/models/ApiDef.java @ 25:dd0992bd51aa

Add Maven Central upload, refactor lang-schema and json libs to thermostat-common library - merge common-json and common-lang-schema packages into thermostat- common. - add targets to generate Javadoc and source jars, and modify sources to remove some Javadoc warnings. - add targets to sign and deploy thermostat-common to Maven Central. Reviewed-by: sgehwolf, neugens Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2017-September/025214.html
author Simon Tooke <stooke@redhat.com>
date Fri, 29 Sep 2017 14:48:00 -0400
parents common/json/src/main/java/com/redhat/thermostat/common/json/models/ApiDef.java@ab2706b9b1e3
children
line wrap: on
line source

/*
 * Copyright 2012-2017 Red Hat, Inc.
 *
 * This file is part of Thermostat.
 *
 * Thermostat is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published
 * by the Free Software Foundation; either version 2, or (at your
 * option) any later version.
 *
 * Thermostat 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
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Thermostat; see the file COPYING.  If not see
 * <http://www.gnu.org/licenses/>.
 *
 * Linking this code with other modules is making a combined work
 * based on this code.  Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 *
 * As a special exception, the copyright holders of this code give
 * you permission to link this code with independent modules to
 * produce an executable, regardless of the license terms of these
 * independent modules, and to copy and distribute the resulting
 * executable under terms of your choice, provided that you also
 * meet, for each linked independent module, the terms and conditions
 * of the license of that module.  An independent module is a module
 * which is not derived from or based on this code.  If you modify
 * this code, you may extend this exception to your version of the
 * library, but you are not obligated to do so.  If you do not wish
 * to do so, delete this exception statement from your version.
 */

package com.redhat.thermostat.common.json.models;

import com.google.gson.JsonObject;
import com.google.gson.annotations.SerializedName;

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

/**
 * Java representation of a Swagger-defined web API endpoint
 */
public class ApiDef {

    String path;
    String description;
    JsonObject root;
    List<ParameterDef>  parameters;
    MethodDef get;
    MethodDef put;
    MethodDef post;
    MethodDef delete;

    /**
     * Java representation of a Swagger endpoint
     */
    public static class MethodDef {
        List<ParameterDef> parameters;
        String description;
        Map<Integer, ResponseDef> responses;

        public String getDescription() {
            return this.description;
        }
    }

    static class ResponseDef {
        String description;
        JsonObject schema;
    }

    static class ParameterDef {
        enum In { query, path, body };
        enum Type { integer, string, bool };
        String name;
        String description;
        In in;
        Type type;
        boolean required;
        @SerializedName("default")
        String deflt;
    }

    public void setPath(String path) {
        this.path = path;
    }

    public MethodDef getGETAPI() {
        return get;
    }

    public MethodDef getPOSTAPI() {
        return post;
    }

    public MethodDef getDELETEAPI() {
        return delete;
    }

    public MethodDef getPUTAPI() {
        return put;
    }
}