Class OpenAPIRequestCookie


  • public class OpenAPIRequestCookie
    extends Object
    Used to store operation details based off of the Http Method and Chosen Operation path. This cookie will be used so that the in memory API will not need to be reloaded.
    • Method Detail

      • getHeaderParameters

        public List<OpenAPIParameter> getHeaderParameters()
        Fetches header parameters identified as "in": "header" from OpenAPIRequestCookie. These parameters are stored during browse operation.
        Returns:
        the header OpenApiParameter List
      • setHeaderParameters

        public void setHeaderParameters​(List<OpenAPIParameter> headerParameters)
      • getQueryParameters

        public List<OpenAPIParameter> getQueryParameters()
        Fetches query parameters identified as "in": "query" from OpenAPIRequestCookie. These parameters are stored during browse operation.
        Returns:
        the query OpenApiParameter List
      • getPathParameters

        public List<OpenAPIParameter> getPathParameters()
        Fetches path parameters identified as "in": "path" from OpenAPIRequestCookie. These parameters are stored during browse operation.
        Returns:
        the path OpenApiParameter List
      • isRequestBodyRequired

        public boolean isRequestBodyRequired()
        Fetches value of "required" attribute from request body stored in OpenAPIRequestCookie during browse operation.
        Returns:
        true if the RequestBody is required, false otherwise
      • setRequestBodyRequired

        public void setRequestBodyRequired​(boolean requestBodyRequired)
      • getRequestContentType

        public String getRequestContentType()
        Fetches the content type associated with this operation. At the moment, this will always select the first content type available in a set of multiple content types.
        Returns:
        the requestContentType
      • setRequestContentType

        public void setRequestContentType​(String requestContentType)
      • getRootSchemaType

        public String getRootSchemaType()
        Gets the root schema type for the request. In OpenAPI, this can be structured as object or array. It can also be a primitive data type such as a number or a string.
        Returns:
        the root level schema type
      • setRootSchemaType

        public void setRootSchemaType​(String rootSchemaType)