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

import com.networknt.oas.jsonoverlay.Reference;

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

public interface Operation extends OpenApiObject {

    // Tag

    Collection getTags();


    Collection getTags(boolean elaborate);


    boolean hasTags();


    String getTag(int index);


    void setTags(Collection tags);


    void setTag(int index, String tag);


    void addTag(String tag);


    void insertTag(int index, String tag);


    void removeTag(int index);

    // Summary

    String getSummary();


    String getSummary(boolean elaborate);


    void setSummary(String summary);

    // Description

    String getDescription();


    String getDescription(boolean elaborate);


    void setDescription(String description);

    // ExternalDocs

    ExternalDocs getExternalDocs();


    ExternalDocs getExternalDocs(boolean elaborate);


    void setExternalDocs(ExternalDocs externalDocs);

    // OperationId

    String getOperationId();


    String getOperationId(boolean elaborate);


    void setOperationId(String operationId);

    // Parameter

    Collection getParameters();


    Collection getParameters(boolean elaborate);


    boolean hasParameters();


    Parameter getParameter(int index);


    void setParameters(Collection parameters);


    void setParameter(int index, Parameter parameter);


    void addParameter(Parameter parameter);


    void insertParameter(int index, Parameter parameter);


    void removeParameter(int index);


    boolean isParameterReference(int index);


    Reference getParameterReference(int index);

    // RequestBody

    RequestBody getRequestBody();


    RequestBody getRequestBody(boolean elaborate);


    void setRequestBody(RequestBody requestBody);


    boolean isRequestBodyReference();


    Reference getRequestBodyReference();

    // 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);

    // ResponsesExtension

    Map getResponsesExtensions();


    Map getResponsesExtensions(boolean elaborate);


    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 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);

    // CallbacksExtension

    Map getCallbacksExtensions();


    Map getCallbacksExtensions(boolean elaborate);


    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 getDeprecated(boolean elaborate);


    boolean isDeprecated();


    void setDeprecated(Boolean deprecated);

    // 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);

    // 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);

    // 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);

}