Package com.networknt.oas.model

Interface Operation

  • All Superinterfaces:
    com.networknt.jsonoverlay.IJsonOverlay<Operation>, com.networknt.jsonoverlay.IModelPart<OpenApi3,​Operation>
    All Known Implementing Classes:
    OperationImpl
    public interface Operation
extends com.networknt.jsonoverlay.IJsonOverlay<Operation>, com.networknt.jsonoverlay.IModelPart<OpenApi3,​Operation>

    • Method Detail

      • getTags

        List<String> getTags​(boolean elaborate)

      • hasTags

        boolean hasTags()

      • getTag

        String getTag​(int index)

      • setTag

        void setTag​(int index,
            String tag)

      • addTag

        void addTag​(String tag)

      • insertTag

        void insertTag​(int index,
               String tag)

      • removeTag

        void removeTag​(int index)

      • getSummary

        String getSummary()

      • setSummary

        void setSummary​(String summary)

      • getDescription

        String getDescription()

      • setDescription

        void setDescription​(String description)

      • getExternalDocs

        ExternalDocs getExternalDocs​(boolean elaborate)

      • setExternalDocs

        void setExternalDocs​(ExternalDocs externalDocs)

      • getOperationId

        String getOperationId()

      • setOperationId

        void setOperationId​(String operationId)

      • getParameters

        List<Parameter> getParameters​(boolean elaborate)

      • hasParameters

        boolean hasParameters()

      • getParameter

        Parameter getParameter​(int index)

      • setParameters

        void setParameters​(List<Parameter> parameters)

      • setParameter

        void setParameter​(int index,
                  Parameter parameter)

      • addParameter

        void addParameter​(Parameter parameter)

      • insertParameter

        void insertParameter​(int index,
                     Parameter parameter)

      • removeParameter

        void removeParameter​(int index)

      • getRequestBody

        RequestBody getRequestBody​(boolean elaborate)

      • setRequestBody

        void setRequestBody​(RequestBody requestBody)

      • hasResponses

        boolean hasResponses()

      • hasResponse

        boolean hasResponse​(String name)

      • removeResponse

        void removeResponse​(String name)

      • getResponsesExtensions

        Map<String,​Object> getResponsesExtensions​(boolean elaborate)

      • hasResponsesExtensions

        boolean hasResponsesExtensions()

      • hasResponsesExtension

        boolean hasResponsesExtension​(String name)

      • getResponsesExtension

        Object getResponsesExtension​(String name)

      • setResponsesExtensions

        void setResponsesExtensions​(Map<String,​Object> responsesExtensions)

      • setResponsesExtension

        void setResponsesExtension​(String name,
                           Object responsesExtension)

      • removeResponsesExtension

        void removeResponsesExtension​(String name)

      • hasCallbacks

        boolean hasCallbacks()

      • hasCallback

        boolean hasCallback​(String name)

      • removeCallback

        void removeCallback​(String name)

      • getCallbacksExtensions

        Map<String,​Object> getCallbacksExtensions​(boolean elaborate)

      • hasCallbacksExtensions

        boolean hasCallbacksExtensions()

      • hasCallbacksExtension

        boolean hasCallbacksExtension​(String name)

      • getCallbacksExtension

        Object getCallbacksExtension​(String name)

      • setCallbacksExtensions

        void setCallbacksExtensions​(Map<String,​Object> callbacksExtensions)

      • setCallbacksExtension

        void setCallbacksExtension​(String name,
                           Object callbacksExtension)

      • removeCallbacksExtension

        void removeCallbacksExtension​(String name)

      • getDeprecated

        Boolean getDeprecated()

      • isDeprecated

        boolean isDeprecated()

      • setDeprecated

        void setDeprecated​(Boolean deprecated)

      • hasSecurityRequirements

        boolean hasSecurityRequirements()

      • setSecurityRequirement

        void setSecurityRequirement​(int index,
                            SecurityRequirement securityRequirement)

      • addSecurityRequirement

        void addSecurityRequirement​(SecurityRequirement securityRequirement)

      • insertSecurityRequirement

        void insertSecurityRequirement​(int index,
                               SecurityRequirement securityRequirement)

      • removeSecurityRequirement

        void removeSecurityRequirement​(int index)

      • getServers

        List<Server> getServers​(boolean elaborate)

      • hasServers

        boolean hasServers()

      • getServer

        Server getServer​(int index)

      • setServers

        void setServers​(List<Server> servers)

      • setServer

        void setServer​(int index,
               Server server)

      • addServer

        void addServer​(Server server)

      • insertServer

        void insertServer​(int index,
                  Server server)

      • removeServer

        void removeServer​(int index)

      • getExtensions

        Map<String,​Object> getExtensions​(boolean elaborate)

      • hasExtensions

        boolean hasExtensions()

      • hasExtension

        boolean hasExtension​(String name)

      • setExtension

        void setExtension​(String name,
                  Object extension)

      • removeExtension

        void removeExtension​(String name)