org.zaproxy.clientapi.gen.Openapi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of zap-clientapi Show documentation
Java implementation to access ZAP API.
The newest version!
/*
 * Zed Attack Proxy (ZAP) and its related class files.
 *
 * ZAP is an HTTP/HTTPS proxy for assessing web application security.
 *
 * Copyright 2016 The ZAP Development Team
 *
 * 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.
 */
package org.zaproxy.clientapi.gen;

import java.util.HashMap;
import java.util.Map;
import org.zaproxy.clientapi.core.ApiResponse;
import org.zaproxy.clientapi.core.ClientApi;
import org.zaproxy.clientapi.core.ClientApiException;

/** This file was automatically generated. */
@SuppressWarnings("javadoc")
public class Openapi extends org.zaproxy.clientapi.gen.deprecated.OpenapiDeprecated {

    private final ClientApi api;

    public Openapi(ClientApi api) {
        super(api);
        this.api = api;
    }

    /**
     * Imports an OpenAPI definition from a local file.
     *
     * This component is optional and therefore the API will only work if it is installed
     */
    public ApiResponse importFile(String file, String target, String contextid)
            throws ClientApiException {
        Map map = new HashMap<>();
        map.put("file", file);
        if (target != null) {
            map.put("target", target);
        }
        if (contextid != null) {
            map.put("contextId", contextid);
        }
        return api.callApi("openapi", "action", "importFile", map);
    }

    /**
     * Imports an OpenAPI definition from a URL.
     *
     * This component is optional and therefore the API will only work if it is installed
     */
    public ApiResponse importUrl(String url, String hostoverride, String contextid)
            throws ClientApiException {
        Map map = new HashMap<>();
        map.put("url", url);
        if (hostoverride != null) {
            map.put("hostOverride", hostoverride);
        }
        if (contextid != null) {
            map.put("contextId", contextid);
        }
        return api.callApi("openapi", "action", "importUrl", map);
    }
}