com.networknt.oas.model.Operation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openapi-parser Show documentation
A light-weight, fast OpenAPI 3.0 parser and validator
There is a newer version: 2.1.36
/*******************************************************************************
 *  Copyright (c) 2017 ModelSolv, Inc. and others.
 *  All rights reserved. This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License v1.0
 *  which accompanies this distribution, and is available at
 *  http://www.eclipse.org/legal/epl-v10.html
 *
 *  Contributors:
 *     ModelSolv, Inc. - initial API and implementation and/or initial documentation
 *******************************************************************************/
package com.networknt.oas.model;

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

import com.networknt.jsonoverlay.IJsonOverlay;
import com.networknt.jsonoverlay.IModelPart;

public interface Operation extends IJsonOverlay, IModelPart {

	// Tag
	List getTags();

	List getTags(boolean elaborate);

	boolean hasTags();

	String getTag(int index);

	void setTags(List tags);

	void setTag(int index, String tag);

	void addTag(String tag);

	void insertTag(int index, String tag);

	void removeTag(int index);

	// Summary
	String getSummary();

	void setSummary(String summary);

	// Description
	String getDescription();

	void setDescription(String description);

	// ExternalDocs
	ExternalDocs getExternalDocs();

	ExternalDocs getExternalDocs(boolean elaborate);

	void setExternalDocs(ExternalDocs externalDocs);

	// OperationId
	String getOperationId();

	void setOperationId(String operationId);

	// Parameter
	List getParameters();

	List getParameters(boolean elaborate);

	boolean hasParameters();

	Parameter getParameter(int index);

	void setParameters(List parameters);

	void setParameter(int index, Parameter parameter);

	void addParameter(Parameter parameter);

	void insertParameter(int index, Parameter parameter);

	void removeParameter(int index);

	// RequestBody
	RequestBody getRequestBody();

	RequestBody getRequestBody(boolean elaborate);

	void setRequestBody(RequestBody requestBody);

	// Response
	Map getResponses();

	Map getResponses(boolean elaborate);

	boolean hasResponses();

	boolean hasResponse(String name);

	Response getResponse(String name);

	void setResponses(Map responses);

	void setResponse(String name, Response response);

	void removeResponse(String name);

	// ResponsesExtension
	Map getResponsesExtensions();

	Map getResponsesExtensions(boolean elaborate);

	boolean hasResponsesExtensions();

	boolean hasResponsesExtension(String name);

	Object getResponsesExtension(String name);

	void setResponsesExtensions(Map responsesExtensions);

	void setResponsesExtension(String name, Object responsesExtension);

	void removeResponsesExtension(String name);

	// Callback
	Map getCallbacks();

	Map getCallbacks(boolean elaborate);

	boolean hasCallbacks();

	boolean hasCallback(String name);

	Callback getCallback(String name);

	void setCallbacks(Map callbacks);

	void setCallback(String name, Callback callback);

	void removeCallback(String name);

	// CallbacksExtension
	Map getCallbacksExtensions();

	Map getCallbacksExtensions(boolean elaborate);

	boolean hasCallbacksExtensions();

	boolean hasCallbacksExtension(String name);

	Object getCallbacksExtension(String name);

	void setCallbacksExtensions(Map callbacksExtensions);

	void setCallbacksExtension(String name, Object callbacksExtension);

	void removeCallbacksExtension(String name);

	// Deprecated
	Boolean getDeprecated();

	boolean isDeprecated();

	void setDeprecated(Boolean deprecated);

	// SecurityRequirement
	List getSecurityRequirements();

	List getSecurityRequirements(boolean elaborate);

	boolean hasSecurityRequirements();

	SecurityRequirement getSecurityRequirement(int index);

	void setSecurityRequirements(List securityRequirements);

	void setSecurityRequirement(int index, SecurityRequirement securityRequirement);

	void addSecurityRequirement(SecurityRequirement securityRequirement);

	void insertSecurityRequirement(int index, SecurityRequirement securityRequirement);

	void removeSecurityRequirement(int index);

	// Server
	List getServers();

	List getServers(boolean elaborate);

	boolean hasServers();

	Server getServer(int index);

	void setServers(List servers);

	void setServer(int index, Server server);

	void addServer(Server server);

	void insertServer(int index, Server server);

	void removeServer(int index);

	// Extension
	Map getExtensions();

	Map getExtensions(boolean elaborate);

	boolean hasExtensions();

	boolean hasExtension(String name);

	Object getExtension(String name);

	void setExtensions(Map extensions);

	void setExtension(String name, Object extension);

	void removeExtension(String name);
}