robotframework-openapitools 0.4.0__py3-none-any.whl → 1.0.0b1__py3-none-any.whl

OpenApiLibCore/openapi_libcore.py

@@ -75,7 +75,7 @@ recursion in them. See the `recursion_limit` and `recursion_default` parameters.
 
 If the openapi document passes this validation, the next step is trying to do a test
 run with a minimal test suite.
-The example below can be used, with `source`, `origin` and 'endpoint' altered to
+The example below can be used, with `source`, `origin` and `path` altered to
 fit your situation.
 
 ``` robotframework
@@ -86,7 +86,7 @@ Library            OpenApiLibCore
 
 *** Test Cases ***
 Getting Started
-    ${url}=    Get Valid Url    endpoint=/employees/{employee_id}   method=get
+    ${url}=    Get Valid Url    path=/employees/{employee_id}
 
 ```
 
@@ -119,342 +119,59 @@ data types and properties. The following list details the most important ones:
 """
 
 import json as _json
-import re
 import sys
+from collections.abc import Mapping, MutableMapping
 from copy import deepcopy
-from dataclasses import Field, dataclass, field, make_dataclass
-from enum import Enum
 from functools import cached_property
-from itertools import zip_longest
-from logging import getLogger
 from pathlib import Path
-from random import choice, sample
-from typing import (
-    Any,
-    Callable,
-    Dict,
-    Generator,
-    List,
-    Optional,
-    Set,
-    Tuple,
-    Type,
-    Union,
-)
-from uuid import uuid4
+from types import MappingProxyType
+from typing import Any, Generator
 
 from openapi_core import Config, OpenAPI, Spec
 from openapi_core.contrib.requests import (
     RequestsOpenAPIRequest,
     RequestsOpenAPIResponse,
 )
-from openapi_core.exceptions import OpenAPIError
-from openapi_core.templating.paths.exceptions import ServerNotFound
 from openapi_core.validation.exceptions import ValidationError
-from openapi_core.validation.response.exceptions import ResponseValidationError
-from openapi_core.validation.schemas.exceptions import InvalidSchemaValue
 from prance import ResolvingParser
 from prance.util.url import ResolutionError
 from requests import Response, Session
 from requests.auth import AuthBase, HTTPBasicAuth
 from requests.cookies import RequestsCookieJar as CookieJar
+from robot.api import logger
 from robot.api.deco import keyword, library
-from robot.api.exceptions import Failure
+from robot.api.exceptions import FatalError
 from robot.libraries.BuiltIn import BuiltIn
 
-from OpenApiLibCore import value_utils
-from OpenApiLibCore.dto_base import (
-    NOT_SET,
-    Dto,
-    IdDependency,
-    IdReference,
-    PathPropertiesConstraint,
-    PropertyValueConstraint,
-    Relation,
-    UniquePropertyValueConstraint,
-    resolve_schema,
-)
+import OpenApiLibCore.data_generation as _data_generation
+import OpenApiLibCore.data_invalidation as di
+import OpenApiLibCore.path_functions as pf
+import OpenApiLibCore.path_invalidation as pi
+import OpenApiLibCore.resource_relations as rr
+import OpenApiLibCore.validation as val
+from OpenApiLibCore.annotations import JSON
+from OpenApiLibCore.dto_base import Dto, IdReference
 from OpenApiLibCore.dto_utils import (
     DEFAULT_ID_PROPERTY_NAME,
-    DefaultDto,
     get_dto_class,
     get_id_property_name,
 )
-from OpenApiLibCore.oas_cache import PARSER_CACHE
-from OpenApiLibCore.value_utils import FAKE, IGNORE, JSON
+from OpenApiLibCore.oas_cache import PARSER_CACHE, CachedParser
+from OpenApiLibCore.parameter_utils import (
+    get_oas_name_from_safe_name,
+    register_path_parameters,
+)
+from OpenApiLibCore.protocols import ResponseValidatorType
+from OpenApiLibCore.request_data import RequestData, RequestValues
+from OpenApiLibCore.value_utils import FAKE
 
 run_keyword = BuiltIn().run_keyword
-
-logger = getLogger(__name__)
-
-
-class ValidationLevel(str, Enum):
-    """The available levels for the response_validation parameter."""
-
-    DISABLED = "DISABLED"
-    INFO = "INFO"
-    WARN = "WARN"
-    STRICT = "STRICT"
-
-
-def get_safe_key(key: str) -> str:
-    """
-    Helper function to convert a valid JSON property name to a string that can be used
-    as a Python variable or function / method name.
-    """
-    key = key.replace("-", "_")
-    key = key.replace("@", "_")
-    if key[0].isdigit():
-        key = f"_{key}"
-    return key
-
-
-@dataclass
-class RequestValues:
-    """Helper class to hold parameter values needed to make a request."""
-
-    url: str
-    method: str
-    params: Optional[Dict[str, Any]]
-    headers: Optional[Dict[str, str]]
-    json_data: Optional[Dict[str, Any]]
-
-
-@dataclass
-class RequestData:
-    """Helper class to manage parameters used when making requests."""
-
-    dto: Union[Dto, DefaultDto] = field(default_factory=DefaultDto)
-    dto_schema: Dict[str, Any] = field(default_factory=dict)
-    parameters: List[Dict[str, Any]] = field(default_factory=list)
-    params: Dict[str, Any] = field(default_factory=dict)
-    headers: Dict[str, Any] = field(default_factory=dict)
-    has_body: bool = True
-
-    def __post_init__(self) -> None:
-        # prevent modification by reference
-        self.dto_schema = deepcopy(self.dto_schema)
-        self.parameters = deepcopy(self.parameters)
-        self.params = deepcopy(self.params)
-        self.headers = deepcopy(self.headers)
-
-    @property
-    def has_optional_properties(self) -> bool:
-        """Whether or not the dto data (json data) contains optional properties."""
-
-        def is_required_property(property_name: str) -> bool:
-            return property_name in self.dto_schema.get("required", [])
-
-        properties = (self.dto.as_dict()).keys()
-        return not all(map(is_required_property, properties))
-
-    @property
-    def has_optional_params(self) -> bool:
-        """Whether or not any of the query parameters are optional."""
-
-        def is_optional_param(query_param: str) -> bool:
-            optional_params = [
-                p.get("name")
-                for p in self.parameters
-                if p.get("in") == "query" and not p.get("required")
-            ]
-            return query_param in optional_params
-
-        return any(map(is_optional_param, self.params))
-
-    @cached_property
-    def params_that_can_be_invalidated(self) -> Set[str]:
-        """
-        The query parameters that can be invalidated by violating data
-        restrictions, data type or by not providing them in a request.
-        """
-        result = set()
-        params = [h for h in self.parameters if h.get("in") == "query"]
-        for param in params:
-            # required params can be omitted to invalidate a request
-            if param["required"]:
-                result.add(param["name"])
-                continue
-
-            schema = resolve_schema(param["schema"])
-            if schema.get("type", None):
-                param_types = [schema]
-            else:
-                param_types = schema["types"]
-            for param_type in param_types:
-                # any basic non-string type except "null" can be invalidated by
-                # replacing it with a string
-                if param_type["type"] not in ["string", "array", "object", "null"]:
-                    result.add(param["name"])
-                    continue
-                # enums, strings and arrays with boundaries can be invalidated
-                if set(param_type.keys()).intersection(
-                    {
-                        "enum",
-                        "minLength",
-                        "maxLength",
-                        "minItems",
-                        "maxItems",
-                    }
-                ):
-                    result.add(param["name"])
-                    continue
-                # an array of basic non-string type can be invalidated by replacing the
-                # items in the array with strings
-                if param_type["type"] == "array" and param_type["items"][
-                    "type"
-                ] not in [
-                    "string",
-                    "array",
-                    "object",
-                    "null",
-                ]:
-                    result.add(param["name"])
-        return result
-
-    @property
-    def has_optional_headers(self) -> bool:
-        """Whether or not any of the headers are optional."""
-
-        def is_optional_header(header: str) -> bool:
-            optional_headers = [
-                p.get("name")
-                for p in self.parameters
-                if p.get("in") == "header" and not p.get("required")
-            ]
-            return header in optional_headers
-
-        return any(map(is_optional_header, self.headers))
-
-    @cached_property
-    def headers_that_can_be_invalidated(self) -> Set[str]:
-        """
-        The header parameters that can be invalidated by violating data
-        restrictions or by not providing them in a request.
-        """
-        result = set()
-        headers = [h for h in self.parameters if h.get("in") == "header"]
-        for header in headers:
-            # required headers can be omitted to invalidate a request
-            if header["required"]:
-                result.add(header["name"])
-                continue
-
-            schema = resolve_schema(header["schema"])
-            if schema.get("type", None):
-                header_types = [schema]
-            else:
-                header_types = schema["types"]
-            for header_type in header_types:
-                # any basic non-string type except "null" can be invalidated by
-                # replacing it with a string
-                if header_type["type"] not in ["string", "array", "object", "null"]:
-                    result.add(header["name"])
-                    continue
-                # enums, strings and arrays with boundaries can be invalidated
-                if set(header_type.keys()).intersection(
-                    {
-                        "enum",
-                        "minLength",
-                        "maxLength",
-                        "minItems",
-                        "maxItems",
-                    }
-                ):
-                    result.add(header["name"])
-                    continue
-                # an array of basic non-string type can be invalidated by replacing the
-                # items in the array with strings
-                if header_type["type"] == "array" and header_type["items"][
-                    "type"
-                ] not in [
-                    "string",
-                    "array",
-                    "object",
-                    "null",
-                ]:
-                    result.add(header["name"])
-        return result
-
-    def get_required_properties_dict(self) -> Dict[str, Any]:
-        """Get the json-compatible dto data containing only the required properties."""
-        relations = self.dto.get_relations()
-        mandatory_properties = [
-            relation.property_name
-            for relation in relations
-            if getattr(relation, "treat_as_mandatory", False)
-        ]
-        required_properties: List[str] = self.dto_schema.get("required", [])
-        required_properties.extend(mandatory_properties)
-
-        required_properties_dict: Dict[str, Any] = {}
-        for key, value in (self.dto.as_dict()).items():
-            if key in required_properties:
-                required_properties_dict[key] = value
-        return required_properties_dict
-
-    def get_minimal_body_dict(self) -> Dict[str, Any]:
-        required_properties_dict = self.get_required_properties_dict()
-
-        min_properties = self.dto_schema.get("minProperties", 0)
-        number_of_optional_properties_to_add = min_properties - len(
-            required_properties_dict
-        )
-
-        if number_of_optional_properties_to_add < 1:
-            return required_properties_dict
-
-        optional_properties_dict = {
-            k: v
-            for k, v in self.dto.as_dict().items()
-            if k not in required_properties_dict
-        }
-        optional_properties_to_keep = sample(
-            sorted(optional_properties_dict), number_of_optional_properties_to_add
-        )
-        optional_properties_dict = {
-            k: v
-            for k, v in optional_properties_dict.items()
-            if k in optional_properties_to_keep
-        }
-
-        return {**required_properties_dict, **optional_properties_dict}
-
-    def get_required_params(self) -> Dict[str, str]:
-        """Get the params dict containing only the required query parameters."""
-        relations = self.dto.get_parameter_relations()
-        mandatory_properties = [
-            relation.property_name
-            for relation in relations
-            if getattr(relation, "treat_as_mandatory", False)
-        ]
-        mandatory_parameters = [p for p in mandatory_properties if p in self.parameters]
-
-        required_parameters = [
-            p.get("name") for p in self.parameters if p.get("required")
-        ]
-        required_parameters.extend(mandatory_parameters)
-        return {k: v for k, v in self.params.items() if k in required_parameters}
-
-    def get_required_headers(self) -> Dict[str, str]:
-        """Get the headers dict containing only the required headers."""
-        relations = self.dto.get_parameter_relations()
-        mandatory_properties = [
-            relation.property_name
-            for relation in relations
-            if getattr(relation, "treat_as_mandatory", False)
-        ]
-        mandatory_parameters = [p for p in mandatory_properties if p in self.parameters]
-
-        required_parameters = [
-            p.get("name") for p in self.parameters if p.get("required")
-        ]
-        required_parameters.extend(mandatory_parameters)
-        return {k: v for k, v in self.headers.items() if k in required_parameters}
+default_str_mapping: Mapping[str, str] = MappingProxyType({})
+default_any_mapping: Mapping[str, object] = MappingProxyType({})
 
 
 @library(scope="SUITE", doc_format="ROBOT")
-class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
+class OpenApiLibCore:  # pylint: disable=too-many-public-methods
     """
     Main class providing the keywords and core logic to interact with an OpenAPI server.
 
@@ -462,29 +179,29 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
     for an introduction.
     """
 
-    def __init__(  # pylint: disable=too-many-arguments, too-many-locals, dangerous-default-value
+    def __init__(  # noqa: PLR0913, pylint: disable=dangerous-default-value
         self,
         source: str,
         origin: str = "",
         base_path: str = "",
-        response_validation: ValidationLevel = ValidationLevel.WARN,
+        response_validation: val.ValidationLevel = val.ValidationLevel.WARN,
         disable_server_validation: bool = True,
-        mappings_path: Union[str, Path] = "",
+        mappings_path: str | Path = "",
         invalid_property_default_response: int = 422,
         default_id_property_name: str = "id",
-        faker_locale: Optional[Union[str, List[str]]] = None,
+        faker_locale: str | list[str] = "",
         require_body_for_invalid_url: bool = False,
         recursion_limit: int = 1,
-        recursion_default: Any = {},
+        recursion_default: JSON = {},
         username: str = "",
         password: str = "",
         security_token: str = "",
-        auth: Optional[AuthBase] = None,
-        cert: Optional[Union[str, Tuple[str, str]]] = None,
-        verify_tls: Optional[Union[bool, str]] = True,
-        extra_headers: Optional[Dict[str, str]] = None,
-        cookies: Optional[Union[Dict[str, str], CookieJar]] = None,
-        proxies: Optional[Dict[str, str]] = None,
+        auth: AuthBase | None = None,
+        cert: str | tuple[str, str] = "",
+        verify_tls: bool | str = True,
+        extra_headers: Mapping[str, str] = default_str_mapping,
+        cookies: MutableMapping[str, str] | CookieJar | None = None,
+        proxies: MutableMapping[str, str] | None = None,
     ) -> None:
         """
         == Base parameters ==
@@ -496,7 +213,7 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         The server (and port) of the target server. E.g. ``https://localhost:8000``
 
         === base_path ===
-        The routing between ``origin`` and the endpoints as found in the ``paths``
+        The routing between ``origin`` and the paths as found in the ``paths``
         section in the openapi document.
         E.g. ``/petshop/v2``.
 
@@ -612,18 +329,18 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         self.response_validation = response_validation
         self.disable_server_validation = disable_server_validation
         self._recursion_limit = recursion_limit
-        self._recursion_default = recursion_default
+        self._recursion_default = deepcopy(recursion_default)
         self.session = Session()
-        # only username and password, security_token or auth object should be provided
+        # Only username and password, security_token or auth object should be provided
         # if multiple are provided, username and password take precedence
         self.security_token = security_token
         self.auth = auth
         if username:
             self.auth = HTTPBasicAuth(username, password)
-        # Robot Framework does not allow users to create tuples and requests
-        # does not accept lists, so perform the conversion here
-        if isinstance(cert, list):
-            cert = tuple(cert)
+        # Requests only allows a string or a tuple[str, str], so ensure cert is a tuple
+        # if the passed argument is not a string.
+        if not isinstance(cert, str):
+            cert = (cert[0], cert[1])
         self.cert = cert
         self.verify = verify_tls
         self.extra_headers = extra_headers
@@ -633,11 +350,9 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         if mappings_path and str(mappings_path) != ".":
             mappings_path = Path(mappings_path)
             if not mappings_path.is_file():
-                logger.warning(
-                    f"mappings_path '{mappings_path}' is not a Python module."
-                )
-            # intermediate variable to ensure path.append is possible so we'll never
-            # path.pop a location that we didn't append
+                logger.warn(f"mappings_path '{mappings_path}' is not a Python module.")
+            # Intermediate variable to ensure path.append is possible so we'll never
+            # path.pop a location that we didn't append.
             mappings_folder = str(mappings_path.parent)
             sys.path.append(mappings_folder)
             mappings_module_name = mappings_path.stem
@@ -660,10 +375,7 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         DEFAULT_ID_PROPERTY_NAME.id_property_name = default_id_property_name
         self._server_validation_warning_logged = False
 
-    @property
-    def origin(self) -> str:
-        return self._origin
-
+    # region: library configuration keywords
     @keyword
     def set_origin(self, origin: str) -> None:
         """
@@ -710,7 +422,7 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         self.auth = auth
 
     @keyword
-    def set_extra_headers(self, extra_headers: Dict[str, str]) -> None:
+    def set_extra_headers(self, extra_headers: dict[str, str]) -> None:
         """
         Set the `extra_headers` used in requests after the library is imported.
 
@@ -719,691 +431,76 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         """
         self.extra_headers = extra_headers
 
-    @property
-    def base_url(self) -> str:
-        return f"{self.origin}{self._base_path}"
-
-    @cached_property
-    def validation_spec(self) -> Spec:
-        _, validation_spec, _ = self._load_specs_and_validator()
-        return validation_spec
-
-    @property
-    def openapi_spec(self) -> Dict[str, Any]:
-        """Return a deepcopy of the parsed openapi document."""
-        # protect the parsed openapi spec from being mutated by reference
-        return deepcopy(self._openapi_spec)
-
-    @cached_property
-    def _openapi_spec(self) -> Dict[str, Any]:
-        parser, _, _ = self._load_specs_and_validator()
-        return parser.specification
-
-    @cached_property
-    def response_validator(
-        self,
-    ) -> Callable[[RequestsOpenAPIRequest, RequestsOpenAPIResponse], None]:
-        _, _, response_validator = self._load_specs_and_validator()
-        return response_validator
-
-    def _get_json_types_from_spec(self, spec: Dict[str, Any]) -> Set[str]:
-        json_types: Set[str] = set(self._get_json_types(spec))
-        return {json_type for json_type in json_types if json_type is not None}
-
-    def _get_json_types(self, item: Any) -> Generator[str, None, None]:
-        if isinstance(item, dict):
-            content_dict = item.get("content")
-            if content_dict is None:
-                for value in item.values():
-                    yield from self._get_json_types(value)
-
-            else:
-                for content_type in content_dict:
-                    if "json" in content_type:
-                        content_type_without_charset, _, _ = content_type.partition(";")
-                        yield content_type_without_charset
-
-        if isinstance(item, list):
-            for list_item in item:
-                yield from self._get_json_types(list_item)
-
-    def _load_specs_and_validator(
-        self,
-    ) -> Tuple[
-        ResolvingParser,
-        Spec,
-        Callable[[RequestsOpenAPIRequest, RequestsOpenAPIResponse], None],
-    ]:
-        try:
-
-            def recursion_limit_handler(
-                limit: int, refstring: str, recursions: Any
-            ) -> Any:
-                return self._recursion_default
-
-            # Since parsing of the OAS and creating the Spec can take a long time,
-            # they are cached. This is done by storing them in an imported module that
-            # will have a global scope due to how the Python import system works. This
-            # ensures that in a Suite of Suites where multiple Suites use the same
-            # `source`, that OAS is only parsed / loaded once.
-            parser, validation_spec, response_validator = PARSER_CACHE.get(
-                self._source, (None, None, None)
-            )
-
-            if parser is None:
-                parser = ResolvingParser(
-                    self._source,
-                    backend="openapi-spec-validator",
-                    recursion_limit=self._recursion_limit,
-                    recursion_limit_handler=recursion_limit_handler,
-                )
-
-                if parser.specification is None:  # pragma: no cover
-                    BuiltIn().fatal_error(
-                        "Source was loaded, but no specification was present after parsing."
-                    )
-
-                validation_spec = Spec.from_dict(parser.specification)
-
-                json_types_from_spec: Set[str] = self._get_json_types_from_spec(
-                    parser.specification
-                )
-                extra_deserializers = {
-                    json_type: _json.loads for json_type in json_types_from_spec
-                }
-                config = Config(extra_media_type_deserializers=extra_deserializers)
-                openapi = OpenAPI(spec=validation_spec, config=config)
-                response_validator = openapi.validate_response
-
-                PARSER_CACHE[self._source] = (
-                    parser,
-                    validation_spec,
-                    response_validator,
-                )
-
-            return parser, validation_spec, response_validator
-
-        except ResolutionError as exception:
-            BuiltIn().fatal_error(
-                f"ResolutionError while trying to load openapi spec: {exception}"
-            )
-        except ValidationError as exception:
-            BuiltIn().fatal_error(
-                f"ValidationError while trying to load openapi spec: {exception}"
-            )
-
-    def validate_response_vs_spec(
-        self, request: RequestsOpenAPIRequest, response: RequestsOpenAPIResponse
-    ) -> None:
-        """
-        Validate the reponse for a given request against the OpenAPI Spec that is
-        loaded during library initialization.
-        """
-        self.response_validator(request=request, response=response)
-
-    def read_paths(self) -> Dict[str, Any]:
-        return self.openapi_spec["paths"]
-
-    @keyword
-    def get_valid_url(self, endpoint: str, method: str) -> str:
-        """
-        This keyword returns a valid url for the given `endpoint` and `method`.
-
-        If the `endpoint` contains path parameters the Get Valid Id For Endpoint
-        keyword will be executed to retrieve valid ids for the path parameters.
-
-        > Note: if valid ids cannot be retrieved within the scope of the API, the
-        `PathPropertiesConstraint` Relation can be used. More information can be found
-        [https://marketsquare.github.io/robotframework-openapi-libcore/advanced_use.html | here].
-        """
-        method = method.lower()
-        try:
-            # endpoint can be partially resolved or provided by a PathPropertiesConstraint
-            parametrized_endpoint = self.get_parametrized_endpoint(endpoint=endpoint)
-            _ = self.openapi_spec["paths"][parametrized_endpoint]
-        except KeyError:
-            raise ValueError(
-                f"{endpoint} not found in paths section of the OpenAPI document."
-            ) from None
-        dto_class = self.get_dto_class(endpoint=endpoint, method=method)
-        relations = dto_class.get_relations()
-        paths = [p.path for p in relations if isinstance(p, PathPropertiesConstraint)]
-        if paths:
-            url = f"{self.base_url}{choice(paths)}"
-            return url
-        endpoint_parts = list(endpoint.split("/"))
-        for index, part in enumerate(endpoint_parts):
-            if part.startswith("{") and part.endswith("}"):
-                type_endpoint_parts = endpoint_parts[slice(index)]
-                type_endpoint = "/".join(type_endpoint_parts)
-                existing_id: Union[str, int, float] = run_keyword(
-                    "get_valid_id_for_endpoint", type_endpoint, method
-                )
-                endpoint_parts[index] = str(existing_id)
-        resolved_endpoint = "/".join(endpoint_parts)
-        url = f"{self.base_url}{resolved_endpoint}"
-        return url
-
-    @keyword
-    def get_valid_id_for_endpoint(
-        self, endpoint: str, method: str
-    ) -> Union[str, int, float]:
-        """
-        Support keyword that returns the `id` for an existing resource at `endpoint`.
-
-        To prevent resource conflicts with other test cases, a new resource is created
-        (POST) if possible.
-        """
-
-        def dummy_transformer(
-            valid_id: Union[str, int, float]
-        ) -> Union[str, int, float]:
-            return valid_id
-
-        method = method.lower()
-        url: str = run_keyword("get_valid_url", endpoint, method)
-        # Try to create a new resource to prevent conflicts caused by
-        # operations performed on the same resource by other test cases
-        request_data = self.get_request_data(endpoint=endpoint, method="post")
-
-        response: Response = run_keyword(
-            "authorized_request",
-            url,
-            "post",
-            request_data.get_required_params(),
-            request_data.get_required_headers(),
-            request_data.get_required_properties_dict(),
-        )
-
-        # determine the id property name for this path and whether or not a transformer is used
-        mapping = self.get_id_property_name(endpoint=endpoint)
-        if isinstance(mapping, str):
-            id_property = mapping
-            # set the transformer to a dummy callable that returns the original value so
-            # the transformer can be applied on any returned id
-            id_transformer = dummy_transformer
-        else:
-            id_property, id_transformer = mapping
-
-        if not response.ok:
-            # If a new resource cannot be created using POST, try to retrieve a
-            # valid id using a GET request.
-            try:
-                valid_id = choice(run_keyword("get_ids_from_url", url))
-                return id_transformer(valid_id)
-            except Exception as exception:
-                raise AssertionError(
-                    f"Failed to get a valid id using GET on {url}"
-                ) from exception
-
-        response_data = response.json()
-        if prepared_body := response.request.body:
-            if isinstance(prepared_body, bytes):
-                send_json = _json.loads(prepared_body.decode("UTF-8"))
-            else:
-                send_json = _json.loads(prepared_body)
-        else:
-            send_json = None
-
-        # no support for retrieving an id from an array returned on a POST request
-        if isinstance(response_data, list):
-            raise NotImplementedError(
-                f"Unexpected response body for POST request: expected an object but "
-                f"received an array ({response_data})"
-            )
-
-        # POST on /resource_type/{id}/array_item/ will return the updated {id} resource
-        # instead of a newly created resource. In this case, the send_json must be
-        # in the array of the 'array_item' property on {id}
-        send_path: str = response.request.path_url
-        response_href: Optional[str] = response_data.get("href", None)
-        if response_href and (send_path not in response_href) and send_json:
-            try:
-                property_to_check = send_path.replace(response_href, "")[1:]
-                item_list: List[Dict[str, Any]] = response_data[property_to_check]
-                # Use the (mandatory) id to get the POSTed resource from the list
-                [valid_id] = [
-                    item[id_property]
-                    for item in item_list
-                    if item[id_property] == send_json[id_property]
-                ]
-            except Exception as exception:
-                raise AssertionError(
-                    f"Failed to get a valid id from {response_href}"
-                ) from exception
-        else:
-            try:
-                valid_id = response_data[id_property]
-            except KeyError:
-                raise AssertionError(
-                    f"Failed to get a valid id from {response_data}"
-                ) from None
-        return id_transformer(valid_id)
-
+    # endregion
+    # region: data generation keywords
     @keyword
-    def get_ids_from_url(self, url: str) -> List[str]:
-        """
-        Perform a GET request on the `url` and return the list of resource
-        `ids` from the response.
-        """
-        endpoint = self.get_parameterized_endpoint_from_url(url)
-        request_data = self.get_request_data(endpoint=endpoint, method="get")
-        response = run_keyword(
-            "authorized_request",
-            url,
-            "get",
-            request_data.get_required_params(),
-            request_data.get_required_headers(),
-        )
-        response.raise_for_status()
-        response_data: Union[Dict[str, Any], List[Dict[str, Any]]] = response.json()
-
-        # determine the property name to use
-        mapping = self.get_id_property_name(endpoint=endpoint)
-        if isinstance(mapping, str):
-            id_property = mapping
-        else:
-            id_property, _ = mapping
-
-        if isinstance(response_data, list):
-            valid_ids: List[str] = [item[id_property] for item in response_data]
-            return valid_ids
-        # if the response is an object (dict), check if it's hal+json
-        if embedded := response_data.get("_embedded"):
-            # there should be 1 item in the dict that has a value that's a list
-            for value in embedded.values():
-                if isinstance(value, list):
-                    valid_ids = [item[id_property] for item in value]
-                    return valid_ids
-        if (valid_id := response_data.get(id_property)) is not None:
-            return [valid_id]
-        valid_ids = [item[id_property] for item in response_data["items"]]
-        return valid_ids
+    def get_request_values(
+        self,
+        path: str,
+        method: str,
+        overrides: Mapping[str, object] = default_any_mapping,
+    ) -> RequestValues:
+        """Return an object with all (valid) request values needed to make a request."""
+        json_data: dict[str, JSON] = {}
 
-    @keyword
-    def get_request_data(self, endpoint: str, method: str) -> RequestData:
-        """Return an object with valid request data for body, headers and query params."""
-        method = method.lower()
-        dto_cls_name = self._get_dto_cls_name(endpoint=endpoint, method=method)
-        # The endpoint can contain already resolved Ids that have to be matched
-        # against the parametrized endpoints in the paths section.
-        spec_endpoint = self.get_parametrized_endpoint(endpoint)
-        dto_class = self.get_dto_class(endpoint=spec_endpoint, method=method)
-        try:
-            method_spec = self.openapi_spec["paths"][spec_endpoint][method]
-        except KeyError:
-            logger.info(
-                f"method '{method}' not supported on '{spec_endpoint}, using empty spec."
-            )
-            method_spec = {}
+        url: str = run_keyword("get_valid_url", path)
+        request_data: RequestData = run_keyword("get_request_data", path, method)
+        params = request_data.params
+        headers = request_data.headers
+        if request_data.has_body:
+            json_data = request_data.dto.as_dict()
 
-        parameters, params, headers = self.get_request_parameters(
-            dto_class=dto_class, method_spec=method_spec
-        )
-        if (body_spec := method_spec.get("requestBody", None)) is None:
-            if dto_class == DefaultDto:
-                dto_instance: Dto = DefaultDto()
-            else:
-                dto_class = make_dataclass(
-                    cls_name=method_spec.get("operationId", dto_cls_name),
-                    fields=[],
-                    bases=(dto_class,),
-                )
-                dto_instance = dto_class()
-            return RequestData(
-                dto=dto_instance,
-                parameters=parameters,
-                params=params,
-                headers=headers,
-                has_body=False,
-            )
-        content_schema = resolve_schema(self.get_content_schema(body_spec))
-        headers.update({"content-type": self.get_content_type(body_spec)})
-        dto_data = self.get_json_data_for_dto_class(
-            schema=content_schema,
-            dto_class=dto_class,
-            operation_id=method_spec.get("operationId", ""),
-        )
-        if dto_data is None:
-            dto_instance = DefaultDto()
-        else:
-            fields = self.get_fields_from_dto_data(content_schema, dto_data)
-            dto_class = make_dataclass(
-                cls_name=method_spec.get("operationId", dto_cls_name),
-                fields=fields,
-                bases=(dto_class,),
-            )
-            dto_data = {get_safe_key(key): value for key, value in dto_data.items()}
-            dto_instance = dto_class(**dto_data)
-        return RequestData(
-            dto=dto_instance,
-            dto_schema=content_schema,
-            parameters=parameters,
+        request_values = RequestValues(
+            url=url,
+            method=method,
             params=params,
             headers=headers,
+            json_data=json_data,
         )
 
-    @staticmethod
-    def _get_dto_cls_name(endpoint: str, method: str) -> str:
-        method = method.capitalize()
-        path = endpoint.translate({ord(i): None for i in "{}"})
-        path_parts = path.split("/")
-        path_parts = [p.capitalize() for p in path_parts]
-        result = "".join([method, *path_parts])
-        return result
-
-    @staticmethod
-    def get_fields_from_dto_data(
-        content_schema: Dict[str, Any], dto_data: Dict[str, Any]
-    ):
-        # FIXME: annotation is not Pyhon 3.8-compatible
-        # ) -> List[Union[str, Tuple[str, Type[Any]], Tuple[str, Type[Any], Field[Any]]]]:
-        """Get a dataclasses fields list based on the content_schema and dto_data."""
-        fields: List[
-            Union[str, Tuple[str, Type[Any]], Tuple[str, Type[Any], Field[Any]]]
-        ] = []
-        for key, value in dto_data.items():
-            required_properties = content_schema.get("required", [])
-            safe_key = get_safe_key(key)
-            metadata = {"original_property_name": key}
-            if key in required_properties:
-                # The fields list is used to create a dataclass, so non-default fields
-                # must go before fields with a default
-                fields.insert(0, (safe_key, type(value), field(metadata=metadata)))
+        for name, value in overrides.items():
+            if name.startswith(("body_", "header_", "query_")):
+                location, _, name_ = name.partition("_")
+                oas_name = get_oas_name_from_safe_name(name_)
+                if location == "body":
+                    request_values.override_body_value(name=oas_name, value=value)
+                if location == "header":
+                    request_values.override_header_value(name=oas_name, value=value)
+                if location == "query":
+                    request_values.override_param_value(name=oas_name, value=str(value))
             else:
-                fields.append((safe_key, type(value), field(default=None, metadata=metadata)))  # type: ignore[arg-type]
-        return fields
-
-    def get_request_parameters(
-        self, dto_class: Union[Dto, Type[Dto]], method_spec: Dict[str, Any]
-    ) -> Tuple[List[Dict[str, Any]], Dict[str, Any], Dict[str, str]]:
-        """Get the methods parameter spec and params and headers with valid data."""
-        parameters = method_spec.get("parameters", [])
-        parameter_relations = dto_class.get_parameter_relations()
-        query_params = [p for p in parameters if p.get("in") == "query"]
-        header_params = [p for p in parameters if p.get("in") == "header"]
-        params = self.get_parameter_data(query_params, parameter_relations)
-        headers = self.get_parameter_data(header_params, parameter_relations)
-        return parameters, params, headers
-
-    @classmethod
-    def get_content_schema(cls, body_spec: Dict[str, Any]) -> Dict[str, Any]:
-        """Get the content schema from the requestBody spec."""
-        content_type = cls.get_content_type(body_spec)
-        content_schema = body_spec["content"][content_type]["schema"]
-        return resolve_schema(content_schema)
+                oas_name = get_oas_name_from_safe_name(name)
+                request_values.override_request_value(name=oas_name, value=value)
 
-    @staticmethod
-    def get_content_type(body_spec: Dict[str, Any]) -> str:
-        """Get and validate the first supported content type from the requested body spec
+        return request_values
 
-        Should be application/json like content type,
-        e.g "application/json;charset=utf-8" or "application/merge-patch+json"
-        """
-        content_types: List[str] = body_spec["content"].keys()
-        json_regex = r"application/([a-z\-]+\+)?json(;\s?charset=(.+))?"
-        for content_type in content_types:
-            if re.search(json_regex, content_type):
-                return content_type
-
-        # At present no supported for other types.
-        raise NotImplementedError(
-            f"Only content types like 'application/json' are supported. "
-            f"Content types definded in the spec are '{content_types}'."
+    @keyword
+    def get_request_data(self, path: str, method: str) -> RequestData:
+        """Return an object with valid request data for body, headers and query params."""
+        return _data_generation.get_request_data(
+            path=path,
+            method=method,
+            get_dto_class=self.get_dto_class,
+            get_id_property_name=self.get_id_property_name,
+            openapi_spec=self.openapi_spec,
         )
 
-    def get_parametrized_endpoint(self, endpoint: str) -> str:
-        """
-        Get the parametrized endpoint as found in the `paths` section of the openapi
-        document from a (partially) resolved endpoint.
-        """
-
-        def match_parts(parts: List[str], spec_parts: List[str]) -> bool:
-            for part, spec_part in zip_longest(parts, spec_parts, fillvalue="Filler"):
-                if part == "Filler" or spec_part == "Filler":
-                    return False
-                if part != spec_part and not spec_part.startswith("{"):
-                    return False
-            return True
-
-        endpoint_parts = endpoint.split("/")
-        # if the last part is empty, the path has a trailing `/` that
-        # should be ignored during matching
-        if endpoint_parts[-1] == "":
-            _ = endpoint_parts.pop(-1)
-
-        spec_endpoints: List[str] = {**self.openapi_spec}["paths"].keys()
-
-        candidates: List[str] = []
-
-        for spec_endpoint in spec_endpoints:
-            spec_endpoint_parts = spec_endpoint.split("/")
-            # ignore trailing `/` the same way as for endpoint_parts
-            if spec_endpoint_parts[-1] == "":
-                _ = spec_endpoint_parts.pop(-1)
-            if match_parts(endpoint_parts, spec_endpoint_parts):
-                candidates.append(spec_endpoint)
-
-        if not candidates:
-            raise ValueError(
-                f"{endpoint} not found in paths section of the OpenAPI document."
-            )
-
-        if len(candidates) == 1:
-            return candidates[0]
-        # Multiple matches can happen in APIs with overloaded endpoints, e.g.
-        # /users/me
-        # /users/${user_id}
-        # In this case, find the closest (or exact) match
-        exact_match = [c for c in candidates if c == endpoint]
-        if exact_match:
-            return exact_match[0]
-        # TODO: Implement a decision mechanism when real-world examples become available
-        # In the face of ambiguity, refuse the temptation to guess.
-        raise ValueError(f"{endpoint} matched to multiple paths: {candidates}")
-
-    @staticmethod
-    def get_parameter_data(
-        parameters: List[Dict[str, Any]],
-        parameter_relations: List[Relation],
-    ) -> Dict[str, str]:
-        """Generate a valid list of key-value pairs for all parameters."""
-        result: Dict[str, str] = {}
-        value: Any = None
-        for parameter in parameters:
-            parameter_name = parameter["name"]
-            parameter_schema = resolve_schema(parameter["schema"])
-            relations = [
-                r for r in parameter_relations if r.property_name == parameter_name
-            ]
-            if constrained_values := [
-                r.values for r in relations if isinstance(r, PropertyValueConstraint)
-            ]:
-                value = choice(*constrained_values)
-                if value is IGNORE:
-                    continue
-                result[parameter_name] = value
-                continue
-            value = value_utils.get_valid_value(parameter_schema)
-            result[parameter_name] = value
-        return result
-
     @keyword
     def get_json_data_for_dto_class(
         self,
-        schema: Dict[str, Any],
-        dto_class: Union[Dto, Type[Dto]],
+        schema: dict[str, JSON],
+        dto_class: type[Dto],
         operation_id: str = "",
-    ) -> Optional[Dict[str, Any]]:
+    ) -> JSON:
         """
-        Generate a valid (json-compatible) dict for all the `dto_class` properties.
+        Generate valid (json-compatible) data for the `dto_class`.
         """
-
-        def get_constrained_values(property_name: str) -> List[Any]:
-            relations = dto_class.get_relations()
-            values_list = [
-                c.values
-                for c in relations
-                if (
-                    isinstance(c, PropertyValueConstraint)
-                    and c.property_name == property_name
-                )
-            ]
-            # values should be empty or contain 1 list of allowed values
-            return values_list.pop() if values_list else []
-
-        def get_dependent_id(
-            property_name: str, operation_id: str
-        ) -> Optional[Union[str, int, float]]:
-            relations = dto_class.get_relations()
-            # multiple get paths are possible based on the operation being performed
-            id_get_paths = [
-                (d.get_path, d.operation_id)
-                for d in relations
-                if (isinstance(d, IdDependency) and d.property_name == property_name)
-            ]
-            if not id_get_paths:
-                return None
-            if len(id_get_paths) == 1:
-                id_get_path, _ = id_get_paths.pop()
-            else:
-                try:
-                    [id_get_path] = [
-                        path
-                        for path, operation in id_get_paths
-                        if operation == operation_id
-                    ]
-                # There could be multiple get_paths, but not one for the current operation
-                except ValueError:
-                    return None
-            valid_id = self.get_valid_id_for_endpoint(
-                endpoint=id_get_path, method="get"
-            )
-            logger.debug(f"get_dependent_id for {id_get_path} returned {valid_id}")
-            return valid_id
-
-        json_data: Dict[str, Any] = {}
-
-        property_names = []
-        for property_name in schema.get("properties", []):
-            if constrained_values := get_constrained_values(property_name):
-                # do not add properties that are configured to be ignored
-                if IGNORE in constrained_values:
-                    continue
-            property_names.append(property_name)
-
-        max_properties = schema.get("maxProperties")
-        if max_properties and len(property_names) > max_properties:
-            required_properties = schema.get("required", [])
-            number_of_optional_properties = max_properties - len(required_properties)
-            optional_properties = [
-                name for name in property_names if name not in required_properties
-            ]
-            selected_optional_properties = sample(
-                optional_properties, number_of_optional_properties
-            )
-            property_names = required_properties + selected_optional_properties
-
-        for property_name in property_names:
-            properties_schema = schema["properties"][property_name]
-
-            property_type = properties_schema.get("type")
-            if property_type is None:
-                property_types = properties_schema.get("types")
-                if property_types is None:
-                    if properties_schema.get("properties") is not None:
-                        nested_data = self.get_json_data_for_dto_class(
-                            schema=properties_schema,
-                            dto_class=DefaultDto,
-                        )
-                        json_data[property_name] = nested_data
-                        continue
-                selected_type_schema = choice(property_types)
-                property_type = selected_type_schema["type"]
-            if properties_schema.get("readOnly", False):
-                continue
-            if constrained_values := get_constrained_values(property_name):
-                json_data[property_name] = choice(constrained_values)
-                continue
-            if (
-                dependent_id := get_dependent_id(
-                    property_name=property_name, operation_id=operation_id
-                )
-            ) is not None:
-                json_data[property_name] = dependent_id
-                continue
-            if property_type == "object":
-                object_data = self.get_json_data_for_dto_class(
-                    schema=properties_schema,
-                    dto_class=DefaultDto,
-                    operation_id="",
-                )
-                json_data[property_name] = object_data
-                continue
-            if property_type == "array":
-                array_data = self.get_json_data_for_dto_class(
-                    schema=properties_schema["items"],
-                    dto_class=DefaultDto,
-                    operation_id=operation_id,
-                )
-                json_data[property_name] = [array_data]
-                continue
-            json_data[property_name] = value_utils.get_valid_value(properties_schema)
-
-        return json_data
-
-    @keyword
-    def get_invalidated_url(
-        self,
-        valid_url: str,
-        path: str = "",
-        method: str = "",
-        expected_status_code: int = 404,
-    ) -> Optional[str]:
-        """
-        Return an url with all the path parameters in the `valid_url` replaced by a
-        random UUID if no PathPropertiesConstraint is mapped for the `path`, `method`
-        and `expected_status_code`.
-        If a PathPropertiesConstraint is mapped, the `invalid_value` is returned.
-
-        Raises ValueError if the valid_url cannot be invalidated.
-        """
-        dto_class = self.get_dto_class(endpoint=path, method=method)
-        relations = dto_class.get_relations()
-        paths = [
-            p.invalid_value
-            for p in relations
-            if isinstance(p, PathPropertiesConstraint)
-            and p.invalid_value_error_code == expected_status_code
-        ]
-        if paths:
-            url = f"{self.base_url}{choice(paths)}"
-            return url
-        parameterized_endpoint = self.get_parameterized_endpoint_from_url(valid_url)
-        parameterized_url = self.base_url + parameterized_endpoint
-        valid_url_parts = list(reversed(valid_url.split("/")))
-        parameterized_parts = reversed(parameterized_url.split("/"))
-        for index, (parameterized_part, _) in enumerate(
-            zip(parameterized_parts, valid_url_parts)
-        ):
-            if parameterized_part.startswith("{") and parameterized_part.endswith("}"):
-                valid_url_parts[index] = uuid4().hex
-                valid_url_parts.reverse()
-                invalid_url = "/".join(valid_url_parts)
-                return invalid_url
-        raise ValueError(f"{parameterized_endpoint} could not be invalidated.")
-
-    @keyword
-    def get_parameterized_endpoint_from_url(self, url: str) -> str:
-        """
-        Return the endpoint as found in the `paths` section based on the given `url`.
-        """
-        endpoint = url.replace(self.base_url, "")
-        endpoint_parts = endpoint.split("/")
-        # first part will be '' since an endpoint starts with /
-        endpoint_parts.pop(0)
-        parameterized_endpoint = self.get_parametrized_endpoint(endpoint=endpoint)
-        return parameterized_endpoint
+        return _data_generation.get_json_data_for_dto_class(
+            schema=schema,
+            dto_class=dto_class,
+            get_id_property_name=self.get_id_property_name,
+            operation_id=operation_id,
+        )
 
     @keyword
     def get_invalid_json_data(
@@ -1412,7 +509,7 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         method: str,
         status_code: int,
         request_data: RequestData,
-    ) -> Dict[str, Any]:
+    ) -> dict[str, JSON]:
         """
         Return `json_data` based on the `dto` on the `request_data` that will cause
         the provided `status_code` for the `method` operation on the `url`.
@@ -1420,321 +517,152 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         > Note: applicable UniquePropertyValueConstraint and IdReference Relations are
             considered before changes to `json_data` are made.
         """
-        method = method.lower()
-        data_relations = request_data.dto.get_relations_for_error_code(status_code)
-        data_relations = [
-            r for r in data_relations if not isinstance(r, PathPropertiesConstraint)
-        ]
-        if not data_relations:
-            if not request_data.dto_schema:
-                raise ValueError(
-                    "Failed to invalidate: no data_relations and empty schema."
-                )
-            json_data = request_data.dto.get_invalidated_data(
-                schema=request_data.dto_schema,
-                status_code=status_code,
-                invalid_property_default_code=self.invalid_property_default_response,
-            )
-            return json_data
-        resource_relation = choice(data_relations)
-        if isinstance(resource_relation, UniquePropertyValueConstraint):
-            json_data = run_keyword(
-                "get_json_data_with_conflict",
-                url,
-                method,
-                request_data.dto,
-                status_code,
-            )
-        elif isinstance(resource_relation, IdReference):
-            run_keyword("ensure_in_use", url, resource_relation)
-            json_data = request_data.dto.as_dict()
-        else:
-            json_data = request_data.dto.get_invalidated_data(
-                schema=request_data.dto_schema,
-                status_code=status_code,
-                invalid_property_default_code=self.invalid_property_default_response,
-            )
-        return json_data
+        return di.get_invalid_json_data(
+            url=url,
+            method=method,
+            status_code=status_code,
+            request_data=request_data,
+            invalid_property_default_response=self.invalid_property_default_response,
+        )
 
     @keyword
     def get_invalidated_parameters(
         self,
         status_code: int,
         request_data: RequestData,
-    ) -> Tuple[Dict[str, Any], Dict[str, str]]:
+    ) -> tuple[dict[str, JSON], dict[str, str]]:
         """
         Returns a version of `params, headers` as present on `request_data` that has
         been modified to cause the provided `status_code`.
         """
-        if not request_data.parameters:
-            raise ValueError("No params or headers to invalidate.")
-
-        # ensure the status_code can be triggered
-        relations = request_data.dto.get_parameter_relations_for_error_code(status_code)
-        relations_for_status_code = [
-            r
-            for r in relations
-            if isinstance(r, PropertyValueConstraint)
-            and (
-                r.error_code == status_code or r.invalid_value_error_code == status_code
-            )
-        ]
-        parameters_to_ignore = {
-            r.property_name
-            for r in relations_for_status_code
-            if r.invalid_value_error_code == status_code and r.invalid_value == IGNORE
-        }
-        relation_property_names = {r.property_name for r in relations_for_status_code}
-        if not relation_property_names:
-            if status_code != self.invalid_property_default_response:
-                raise ValueError(
-                    f"No relations to cause status_code {status_code} found."
-                )
-
-        # ensure we're not modifying mutable properties
-        params = deepcopy(request_data.params)
-        headers = deepcopy(request_data.headers)
+        return di.get_invalidated_parameters(
+            status_code=status_code,
+            request_data=request_data,
+            invalid_property_default_response=self.invalid_property_default_response,
+        )
 
-        if status_code == self.invalid_property_default_response:
-            # take the params and headers that can be invalidated based on data type
-            # and expand the set with properties that can be invalided by relations
-            parameter_names = set(request_data.params_that_can_be_invalidated).union(
-                request_data.headers_that_can_be_invalidated
-            )
-            parameter_names.update(relation_property_names)
-            if not parameter_names:
-                raise ValueError(
-                    "None of the query parameters and headers can be invalidated."
-                )
-        else:
-            # non-default status_codes can only be the result of a Relation
-            parameter_names = relation_property_names
-
-        # Dto mappings may contain generic mappings for properties that are not present
-        # in this specific schema
-        request_data_parameter_names = [p.get("name") for p in request_data.parameters]
-        additional_relation_property_names = {
-            n for n in relation_property_names if n not in request_data_parameter_names
-        }
-        if additional_relation_property_names:
-            logger.warning(
-                f"get_parameter_relations_for_error_code yielded properties that are "
-                f"not defined in the schema: {additional_relation_property_names}\n"
-                f"These properties will be ignored for parameter invalidation."
-            )
-            parameter_names = parameter_names - additional_relation_property_names
+    @keyword
+    def get_json_data_with_conflict(
+        self, url: str, method: str, dto: Dto, conflict_status_code: int
+    ) -> dict[str, JSON]:
+        """
+        Return `json_data` based on the `UniquePropertyValueConstraint` that must be
+        returned by the `get_relations` implementation on the `dto` for the given
+        `conflict_status_code`.
+        """
+        return di.get_json_data_with_conflict(
+            url=url,
+            base_url=self.base_url,
+            method=method,
+            dto=dto,
+            conflict_status_code=conflict_status_code,
+        )
 
-        if not parameter_names:
-            raise ValueError(
-                f"No parameter can be changed to cause status_code {status_code}."
-            )
+    # endregion
+    # region: path-related keywords
+    @keyword
+    def get_valid_url(self, path: str) -> str:
+        """
+        This keyword returns a valid url for the given `path`.
 
-        parameter_names = parameter_names - parameters_to_ignore
-        parameter_to_invalidate = choice(tuple(parameter_names))
+        If the `path` contains path parameters the Get Valid Id For Path
+        keyword will be executed to retrieve valid ids for the path parameters.
 
-        # check for invalid parameters in the provided request_data
-        try:
-            [parameter_data] = [
-                data
-                for data in request_data.parameters
-                if data["name"] == parameter_to_invalidate
-            ]
-        except Exception:
-            raise ValueError(
-                f"{parameter_to_invalidate} not found in provided parameters."
-            ) from None
-
-        # get the invalid_value for the chosen parameter
-        try:
-            [invalid_value_for_error_code] = [
-                r.invalid_value
-                for r in relations_for_status_code
-                if r.property_name == parameter_to_invalidate
-                and r.invalid_value_error_code == status_code
-            ]
-        except ValueError:
-            invalid_value_for_error_code = NOT_SET
-
-        # get the constraint values if available for the chosen parameter
-        try:
-            [values_from_constraint] = [
-                r.values
-                for r in relations_for_status_code
-                if r.property_name == parameter_to_invalidate
-            ]
-        except ValueError:
-            values_from_constraint = []
-
-        # if the parameter was not provided, add it to params / headers
-        params, headers = self.ensure_parameter_in_parameters(
-            parameter_to_invalidate=parameter_to_invalidate,
-            params=params,
-            headers=headers,
-            parameter_data=parameter_data,
-            values_from_constraint=values_from_constraint,
+        > Note: if valid ids cannot be retrieved within the scope of the API, the
+        `PathPropertiesConstraint` Relation can be used. More information can be found
+        [https://marketsquare.github.io/robotframework-openapitools/advanced_use.html | here].
+        """
+        return pf.get_valid_url(
+            path=path,
+            base_url=self.base_url,
+            get_dto_class=self.get_dto_class,
+            openapi_spec=self.openapi_spec,
         )
 
-        # determine the invalid_value
-        if invalid_value_for_error_code != NOT_SET:
-            invalid_value = invalid_value_for_error_code
-        else:
-            if parameter_to_invalidate in params.keys():
-                valid_value = params[parameter_to_invalidate]
-            else:
-                valid_value = headers[parameter_to_invalidate]
-
-            value_schema = resolve_schema(parameter_data["schema"])
-            invalid_value = value_utils.get_invalid_value(
-                value_schema=value_schema,
-                current_value=valid_value,
-                values_from_constraint=values_from_constraint,
-            )
-        logger.debug(f"{parameter_to_invalidate} changed to {invalid_value}")
+    @keyword
+    def get_valid_id_for_path(self, path: str) -> str | int | float:
+        """
+        Support keyword that returns the `id` for an existing resource at `path`.
 
-        # update the params / headers and return
-        if parameter_to_invalidate in params.keys():
-            params[parameter_to_invalidate] = invalid_value
-        else:
-            headers[parameter_to_invalidate] = invalid_value
-        return params, headers
+        To prevent resource conflicts with other test cases, a new resource is created
+        (by a POST operation) if possible.
+        """
+        return pf.get_valid_id_for_path(
+            path=path, get_id_property_name=self.get_id_property_name
+        )
 
-    @staticmethod
-    def ensure_parameter_in_parameters(
-        parameter_to_invalidate: str,
-        params: Dict[str, Any],
-        headers: Dict[str, str],
-        parameter_data: Dict[str, Any],
-        values_from_constraint: List[Any],
-    ) -> Tuple[Dict[str, Any], Dict[str, str]]:
+    @keyword
+    def get_parameterized_path_from_url(self, url: str) -> str:
         """
-        Returns the params, headers tuple with parameter_to_invalidate with a valid
-        value to params or headers if not originally present.
+        Return the path as found in the `paths` section based on the given `url`.
         """
-        if (
-            parameter_to_invalidate not in params.keys()
-            and parameter_to_invalidate not in headers.keys()
-        ):
-            if values_from_constraint:
-                valid_value = choice(values_from_constraint)
-            else:
-                parameter_schema = resolve_schema(parameter_data["schema"])
-                valid_value = value_utils.get_valid_value(parameter_schema)
-            if (
-                parameter_data["in"] == "query"
-                and parameter_to_invalidate not in params.keys()
-            ):
-                params[parameter_to_invalidate] = valid_value
-            if (
-                parameter_data["in"] == "header"
-                and parameter_to_invalidate not in headers.keys()
-            ):
-                headers[parameter_to_invalidate] = valid_value
-        return params, headers
+        path = url.replace(self.base_url, "")
+        path_parts = path.split("/")
+        # first part will be '' since a path starts with /
+        path_parts.pop(0)
+        parameterized_path = pf.get_parametrized_path(
+            path=path, openapi_spec=self.openapi_spec
+        )
+        return parameterized_path
 
     @keyword
-    def ensure_in_use(self, url: str, resource_relation: IdReference) -> None:
+    def get_ids_from_url(self, url: str) -> list[str]:
         """
-        Ensure that the (right-most) `id` of the resource referenced by the `url`
-        is used by the resource defined by the `resource_relation`.
+        Perform a GET request on the `url` and return the list of resource
+        `ids` from the response.
         """
-        resource_id = ""
-
-        endpoint = url.replace(self.base_url, "")
-        endpoint_parts = endpoint.split("/")
-        parameterized_endpoint = self.get_parametrized_endpoint(endpoint=endpoint)
-        parameterized_endpoint_parts = parameterized_endpoint.split("/")
-        for part, param_part in zip(
-            reversed(endpoint_parts), reversed(parameterized_endpoint_parts)
-        ):
-            if param_part.endswith("}"):
-                resource_id = part
-                break
-        if not resource_id:
-            raise ValueError(f"The provided url ({url}) does not contain an id.")
-        request_data = self.get_request_data(
-            method="post", endpoint=resource_relation.post_path
+        return pf.get_ids_from_url(
+            url=url, get_id_property_name=self.get_id_property_name
         )
-        json_data = request_data.dto.as_dict()
-        json_data[resource_relation.property_name] = resource_id
-        post_url: str = run_keyword(
-            "get_valid_url",
-            resource_relation.post_path,
-            "post",
-        )
-        response: Response = run_keyword(
-            "authorized_request",
-            post_url,
-            "post",
-            request_data.params,
-            request_data.headers,
-            json_data,
+
+    @keyword
+    def get_invalidated_url(
+        self,
+        valid_url: str,
+        path: str = "",
+        expected_status_code: int = 404,
+    ) -> str:
+        """
+        Return an url with all the path parameters in the `valid_url` replaced by a
+        random UUID if no PathPropertiesConstraint is mapped for the `"get"` operation
+        on the mapped `path` and `expected_status_code`.
+        If a PathPropertiesConstraint is mapped, the `invalid_value` is returned.
+
+        Raises ValueError if the valid_url cannot be invalidated.
+        """
+        return pi.get_invalidated_url(
+            valid_url=valid_url,
+            path=path,
+            base_url=self.base_url,
+            get_dto_class=self.get_dto_class,
+            expected_status_code=expected_status_code,
         )
-        if not response.ok:
-            logger.debug(
-                f"POST on {post_url} with json {json_data} failed: {response.json()}"
-            )
-            response.raise_for_status()
 
+    # endregion
+    # region: resource relations keywords
     @keyword
-    def get_json_data_with_conflict(
-        self, url: str, method: str, dto: Dto, conflict_status_code: int
-    ) -> Dict[str, Any]:
+    def ensure_in_use(self, url: str, resource_relation: IdReference) -> None:
         """
-        Return `json_data` based on the `UniquePropertyValueConstraint` that must be
-        returned by the `get_relations` implementation on the `dto` for the given
-        `conflict_status_code`.
+        Ensure that the (right-most) `id` of the resource referenced by the `url`
+        is used by the resource defined by the `resource_relation`.
         """
-        method = method.lower()
-        json_data = dto.as_dict()
-        unique_property_value_constraints = [
-            r
-            for r in dto.get_relations()
-            if isinstance(r, UniquePropertyValueConstraint)
-        ]
-        for relation in unique_property_value_constraints:
-            json_data[relation.property_name] = relation.value
-            # create a new resource that the original request will conflict with
-            if method in ["patch", "put"]:
-                post_url_parts = url.split("/")[:-1]
-                post_url = "/".join(post_url_parts)
-                # the PATCH or PUT may use a different dto than required for POST
-                # so a valid POST dto must be constructed
-                endpoint = post_url.replace(self.base_url, "")
-                request_data = self.get_request_data(endpoint=endpoint, method="post")
-                post_json = request_data.dto.as_dict()
-                for key in post_json.keys():
-                    if key in json_data:
-                        post_json[key] = json_data.get(key)
-            else:
-                post_url = url
-                post_json = json_data
-            endpoint = post_url.replace(self.base_url, "")
-            request_data = self.get_request_data(endpoint=endpoint, method="post")
-            response: Response = run_keyword(
-                "authorized_request",
-                post_url,
-                "post",
-                request_data.params,
-                request_data.headers,
-                post_json,
-            )
-            # conflicting resource may already exist
-            assert (
-                response.ok or response.status_code == conflict_status_code
-            ), f"get_json_data_with_conflict received {response.status_code}: {response.json()}"
-            return json_data
-        raise ValueError(
-            f"No UniquePropertyValueConstraint in the get_relations list on dto {dto}."
+        rr.ensure_in_use(
+            url=url,
+            base_url=self.base_url,
+            openapi_spec=self.openapi_spec,
+            resource_relation=resource_relation,
         )
 
+    # endregion
+    # region: request keywords
     @keyword
     def authorized_request(  # pylint: disable=too-many-arguments
         self,
         url: str,
         method: str,
-        params: Optional[Dict[str, Any]] = None,
-        headers: Optional[Dict[str, str]] = None,
-        json_data: Optional[JSON] = None,
+        params: dict[str, Any] | None = None,
+        headers: dict[str, str] | None = None,
+        json_data: JSON = None,
         data: Any = None,
         files: Any = None,
     ) -> Response:
@@ -1749,7 +677,7 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         > Note: provided username / password or auth objects take precedence over token
             based security
         """
-        headers = headers if headers else {}
+        headers = deepcopy(headers) if headers else {}
         if self.extra_headers:
             headers.update(self.extra_headers)
         # if both an auth object and a token are available, auth takes precedence
@@ -1774,90 +702,67 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         logger.debug(f"Response text: {response.text}")
         return response
 
+    # endregion
+    # region: validation keywords
     @keyword
     def perform_validated_request(
         self,
         path: str,
         status_code: int,
         request_values: RequestValues,
-        original_data: Optional[Dict[str, Any]] = None,
+        original_data: Mapping[str, object] = default_any_mapping,
     ) -> None:
         """
         This keyword first calls the Authorized Request keyword, then the Validate
         Response keyword and finally validates, for `DELETE` operations, whether
         the target resource was indeed deleted (OK response) or not (error responses).
         """
-        response = run_keyword(
-            "authorized_request",
-            request_values.url,
-            request_values.method,
-            request_values.params,
-            request_values.headers,
-            request_values.json_data,
+        val.perform_validated_request(
+            path=path,
+            status_code=status_code,
+            request_values=request_values,
+            original_data=original_data,
         )
-        if response.status_code != status_code:
-            try:
-                response_json = response.json()
-            except Exception as _:  # pylint: disable=broad-except
-                logger.info(
-                    f"Failed to get json content from response. "
-                    f"Response text was: {response.text}"
-                )
-                response_json = {}
-            if not response.ok:
-                if description := response_json.get("detail"):
-                    pass
-                else:
-                    description = response_json.get(
-                        "message", "response contains no message or detail."
-                    )
-                logger.error(f"{response.reason}: {description}")
-
-            logger.debug(
-                f"\nSend: {_json.dumps(request_values.json_data, indent=4, sort_keys=True)}"
-                f"\nGot: {_json.dumps(response_json, indent=4, sort_keys=True)}"
-            )
-            raise AssertionError(
-                f"Response status_code {response.status_code} was not {status_code}"
-            )
 
-        run_keyword("validate_response", path, response, original_data)
+    @keyword
+    def validate_response_using_validator(
+        self, request: RequestsOpenAPIRequest, response: RequestsOpenAPIResponse
+    ) -> None:
+        """
+        Validate the `response` for a given `request` against the OpenAPI Spec that is
+        loaded during library initialization.
+        """
+        val.validate_response_using_validator(
+            request=request,
+            response=response,
+            response_validator=self.response_validator,
+        )
 
-        if request_values.method == "DELETE":
-            get_request_data = self.get_request_data(endpoint=path, method="GET")
-            get_params = get_request_data.params
-            get_headers = get_request_data.headers
-            get_response = run_keyword(
-                "authorized_request", request_values.url, "GET", get_params, get_headers
-            )
-            if response.ok:
-                if get_response.ok:
-                    raise AssertionError(
-                        f"Resource still exists after deletion. Url was {request_values.url}"
-                    )
-                # if the path supports GET, 404 is expected, if not 405 is expected
-                if get_response.status_code not in [404, 405]:
-                    logger.warning(
-                        f"Unexpected response after deleting resource: Status_code "
-                        f"{get_response.status_code} was received after trying to get {request_values.url} "
-                        f"after sucessfully deleting it."
-                    )
-            elif not get_response.ok:
-                raise AssertionError(
-                    f"Resource could not be retrieved after failed deletion. "
-                    f"Url was {request_values.url}, status_code was {get_response.status_code}"
-                )
+    @keyword
+    def assert_href_to_resource_is_valid(
+        self, href: str, referenced_resource: dict[str, JSON]
+    ) -> None:
+        """
+        Attempt to GET the resource referenced by the `href` and validate it's equal
+        to the provided `referenced_resource` object / dictionary.
+        """
+        val.assert_href_to_resource_is_valid(
+            href=href,
+            origin=self.origin,
+            base_url=self.base_url,
+            referenced_resource=referenced_resource,
+        )
 
     @keyword
     def validate_response(
         self,
         path: str,
         response: Response,
-        original_data: Optional[Dict[str, Any]] = None,
+        original_data: Mapping[str, object] = default_any_mapping,
     ) -> None:
         """
         Validate the `response` by performing the following validations:
-        - validate the `response` against the openapi schema for the `endpoint`
+        - validate the `response` against the openapi schema for the `path`
         - validate that the response does not contain extra properties
         - validate that a href, if present, refers to the correct resource
         - validate that the value for a property that is in the response is equal to
@@ -1865,277 +770,36 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         - validate that no `original_data` is preserved when performing a PUT operation
         - validate that a PATCH operation only updates the provided properties
         """
-        if response.status_code == 204:
-            assert not response.content
-            return None
-
-        try:
-            self._validate_response_against_spec(response)
-        except OpenAPIError as exception:
-            raise Failure(f"Response did not pass schema validation: {exception}")
-
-        request_method = response.request.method
-        if request_method is None:
-            logger.warning(
-                f"Could not validate response for path {path}; no method found "
-                f"on the request property of the provided response."
-            )
-            return None
-
-        response_spec = self._get_response_spec(
+        val.validate_response(
             path=path,
-            method=request_method,
-            status_code=response.status_code,
+            response=response,
+            response_validator=self.response_validator,
+            server_validation_warning_logged=self._server_validation_warning_logged,
+            disable_server_validation=self.disable_server_validation,
+            invalid_property_default_response=self.invalid_property_default_response,
+            response_validation=self.response_validation,
+            openapi_spec=self.openapi_spec,
+            original_data=original_data,
         )
 
-        content_type_from_response = response.headers.get("Content-Type", "unknown")
-        mime_type_from_response, _, _ = content_type_from_response.partition(";")
-
-        if not response_spec.get("content"):
-            logger.warning(
-                "The response cannot be validated: 'content' not specified in the OAS."
-            )
-            return None
-
-        # multiple content types can be specified in the OAS
-        content_types = list(response_spec["content"].keys())
-        supported_types = [
-            ct for ct in content_types if ct.partition(";")[0].endswith("json")
-        ]
-        if not supported_types:
-            raise NotImplementedError(
-                f"The content_types '{content_types}' are not supported. "
-                f"Only json types are currently supported."
-            )
-        content_type = supported_types[0]
-        mime_type = content_type.partition(";")[0]
-
-        if mime_type != mime_type_from_response:
-            raise ValueError(
-                f"Content-Type '{content_type_from_response}' of the response "
-                f"does not match '{mime_type}' as specified in the OpenAPI document."
-            )
-
-        json_response = response.json()
-        response_schema = resolve_schema(
-            response_spec["content"][content_type]["schema"]
-        )
-
-        response_types = response_schema.get("types")
-        if response_types:
-            # In case of oneOf / anyOf there can be multiple possible response types
-            # which makes generic validation too complex
-            return None
-        response_type = response_schema.get("type", "undefined")
-        if response_type not in ["object", "array"]:
-            self._validate_value_type(value=json_response, expected_type=response_type)
-            return None
-
-        if list_item_schema := response_schema.get("items"):
-            if not isinstance(json_response, list):
-                raise AssertionError(
-                    f"Response schema violation: the schema specifies an array as "
-                    f"response type but the response was of type {type(json_response)}."
-                )
-            type_of_list_items = list_item_schema.get("type")
-            if type_of_list_items == "object":
-                for resource in json_response:
-                    run_keyword(
-                        "validate_resource_properties", resource, list_item_schema
-                    )
-            else:
-                for item in json_response:
-                    self._validate_value_type(
-                        value=item, expected_type=type_of_list_items
-                    )
-            # no further validation; value validation of individual resources should
-            # be performed on the endpoints for the specific resource
-            return None
-
-        run_keyword("validate_resource_properties", json_response, response_schema)
-        # ensure the href is valid if present in the response
-        if href := json_response.get("href"):
-            self._assert_href_is_valid(href, json_response)
-        # every property that was sucessfully send and that is in the response
-        # schema must have the value that was send
-        if response.ok and response.request.method in ["POST", "PUT", "PATCH"]:
-            run_keyword("validate_send_response", response, original_data)
-        return None
-
-    def _assert_href_is_valid(self, href: str, json_response: Dict[str, Any]) -> None:
-        url = f"{self.origin}{href}"
-        path = url.replace(self.base_url, "")
-        request_data = self.get_request_data(endpoint=path, method="GET")
-        params = request_data.params
-        headers = request_data.headers
-        get_response = run_keyword("authorized_request", url, "GET", params, headers)
-        assert (
-            get_response.json() == json_response
-        ), f"{get_response.json()} not equal to original {json_response}"
-
-    def _validate_response_against_spec(self, response: Response) -> None:
-        try:
-            self.validate_response_vs_spec(
-                request=RequestsOpenAPIRequest(response.request),
-                response=RequestsOpenAPIResponse(response),
-            )
-        except (ResponseValidationError, ServerNotFound) as exception:
-            errors: List[InvalidSchemaValue] = exception.__cause__
-            validation_errors: Optional[List[ValidationError]] = getattr(
-                errors, "schema_errors", None
-            )
-            if validation_errors:
-                error_message = "\n".join(
-                    [
-                        f"{list(error.schema_path)}: {error.message}"
-                        for error in validation_errors
-                    ]
-                )
-            else:
-                error_message = str(exception)
-
-            if isinstance(exception, ServerNotFound):
-                if not self._server_validation_warning_logged:
-                    logger.warning(
-                        f"ServerNotFound was raised during response validation. "
-                        f"Due to this, no full response validation will be performed."
-                        f"\nThe original error was: {error_message}"
-                    )
-                    self._server_validation_warning_logged = True
-                if self.disable_server_validation:
-                    return
-            if response.status_code == self.invalid_property_default_response:
-                logger.debug(error_message)
-                return
-            if self.response_validation == ValidationLevel.STRICT:
-                logger.error(error_message)
-                raise exception
-            if self.response_validation == ValidationLevel.WARN:
-                logger.warning(error_message)
-            elif self.response_validation == ValidationLevel.INFO:
-                logger.info(error_message)
-
     @keyword
     def validate_resource_properties(
-        self, resource: Dict[str, Any], schema: Dict[str, Any]
+        self, resource: dict[str, JSON], schema: dict[str, JSON]
     ) -> None:
         """
         Validate that the `resource` does not contain any properties that are not
         defined in the `schema_properties`.
         """
-        schema_properties = schema.get("properties", {})
-        property_names_from_schema = set(schema_properties.keys())
-        property_names_in_resource = set(resource.keys())
-
-        if property_names_from_schema != property_names_in_resource:
-            # The additionalProperties property determines whether properties with
-            # unspecified names are allowed. This property can be boolean or an object
-            # (dict) that specifies the type of any additional properties.
-            additional_properties = schema.get("additionalProperties", True)
-            if isinstance(additional_properties, bool):
-                allow_additional_properties = additional_properties
-                allowed_additional_properties_type = None
-            else:
-                allow_additional_properties = True
-                allowed_additional_properties_type = additional_properties["type"]
-
-            extra_property_names = property_names_in_resource.difference(
-                property_names_from_schema
-            )
-            if allow_additional_properties:
-                # If a type is defined for extra properties, validate them
-                if allowed_additional_properties_type:
-                    extra_properties = {
-                        key: value
-                        for key, value in resource.items()
-                        if key in extra_property_names
-                    }
-                    self._validate_type_of_extra_properties(
-                        extra_properties=extra_properties,
-                        expected_type=allowed_additional_properties_type,
-                    )
-                # If allowed, validation should not fail on extra properties
-                extra_property_names = set()
-
-            required_properties = set(schema.get("required", []))
-            missing_properties = required_properties.difference(
-                property_names_in_resource
-            )
-
-            if extra_property_names or missing_properties:
-                extra = (
-                    f"\n\tExtra properties in response: {extra_property_names}"
-                    if extra_property_names
-                    else ""
-                )
-                missing = (
-                    f"\n\tRequired properties missing in response: {missing_properties}"
-                    if missing_properties
-                    else ""
-                )
-                raise AssertionError(
-                    f"Response schema violation: the response contains properties that are "
-                    f"not specified in the schema or does not contain properties that are "
-                    f"required according to the schema."
-                    f"\n\tReceived in the response: {property_names_in_resource}"
-                    f"\n\tDefined in the schema:    {property_names_from_schema}"
-                    f"{extra}{missing}"
-                )
-
-    @staticmethod
-    def _validate_value_type(value: Any, expected_type: str) -> None:
-        type_mapping = {
-            "string": str,
-            "number": float,
-            "integer": int,
-            "boolean": bool,
-            "array": list,
-            "object": dict,
-        }
-        python_type = type_mapping.get(expected_type, None)
-        if python_type is None:
-            raise AssertionError(
-                f"Validation of type '{expected_type}' is not supported."
-            )
-        if not isinstance(value, python_type):
-            raise AssertionError(f"{value} is not of type {expected_type}")
-
-    @staticmethod
-    def _validate_type_of_extra_properties(
-        extra_properties: Dict[str, Any], expected_type: str
-    ) -> None:
-        type_mapping = {
-            "string": str,
-            "number": float,
-            "integer": int,
-            "boolean": bool,
-            "array": list,
-            "object": dict,
-        }
-
-        python_type = type_mapping.get(expected_type, None)
-        if python_type is None:
-            logger.warning(
-                f"Additonal properties were not validated: "
-                f"type '{expected_type}' is not supported."
-            )
-            return
-
-        invalid_extra_properties = {
-            key: value
-            for key, value in extra_properties.items()
-            if not isinstance(value, python_type)
-        }
-        if invalid_extra_properties:
-            raise AssertionError(
-                f"Response contains invalid additionalProperties: "
-                f"{invalid_extra_properties} are not of type {expected_type}."
-            )
+        val.validate_resource_properties(
+            resource=resource,
+            schema=schema,
+        )
 
     @staticmethod
     @keyword
     def validate_send_response(
-        response: Response, original_data: Optional[Dict[str, Any]] = None
+        response: Response,
+        original_data: Mapping[str, object] = default_any_mapping,
     ) -> None:
         """
         Validate that each property that was send that is in the response has the value
@@ -2143,102 +807,132 @@ class OpenApiLibCore:  # pylint: disable=too-many-instance-attributes
         In case a PATCH request, validate that only the properties that were patched
         have changed and that other properties are still at their pre-patch values.
         """
+        val.validate_send_response(response=response, original_data=original_data)
+
+    # endregion
+
+    @property
+    def origin(self) -> str:
+        return self._origin
+
+    @property
+    def base_url(self) -> str:
+        return f"{self.origin}{self._base_path}"
+
+    @cached_property
+    def validation_spec(self) -> Spec:
+        _, validation_spec, _ = self._load_specs_and_validator()
+        return validation_spec
 
-        def validate_list_response(
-            send_list: List[Any], received_list: List[Any]
-        ) -> None:
-            for item in send_list:
-                if item not in received_list:
-                    raise AssertionError(
-                        f"Received value '{received_list}' does "
-                        f"not contain '{item}' in the {response.request.method} request."
-                        f"\nSend: {_json.dumps(send_json, indent=4, sort_keys=True)}"
-                        f"\nGot: {_json.dumps(response_data, indent=4, sort_keys=True)}"
-                    )
-
-        def validate_dict_response(
-            send_dict: Dict[str, Any], received_dict: Dict[str, Any]
-        ) -> None:
-            for send_property_name, send_property_value in send_dict.items():
-                # sometimes, a property in the request is not in the response, e.g. a password
-                if send_property_name not in received_dict.keys():
-                    continue
-                if send_property_value is not None:
-                    # if a None value is send, the target property should be cleared or
-                    # reverted to the default value (which cannot be specified in the
-                    # openapi document)
-                    received_value = received_dict[send_property_name]
-                    # In case of lists / arrays, the send values are often appended to
-                    # existing data
-                    if isinstance(received_value, list):
-                        validate_list_response(
-                            send_list=send_property_value, received_list=received_value
-                        )
-                        continue
-
-                    # when dealing with objects, we'll need to iterate the properties
-                    if isinstance(received_value, dict):
-                        validate_dict_response(
-                            send_dict=send_property_value, received_dict=received_value
-                        )
-                        continue
-
-                    assert received_value == send_property_value, (
-                        f"Received value for {send_property_name} '{received_value}' does not "
-                        f"match '{send_property_value}' in the {response.request.method} request."
-                        f"\nSend: {_json.dumps(send_json, indent=4, sort_keys=True)}"
-                        f"\nGot: {_json.dumps(response_data, indent=4, sort_keys=True)}"
-                    )
-
-        if response.request.body is None:
-            logger.warning(
-                "Could not validate send response; the body of the request property "
-                "on the provided response was None."
+    @property
+    def openapi_spec(self) -> dict[str, JSON]:
+        """Return a deepcopy of the parsed openapi document."""
+        # protect the parsed openapi spec from being mutated by reference
+        return deepcopy(self._openapi_spec)
+
+    @cached_property
+    def _openapi_spec(self) -> dict[str, JSON]:
+        parser, _, _ = self._load_specs_and_validator()
+        spec_dict: dict[str, JSON] = parser.specification
+        register_path_parameters(spec_dict["paths"])
+        return spec_dict
+
+    @cached_property
+    def response_validator(
+        self,
+    ) -> ResponseValidatorType:
+        _, _, response_validator = self._load_specs_and_validator()
+        return response_validator
+
+    def _get_json_types_from_spec(self, spec: dict[str, JSON]) -> set[str]:
+        json_types: set[str] = set(self._get_json_types(spec))
+        return {json_type for json_type in json_types if json_type is not None}
+
+    def _get_json_types(self, item: object) -> Generator[str, None, None]:
+        if isinstance(item, dict):
+            content_dict = item.get("content")
+            if content_dict is None:
+                for value in item.values():
+                    yield from self._get_json_types(value)
+
+            else:
+                for content_type in content_dict:
+                    if "json" in content_type:
+                        content_type_without_charset, _, _ = content_type.partition(";")
+                        yield content_type_without_charset
+
+        if isinstance(item, list):
+            for list_item in item:
+                yield from self._get_json_types(list_item)
+
+    def _load_specs_and_validator(
+        self,
+    ) -> tuple[
+        ResolvingParser,
+        Spec,
+        ResponseValidatorType,
+    ]:
+        def recursion_limit_handler(
+            limit: int,  # pylint: disable=unused-argument
+            refstring: str,  # pylint: disable=unused-argument
+            recursions: JSON,  # pylint: disable=unused-argument
+        ) -> JSON:
+            return self._recursion_default
+
+        try:
+            # Since parsing of the OAS and creating the Spec can take a long time,
+            # they are cached. This is done by storing them in an imported module that
+            # will have a global scope due to how the Python import system works. This
+            # ensures that in a Suite of Suites where multiple Suites use the same
+            # `source`, that OAS is only parsed / loaded once.
+            cached_parser = PARSER_CACHE.get(self._source, None)
+            if cached_parser:
+                return (
+                    cached_parser.parser,
+                    cached_parser.validation_spec,
+                    cached_parser.response_validator,
+                )
+
+            parser = ResolvingParser(
+                self._source,
+                backend="openapi-spec-validator",
+                recursion_limit=self._recursion_limit,
+                recursion_limit_handler=recursion_limit_handler,
             )
-            return None
-        if isinstance(response.request.body, bytes):
-            send_json = _json.loads(response.request.body.decode("UTF-8"))
-        else:
-            send_json = _json.loads(response.request.body)
-
-        response_data = response.json()
-        # POST on /resource_type/{id}/array_item/ will return the updated {id} resource
-        # instead of a newly created resource. In this case, the send_json must be
-        # in the array of the 'array_item' property on {id}
-        send_path: str = response.request.path_url
-        response_path = response_data.get("href", None)
-        if response_path and send_path not in response_path:
-            property_to_check = send_path.replace(response_path, "")[1:]
-            if response_data.get(property_to_check) and isinstance(
-                response_data[property_to_check], list
-            ):
-                item_list: List[Dict[str, Any]] = response_data[property_to_check]
-                # Use the (mandatory) id to get the POSTed resource from the list
-                [response_data] = [
-                    item for item in item_list if item["id"] == send_json["id"]
-                ]
-
-        # incoming arguments are dictionaries, so they can be validated as such
-        validate_dict_response(send_dict=send_json, received_dict=response_data)
-
-        # In case of PATCH requests, ensure that only send properties have changed
-        if original_data:
-            for send_property_name, send_value in original_data.items():
-                if send_property_name not in send_json.keys():
-                    assert send_value == response_data[send_property_name], (
-                        f"Received value for {send_property_name} '{response_data[send_property_name]}' does not "
-                        f"match '{send_value}' in the pre-patch data"
-                        f"\nPre-patch: {_json.dumps(original_data, indent=4, sort_keys=True)}"
-                        f"\nGot: {_json.dumps(response_data, indent=4, sort_keys=True)}"
-                    )
-        return None
-
-    def _get_response_spec(
-        self, path: str, method: str, status_code: int
-    ) -> Dict[str, Any]:
-        method = method.lower()
-        status = str(status_code)
-        spec: Dict[str, Any] = {**self.openapi_spec}["paths"][path][method][
-            "responses"
-        ][status]
-        return spec
+
+            if parser.specification is None:  # pragma: no cover
+                raise FatalError(
+                    "Source was loaded, but no specification was present after parsing."
+                )
+
+            validation_spec = Spec.from_dict(parser.specification)  # pyright: ignore[reportArgumentType]
+
+            json_types_from_spec: set[str] = self._get_json_types_from_spec(
+                parser.specification
+            )
+            extra_deserializers = {
+                json_type: _json.loads for json_type in json_types_from_spec
+            }
+            config = Config(extra_media_type_deserializers=extra_deserializers)  # type: ignore[arg-type]
+            openapi = OpenAPI(spec=validation_spec, config=config)
+            response_validator: ResponseValidatorType = openapi.validate_response  # type: ignore[assignment]
+
+            PARSER_CACHE[self._source] = CachedParser(
+                parser=parser,
+                validation_spec=validation_spec,
+                response_validator=response_validator,
+            )
+
+            return parser, validation_spec, response_validator
+
+        except ResolutionError as exception:
+            raise FatalError(
+                f"ResolutionError while trying to load openapi spec: {exception}"
+            ) from exception
+        except ValidationError as exception:
+            raise FatalError(
+                f"ValidationError while trying to load openapi spec: {exception}"
+            ) from exception
+
+    def read_paths(self) -> dict[str, JSON]:
+        return self.openapi_spec["paths"]  # type: ignore[return-value]