Package io.jpostman.schema.model

Class ApiOperation

  • public class ApiOperation
extends Object
    Represents one normalized API operation parsed from OpenAPI, Swagger, Postman, or GraphQL.

    • Constructor Detail

      • ApiOperation

        public ApiOperation()

    • Method Detail

      • getFolder

        public String getFolder()
        Returns the folder.

      • setFolder

        public void setFolder​(String folder)
        Sets the folder.

      • getName

        public String getName()
        Returns the display name.

      • setName

        public void setName​(String name)
        Sets the display name.

      • getMethodName

        public String getMethodName()
        Returns the method name.

      • setMethodName

        public void setMethodName​(String methodName)
        Sets the method name.

      • getDescription

        public String getDescription()
        Returns the description.

      • setDescription

        public void setDescription​(String description)
        Sets the description.

      • getMethod

        public String getMethod()
        Returns the method.

      • setMethod

        public void setMethod​(String method)
        Sets the method.

      • getAllowedMethods

        public List<String> getAllowedMethods()
        Returns the allowed methods.

      • setAllowedMethods

        public void setAllowedMethods​(List<String> allowedMethods)
        Sets the allowed methods.

      • getPath

        public String getPath()
        Returns the path.

      • setPath

        public void setPath​(String path)
        Sets the path.

      • getQueryParams

        public List<ApiParam> getQueryParams()
        Returns the query params.

      • setQueryParams

        public void setQueryParams​(List<ApiParam> queryParams)
        Sets the query params.

      • getHeaders

        public List<ApiHeader> getHeaders()
        Returns the headers.

      • setHeaders

        public void setHeaders​(List<ApiHeader> headers)
        Sets the headers.

      • getBody

        public ApiBody getBody()
        Returns the body.

      • setBody

        public void setBody​(ApiBody body)
        Sets the body.

      • getAuth

        public ApiAuth getAuth()
        Returns the auth.

      • setAuth

        public void setAuth​(ApiAuth auth)
        Sets the auth.

      • getExample

        public ApiExample getExample()
        Returns the example.

      • setExample

        public void setExample​(ApiExample example)
        Sets the example.

      • getResponses

        public List<ApiResponse> getResponses()
        Returns the responses.

      • setResponses

        public void setResponses​(List<ApiResponse> responses)
        Sets the responses.

      • getProtocol

        public ApiProtocol getProtocol()
        Returns the protocol.

      • setProtocol

        public void setProtocol​(ApiProtocol protocol)
        Sets the protocol.

      • getGraphQlOperationType

        public String getGraphQlOperationType()
        Returns the graph ql operation type.

      • setGraphQlOperationType

        public void setGraphQlOperationType​(String graphQlOperationType)
        Sets the graph ql operation type.

      • isUrlResolved

        public boolean isUrlResolved()
        Returns whether url resolved is enabled or true.

      • setUrlResolved

        public void setUrlResolved​(boolean urlResolved)
        Sets the url resolved.