com.networknt.oas.model.OpenApi3 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.38
package com.networknt.oas.model;

import com.networknt.oas.OpenApi;
import com.networknt.oas.jsonoverlay.Reference;
import com.networknt.oas.validator.ValidationResults;

import java.util.Collection;
import java.util.Map;

public interface OpenApi3 extends OpenApiObject, OpenApi {

    public void validate();

    public boolean isValid();

    public ValidationResults getValidationResults();

    public Collection getValidationItems();

    // OpenApi

    String getOpenApi();


    String getOpenApi(boolean elaborate);


    void setOpenApi(String openApi);

    // Info

    Info getInfo();


    Info getInfo(boolean elaborate);


    void setInfo(Info info);

    // Server

    Collection getServers();


    Collection getServers(boolean elaborate);


    boolean hasServers();


    Server getServer(int index);


    void setServers(Collection servers);


    void setServer(int index, Server server);


    void addServer(Server server);


    void insertServer(int index, Server server);


    void removeServer(int index);

    // Path

    Map getPaths();


    Map getPaths(boolean elaborate);


    boolean hasPath(String name);


    Path getPath(String name);


    void setPaths(Map paths);


    void setPath(String name, Path path);


    void removePath(String name);


    boolean isPathReference(String key);


    Reference getPathReference(String key);

    // PathsExtension

    Map getPathsExtensions();


    Map getPathsExtensions(boolean elaborate);


    boolean hasPathsExtension(String name);


    Object getPathsExtension(String name);


    void setPathsExtensions(Map pathsExtensions);


    void setPathsExtension(String name, Object pathsExtension);


    void removePathsExtension(String name);

    // Schema

    Map getSchemas();


    Map getSchemas(boolean elaborate);


    boolean hasSchema(String name);


    Schema getSchema(String name);


    void setSchemas(Map schemas);


    void setSchema(String name, Schema schema);


    void removeSchema(String name);


    boolean isSchemaReference(String key);


    Reference getSchemaReference(String key);

    // Response

    Map getResponses();


    Map getResponses(boolean elaborate);


    boolean hasResponse(String name);


    Response getResponse(String name);


    void setResponses(Map responses);


    void setResponse(String name, Response response);


    void removeResponse(String name);


    boolean isResponseReference(String key);


    Reference getResponseReference(String key);

    // Parameter

    Map getParameters();


    Map getParameters(boolean elaborate);


    boolean hasParameter(String name);


    Parameter getParameter(String name);


    void setParameters(Map parameters);


    void setParameter(String name, Parameter parameter);


    void removeParameter(String name);


    boolean isParameterReference(String key);


    Reference getParameterReference(String key);

    // Example

    Map getExamples();


    Map getExamples(boolean elaborate);


    boolean hasExample(String name);


    Example getExample(String name);


    void setExamples(Map examples);


    void setExample(String name, Example example);


    void removeExample(String name);


    boolean isExampleReference(String key);


    Reference getExampleReference(String key);

    // RequestBody

    Map getRequestBodies();


    Map getRequestBodies(boolean elaborate);


    boolean hasRequestBody(String name);


    RequestBody getRequestBody(String name);


    void setRequestBodies(Map requestBodies);


    void setRequestBody(String name, RequestBody requestBody);


    void removeRequestBody(String name);


    boolean isRequestBodyReference(String key);


    Reference getRequestBodyReference(String key);

    // Header

    Map getHeaders();


    Map getHeaders(boolean elaborate);


    boolean hasHeader(String name);


    Header getHeader(String name);


    void setHeaders(Map headers);


    void setHeader(String name, Header header);


    void removeHeader(String name);


    boolean isHeaderReference(String key);


    Reference getHeaderReference(String key);

    // SecurityScheme

    Map getSecuritySchemes();


    Map getSecuritySchemes(boolean elaborate);


    boolean hasSecurityScheme(String name);


    SecurityScheme getSecurityScheme(String name);


    void setSecuritySchemes(Map securitySchemes);


    void setSecurityScheme(String name, SecurityScheme securityScheme);


    void removeSecurityScheme(String name);


    boolean isSecuritySchemeReference(String key);


    Reference getSecuritySchemeReference(String key);

    // Link

    Map getLinks();


    Map getLinks(boolean elaborate);


    boolean hasLink(String name);


    Link getLink(String name);


    void setLinks(Map links);


    void setLink(String name, Link link);


    void removeLink(String name);


    boolean isLinkReference(String key);


    Reference getLinkReference(String key);

    // Callback

    Map getCallbacks();


    Map getCallbacks(boolean elaborate);


    boolean hasCallback(String name);


    Callback getCallback(String name);


    void setCallbacks(Map callbacks);


    void setCallback(String name, Callback callback);


    void removeCallback(String name);


    boolean isCallbackReference(String key);


    Reference getCallbackReference(String key);

    // ComponentsExtension

    Map getComponentsExtensions();


    Map getComponentsExtensions(boolean elaborate);


    boolean hasComponentsExtension(String name);


    Object getComponentsExtension(String name);


    void setComponentsExtensions(Map componentsExtensions);


    void setComponentsExtension(String name, Object componentsExtension);


    void removeComponentsExtension(String name);

    // SecurityRequirement

    Collection getSecurityRequirements();


    Collection getSecurityRequirements(boolean elaborate);


    boolean hasSecurityRequirements();


    SecurityRequirement getSecurityRequirement(int index);


    void setSecurityRequirements(Collection securityRequirements);


    void setSecurityRequirement(int index, SecurityRequirement securityRequirement);


    void addSecurityRequirement(SecurityRequirement securityRequirement);


    void insertSecurityRequirement(int index, SecurityRequirement securityRequirement);


    void removeSecurityRequirement(int index);

    // Tag

    Collection getTags();


    Collection getTags(boolean elaborate);


    boolean hasTags();


    Tag getTag(int index);


    void setTags(Collection tags);


    void setTag(int index, Tag tag);


    void addTag(Tag tag);


    void insertTag(int index, Tag tag);


    void removeTag(int index);

    // ExternalDocs

    ExternalDocs getExternalDocs();


    ExternalDocs getExternalDocs(boolean elaborate);


    void setExternalDocs(ExternalDocs externalDocs);

    // Extension

    Map getExtensions();


    Map getExtensions(boolean elaborate);


    boolean hasExtension(String name);


    Object getExtension(String name);


    void setExtensions(Map extensions);


    void setExtension(String name, Object extension);


    void removeExtension(String name);

}