• Home
• com.networknt
• openapi-parser
• 2.0.1
• source code
• OpenApi3.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

/*******************************************************************************
 *  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.Collection;
import java.util.List;
import java.util.Map;

import javax.annotation.Generated;

import com.networknt.jsonoverlay.IJsonOverlay;
import com.networknt.jsonoverlay.IModelPart;
import com.networknt.oas.OpenApi;
import com.networknt.oas.validator.ValidationResults;

public interface OpenApi3 extends IJsonOverlay, IModelPart, OpenApi {

	public void validate();

	public boolean isValid();

	public ValidationResults getValidationResults();

	public Collection getValidationItems();

	// OpenApi
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	String getOpenApi();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setOpenApi(String openApi);

	// Info
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Info getInfo();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Info getInfo(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setInfo(Info info);

	// Server
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	List getServers();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	List getServers(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasServers();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Server getServer(int index);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setServers(List servers);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setServer(int index, Server server);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void addServer(Server server);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void insertServer(int index, Server server);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void removeServer(int index);

	// Path
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getPaths();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getPaths(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasPaths();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasPath(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Path getPath(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setPaths(Map paths);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setPath(String name, Path path);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void removePath(String name);

	// PathsExtension
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getPathsExtensions();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getPathsExtensions(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasPathsExtensions();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasPathsExtension(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Object getPathsExtension(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setPathsExtensions(Map pathsExtensions);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setPathsExtension(String name, Object pathsExtension);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void removePathsExtension(String name);

	// Schema
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getSchemas();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getSchemas(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasSchemas();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasSchema(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Schema getSchema(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setSchemas(Map schemas);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setSchema(String name, Schema schema);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void removeSchema(String name);

	// Response
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getResponses();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getResponses(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasResponses();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasResponse(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Response getResponse(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setResponses(Map responses);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setResponse(String name, Response response);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void removeResponse(String name);

	// Parameter
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getParameters();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getParameters(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasParameters();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasParameter(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Parameter getParameter(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setParameters(Map parameters);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setParameter(String name, Parameter parameter);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void removeParameter(String name);

	// Example
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getExamples();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getExamples(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasExamples();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasExample(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Example getExample(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setExamples(Map examples);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setExample(String name, Example example);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void removeExample(String name);

	// RequestBody
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getRequestBodies();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getRequestBodies(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasRequestBodies();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasRequestBody(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	RequestBody getRequestBody(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setRequestBodies(Map requestBodies);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setRequestBody(String name, RequestBody requestBody);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void removeRequestBody(String name);

	// Header
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getHeaders();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getHeaders(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasHeaders();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasHeader(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Header getHeader(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setHeaders(Map headers);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setHeader(String name, Header header);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void removeHeader(String name);

	// SecurityScheme
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getSecuritySchemes();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getSecuritySchemes(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasSecuritySchemes();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasSecurityScheme(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	SecurityScheme getSecurityScheme(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setSecuritySchemes(Map securitySchemes);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setSecurityScheme(String name, SecurityScheme securityScheme);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void removeSecurityScheme(String name);

	// Link
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getLinks();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getLinks(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasLinks();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasLink(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Link getLink(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setLinks(Map links);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setLink(String name, Link link);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void removeLink(String name);

	// Callback
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getCallbacks();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getCallbacks(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasCallbacks();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasCallback(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Callback getCallback(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setCallbacks(Map callbacks);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setCallback(String name, Callback callback);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void removeCallback(String name);

	// ComponentsExtension
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getComponentsExtensions();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getComponentsExtensions(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasComponentsExtensions();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasComponentsExtension(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Object getComponentsExtension(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setComponentsExtensions(Map componentsExtensions);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setComponentsExtension(String name, Object componentsExtension);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void removeComponentsExtension(String name);

	// SecurityRequirement
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	List getSecurityRequirements();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	List getSecurityRequirements(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasSecurityRequirements();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	SecurityRequirement getSecurityRequirement(int index);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setSecurityRequirements(List securityRequirements);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setSecurityRequirement(int index, SecurityRequirement securityRequirement);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void addSecurityRequirement(SecurityRequirement securityRequirement);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void insertSecurityRequirement(int index, SecurityRequirement securityRequirement);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void removeSecurityRequirement(int index);

	// Tag
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	List getTags();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	List getTags(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasTags();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Tag getTag(int index);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setTags(List tags);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setTag(int index, Tag tag);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void addTag(Tag tag);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void insertTag(int index, Tag tag);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void removeTag(int index);

	// ExternalDocs
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	ExternalDocs getExternalDocs();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	ExternalDocs getExternalDocs(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setExternalDocs(ExternalDocs externalDocs);

	// Extension
	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getExtensions();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Map getExtensions(boolean elaborate);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasExtensions();

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	boolean hasExtension(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	Object getExtension(String name);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setExtensions(Map extensions);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void setExtension(String name, Object extension);

	@Generated("com.reprezen.jsonoverlay.gen.CodeGenerator")
	void removeExtension(String name);
}