diff --git a/docs/openapi_libcore.html b/docs/openapi_libcore.html
index 7b861be..f07e94e 100644
--- a/docs/openapi_libcore.html
+++ b/docs/openapi_libcore.html
@@ -1180,7 +1180,7 @@
 jQuery.extend({highlight:function(e,t,n,r){if(e.nodeType===3){var i=e.data.match(t);if(i){var s=document.createElement(n||"span");s.className=r||"highlight";var o=e.splitText(i.index);o.splitText(i[0].length);var u=o.cloneNode(true);s.appendChild(u);o.parentNode.replaceChild(s,o);return 1}}else if(e.nodeType===1&&e.childNodes&&!/(script|style)/i.test(e.tagName)&&!(e.tagName===n.toUpperCase()&&e.className===r)){for(var a=0;a<e.childNodes.length;a++){a+=jQuery.highlight(e.childNodes[a],t,n,r)}}return 0}});jQuery.fn.unhighlight=function(e){var t={className:"highlight",element:"span"};jQuery.extend(t,e);return this.find(t.element+"."+t.className).each(function(){var e=this.parentNode;e.replaceChild(this.firstChild,this);e.normalize()}).end()};jQuery.fn.highlight=function(e,t){var n={className:"highlight",element:"span",caseSensitive:false,wordsOnly:false};jQuery.extend(n,t);if(e.constructor===String){e=[e]}e=jQuery.grep(e,function(e,t){return e!=""});e=jQuery.map(e,function(e,t){return e.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&")});if(e.length==0){return this}var r=n.caseSensitive?"":"i";var i="("+e.join("|")+")";if(n.wordsOnly){i="\\b"+i+"\\b"}var s=new RegExp(i,r);return this.each(function(){jQuery.highlight(this,s,n.element,n.className)})}
 </script>
 <script type="text/javascript">
-libdoc = {"specversion": 2, "name": "OpenApiLibCore", "doc": "<p>Main class providing the keywords and core logic to interact with an OpenAPI server.</p>\n<p>Visit the <a href=\"https://github.com/MarketSquare/robotframework-openapi-libcore\">library page</a> for an introduction.</p>", "version": "0.1.1", "generated": "2024-03-08T16:26:36+00:00", "type": "LIBRARY", "scope": "SUITE", "docFormat": "HTML", "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 375, "tags": [], "inits": [{"name": "__init__", "args": [{"name": "source", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source: str"}, {"name": "origin", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "origin: str = "}, {"name": "base_path", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "base_path: str = "}, {"name": "mappings_path", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Path", "typedoc": "Path", "nested": [], "union": false}], "union": true}, "types": ["str", "Path"], "typedocs": {"str": "string", "Path": "Path"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "mappings_path: str | Path = "}, {"name": "invalid_property_default_response", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "422", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "invalid_property_default_response: int = 422"}, {"name": "default_id_property_name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "id", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "default_id_property_name: str = id"}, {"name": "faker_locale", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "List[str]", "None"], "typedocs": {"str": "string", "List": "list", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "faker_locale: str | List[str] | None = None"}, {"name": "recursion_limit", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "recursion_limit: int = 1"}, {"name": "recursion_default", "type": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "types": ["Any"], "typedocs": {"Any": "Any"}, "defaultValue": "{}", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "recursion_default: Any = {}"}, {"name": "username", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "username: str = "}, {"name": "password", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "password: str = "}, {"name": "security_token", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "security_token: str = "}, {"name": "auth", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AuthBase", "typedoc": null, "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["AuthBase", "None"], "typedocs": {"None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "auth: AuthBase | None = None"}, {"name": "cert", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Tuple", "typedoc": "tuple", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "Tuple[str, str]", "None"], "typedocs": {"str": "string", "Tuple": "tuple", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cert: str | Tuple[str, str] | None = None"}, {"name": "verify_tls", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["bool", "str", "None"], "typedocs": {"bool": "boolean", "str": "string", "None": "None"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "verify_tls: bool | str | None = True"}, {"name": "extra_headers", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, str]", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "extra_headers: Dict[str, str] | None = None"}, {"name": "cookies", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "RequestsCookieJar", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, str]", "RequestsCookieJar", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "RequestsCookieJar": "dictionary", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cookies: Dict[str, str] | RequestsCookieJar | None = None"}, {"name": "proxies", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, str]", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "proxies: Dict[str, str] | None = None"}], "doc": "<h3>Base parameters</h3>\n<h4>source</h4>\n<p>An absolute path to an openapi.json or openapi.yaml file or an url to such a file.</p>\n<h4>origin</h4>\n<p>The server (and port) of the target server. E.g. <code>https://localhost:8000</code></p>\n<h4>base_path</h4>\n<p>The routing between <code>origin</code> and the endpoints as found in the <code>paths</code> section in the openapi document. E.g. <code>/petshop/v2</code>.</p>\n<h3>API-specific configurations</h3>\n<h4>mappings_path</h4>\n<p>See <a href=\"https://marketsquare.github.io/robotframework-openapi-libcore/advanced_use.html\">this page</a> for an in-depth explanation.</p>\n<h4>invalid_property_default_response</h4>\n<p>The default response code for requests with a JSON body that does not comply with the schema. Example: a value outside the specified range or a string value for a property defined as integer in the schema.</p>\n<h4>default_id_property_name</h4>\n<p>The default name for the property that identifies a resource (i.e. a unique entity) within the API. The default value for this property name is <code>id</code>. If the target API uses a different name for all the resources within the API, you can configure it globally using this property.</p>\n<p>If different property names are used for the unique identifier for different types of resources, an <code>ID_MAPPING</code> can be implemented using the <code>mappings_path</code>.</p>\n<h4>faker_locale</h4>\n<p>A locale string or list of locale strings to pass to the Faker library to be used in generation of string data for supported format types.</p>\n<h3>Parsing parameters</h3>\n<h4>recursion_limit</h4>\n<p>The recursion depth to which to fully parse recursive references before the <span class=\"name\">recursion_default</span> is used to end the recursion.</p>\n<h4>recursion_default</h4>\n<p>The value that is used instead of the referenced schema when the <span class=\"name\">recursion_limit</span> has been reached. The default <span class=\"name\">{}</span> represents an empty object in JSON. Depending on schema definitions, this may cause schema validation errors. If this is the case, 'None' (<code>${NONE}</code> in Robot Framework) or an empty list can be tried as an alternative.</p>\n<h3>Security-related parameters</h3>\n<p><i>Note: these parameters are equivalent to those in the <code>requests</code> library.</i></p>\n<h4>username</h4>\n<p>The username to be used for Basic Authentication.</p>\n<h4>password</h4>\n<p>The password to be used for Basic Authentication.</p>\n<h4>security_token</h4>\n<p>The token to be used for token based security using the <code>Authorization</code> header.</p>\n<h4>auth</h4>\n<p>A <a href=\"https://requests.readthedocs.io/en/latest/api/#authentication\">requests <code>AuthBase</code> instance</a> to be used for authentication instead of the <code>username</code> and <code>password</code>.</p>\n<h4>cert</h4>\n<p>The SSL certificate to use with all requests. If string: the path to ssl client cert file (.pem). If tuple: the ('cert', 'key') pair.</p>\n<h4>verify_tls</h4>\n<p>Whether or not to verify the TLS / SSL certificate of the server. If boolean: whether or not to verify the server TLS certificate. If string: path to a CA bundle to use for verification.</p>\n<h4>extra_headers</h4>\n<p>A dictionary with extra / custom headers that will be send with every request. This parameter can be used to send headers that are not documented in the openapi document or to provide an API-key.</p>\n<h4>cookies</h4>\n<p>A dictionary or <a href=\"https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookieJar\">CookieJar object</a> to send with all requests.</p>\n<h4>proxies</h4>\n<p>A dictionary of 'protocol': 'proxy url' to use for all requests.</p>", "shortdoc": "== Base parameters ==", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 383}], "keywords": [{"name": "Authorized Request", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}, {"name": "params", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Any", "typedoc": "Any", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, Any]", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "Any": "Any", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "params: Dict[str, Any] | None = None"}, {"name": "headers", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, str]", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers: Dict[str, str] | None = None"}, {"name": "json_data", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "ForwardRef('JSON')", "typedoc": null, "nested": [], "union": false}], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "ForwardRef('JSON')", "typedoc": null, "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "ForwardRef('JSON')", "typedoc": null, "nested": [], "union": false}], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "ForwardRef('JSON')", "typedoc": null, "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None]", "List[Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None]", "str", "int", "float", "bool", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "List": "list", "int": "integer", "float": "float", "bool": "boolean", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "json_data: Dict[str, Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None] | List[Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None] | str | int | float | bool | None = None"}], "doc": "<p>Perform a request using the security token or authentication set in the library.</p>\n<p>&gt; Note: provided username / password or auth objects take precedence over token based security</p>", "shortdoc": "Perform a request using the security token or authentication set in the library.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 1457}, {"name": "Ensure In Use", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "resource_relation", "type": {"name": "IdReference", "typedoc": null, "nested": [], "union": false}, "types": ["IdReference"], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "resource_relation: IdReference"}], "doc": "<p>Ensure that the (right-most) <span class=\"name\">id</span> of the resource referenced by the <span class=\"name\">url</span> is used by the resource defined by the <span class=\"name\">resource_relation</span>.</p>", "shortdoc": "Ensure that the (right-most) `id` of the resource referenced by the `url` is used by the resource defined by the `resource_relation`.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 1361}, {"name": "Get Ids From Url", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}], "doc": "<p>Perform a GET request on the <span class=\"name\">url</span> and return the list of resource <span class=\"name\">ids</span> from the response.</p>", "shortdoc": "Perform a GET request on the `url` and return the list of resource `ids` from the response.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 774}, {"name": "Get Invalid Json Data", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}, {"name": "status_code", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "status_code: int"}, {"name": "request_data", "type": {"name": "RequestData", "typedoc": null, "nested": [], "union": false}, "types": ["RequestData"], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "request_data: RequestData"}], "doc": "<p>Return <span class=\"name\">json_data</span> based on the <span class=\"name\">dto</span> on the <span class=\"name\">request_data</span> that will cause the provided <span class=\"name\">status_code</span> for the <span class=\"name\">method</span> operation on the <span class=\"name\">url</span>.</p>\n<p>&gt; Note: applicable UniquePropertyValueConstraint and IdReference Relations are considered before changes to <span class=\"name\">json_data</span> are made.</p>", "shortdoc": "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`.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 1138}, {"name": "Get Invalidated Parameters", "args": [{"name": "status_code", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "status_code: int"}, {"name": "request_data", "type": {"name": "RequestData", "typedoc": null, "nested": [], "union": false}, "types": ["RequestData"], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "request_data: RequestData"}], "doc": "<p>Returns a version of <span class=\"name\">params, headers</span> as present on <span class=\"name\">request_data</span> that has been modified to cause the provided <span class=\"name\">status_code</span>.</p>", "shortdoc": "Returns a version of `params, headers` as present on `request_data` that has been modified to cause the provided `status_code`.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 1186}, {"name": "Get Invalidated Url", "args": [{"name": "valid_url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "valid_url: str"}], "doc": "<p>Return an url with all the path parameters in the <span class=\"name\">valid_url</span> replaced by a random UUID.</p>\n<p>Raises ValueError if the valid_url cannot be invalidated.</p>", "shortdoc": "Return an url with all the path parameters in the `valid_url` replaced by a random UUID.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 1104}, {"name": "Get Json Data For Dto Class", "args": [{"name": "schema", "type": {"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Any", "typedoc": "Any", "nested": [], "union": false}], "union": false}, "types": ["Dict[str, Any]"], "typedocs": {"Dict": "dictionary", "str": "string", "Any": "Any"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "schema: Dict[str, Any]"}, {"name": "dto_class", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dto", "typedoc": null, "nested": [], "union": false}, {"name": "Type", "typedoc": null, "nested": [{"name": "Dto", "typedoc": null, "nested": [], "union": false}], "union": false}], "union": true}, "types": ["Dto", "Type[Dto]"], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "dto_class: Dto | Type[Dto]"}, {"name": "operation_id", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "operation_id: str = "}], "doc": "<p>Generate a valid (json-compatible) dict for all the <span class=\"name\">dto_class</span> properties.</p>", "shortdoc": "Generate a valid (json-compatible) dict for all the `dto_class` properties.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 1007}, {"name": "Get Json Data With Conflict", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}, {"name": "dto", "type": {"name": "Dto", "typedoc": null, "nested": [], "union": false}, "types": ["Dto"], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "dto: Dto"}, {"name": "conflict_status_code", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "conflict_status_code: int"}], "doc": "<p>Return <span class=\"name\">json_data</span> based on the <span class=\"name\">UniquePropertyValueConstraint</span> that must be returned by the <span class=\"name\">get_relations</span> implementation on the <span class=\"name\">dto</span> for the given <span class=\"name\">conflict_status_code</span>.</p>", "shortdoc": "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`.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 1405}, {"name": "Get Parameterized Endpoint From Url", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}], "doc": "<p>Return the endpoint as found in the <span class=\"name\">paths</span> section based on the given <span class=\"name\">url</span>.</p>", "shortdoc": "Return the endpoint as found in the `paths` section based on the given `url`.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 1126}, {"name": "Get Request Data", "args": [{"name": "endpoint", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "endpoint: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}], "doc": "<p>Return an object with valid request data for body, headers and query params.</p>", "shortdoc": "Return an object with valid request data for body, headers and query params.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 814}, {"name": "Get Valid Id For Endpoint", "args": [{"name": "endpoint", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "endpoint: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}], "doc": "<p>Support keyword that returns the <span class=\"name\">id</span> for an existing resource at <span class=\"name\">endpoint</span>.</p>\n<p>To prevent resource conflicts with other test cases, a new resource is created (POST) if possible.</p>", "shortdoc": "Support keyword that returns the `id` for an existing resource at `endpoint`.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 678}, {"name": "Get Valid Url", "args": [{"name": "endpoint", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "endpoint: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}], "doc": "<p>This keyword returns a valid url for the given <span class=\"name\">endpoint</span> and <span class=\"name\">method</span>.</p>\n<p>If the <span class=\"name\">endpoint</span> contains path parameters the Get Valid Id For Endpoint keyword will be executed to retrieve valid ids for the path parameters.</p>\n<p>&gt; Note: if valid ids cannot be retrieved within the scope of the API, the <span class=\"name\">PathPropertiesConstraint</span> Relation can be used. More information can be found <a href=\"https://marketsquare.github.io/robotframework-openapi-libcore/advanced_use.html\">here</a>.</p>", "shortdoc": "This keyword returns a valid url for the given `endpoint` and `method`.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 638}, {"name": "Set Origin", "args": [{"name": "origin", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "origin: str"}], "doc": "<p>Update the <span class=\"name\">origin</span> after the library is imported.</p>\n<p>This can be done during the <span class=\"name\">Suite setup</span> when using DataDriver in situations where the OpenAPI document is available on disk but the target host address is not known before the test starts.</p>\n<p>In combination with OpenApiLibCore, the <span class=\"name\">origin</span> can be used at any point to target another server that hosts an API that complies to the same OAS.</p>", "shortdoc": "Update the `origin` after the library is imported.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 552}], "dataTypes": {"enums": [], "typedDicts": []}, "typedocs": [{"type": "Standard", "name": "Any", "doc": "<p>Any value is accepted. No conversion is done.</p>", "usages": ["__init__", "Authorized Request", "Get Json Data For Dto Class"], "accepts": ["Any"]}, {"type": "Standard", "name": "boolean", "doc": "<p>Strings <code>TRUE</code>, <code>YES</code>, <code>ON</code> and <code>1</code> are converted to Boolean <code>True</code>, the empty string as well as strings <code>FALSE</code>, <code>NO</code>, <code>OFF</code> and <code>0</code> are converted to Boolean <code>False</code>, and the string <code>NONE</code> is converted to the Python <code>None</code> object. Other strings and other accepted values are passed as-is, allowing keywords to handle them specially if needed. All string comparisons are case-insensitive.</p>\n<p>Examples: <code>TRUE</code> (converted to <code>True</code>), <code>off</code> (converted to <code>False</code>), <code>example</code> (used as-is)</p>", "usages": ["__init__", "Authorized Request"], "accepts": ["string", "integer", "float", "None"]}, {"type": "Standard", "name": "dictionary", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#dict\">dictionary</a> literals. They are converted to actual dictionaries using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including dictionaries and other containers.</p>\n<p>If the type has nested types like <code>dict[str, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>{'a': 1, 'b': 2}</code>, <code>{'key': 1, 'nested': {'key': 2}}</code></p>", "usages": ["__init__", "Authorized Request", "Get Json Data For Dto Class"], "accepts": ["string", "Mapping"]}, {"type": "Standard", "name": "float", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#float\">float</a> built-in function.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>3.14</code>, <code>2.9979e8</code>, <code>10 000.000 01</code></p>", "usages": ["Authorized Request"], "accepts": ["string", "Real"]}, {"type": "Standard", "name": "integer", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#int\">int</a> built-in function. Floating point numbers are accepted only if they can be represented as integers exactly. For example, <code>1.0</code> is accepted and <code>1.1</code> is not.</p>\n<p>Starting from RF 4.1, it is possible to use hexadecimal, octal and binary numbers by prefixing values with <code>0x</code>, <code>0o</code> and <code>0b</code>, respectively.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>42</code>, <code>-1</code>, <code>0b1010</code>, <code>10 000 000</code>, <code>0xBAD_C0FFEE</code></p>", "usages": ["__init__", "Authorized Request", "Get Invalid Json Data", "Get Invalidated Parameters", "Get Json Data With Conflict"], "accepts": ["string", "float"]}, {"type": "Standard", "name": "list", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#list\">list</a> literals. They are converted to actual lists using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including lists and other containers.</p>\n<p>If the type has nested types like <code>list[int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>['one', 'two']</code>, <code>[('one', 1), ('two', 2)]</code></p>", "usages": ["__init__", "Authorized Request"], "accepts": ["string", "Sequence"]}, {"type": "Standard", "name": "None", "doc": "<p>String <code>NONE</code> (case-insensitive) is converted to Python <code>None</code> object. Other values cause an error.</p>", "usages": ["__init__", "Authorized Request"], "accepts": ["string"]}, {"type": "Standard", "name": "Path", "doc": "<p>Strings are converted <a href=\"https://docs.python.org/library/pathlib.html\">Path</a> objects. On Windows <code>/</code> is converted to <code>\\</code> automatically.</p>\n<p>Examples: <code>/tmp/absolute/path</code>, <code>relative/path/to/file.ext</code>, <code>name.txt</code></p>", "usages": ["__init__"], "accepts": ["string", "PurePath"]}, {"type": "Standard", "name": "string", "doc": "<p>All arguments are converted to Unicode strings.</p>", "usages": ["__init__", "Authorized Request", "Ensure In Use", "Get Ids From Url", "Get Invalid Json Data", "Get Invalidated Url", "Get Json Data For Dto Class", "Get Json Data With Conflict", "Get Parameterized Endpoint From Url", "Get Request Data", "Get Valid Id For Endpoint", "Get Valid Url", "Set Origin"], "accepts": ["Any"]}, {"type": "Standard", "name": "tuple", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#tuple\">tuple</a> literals. They are converted to actual tuples using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including tuples and other containers.</p>\n<p>If the type has nested types like <code>tuple[str, int, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>('one', 'two')</code>, <code>(('one', 1), ('two', 2))</code></p>", "usages": ["__init__"], "accepts": ["string", "Sequence"]}]}
+libdoc = {"specversion": 2, "name": "OpenApiLibCore", "doc": "<p>Main class providing the keywords and core logic to interact with an OpenAPI server.</p>\n<p>Visit the <a href=\"https://github.com/MarketSquare/robotframework-openapi-libcore\">library page</a> for an introduction.</p>", "version": "0.1.2", "generated": "2024-03-15T20:27:48+00:00", "type": "LIBRARY", "scope": "SUITE", "docFormat": "HTML", "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 377, "tags": [], "inits": [{"name": "__init__", "args": [{"name": "source", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source: str"}, {"name": "origin", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "origin: str = "}, {"name": "base_path", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "base_path: str = "}, {"name": "mappings_path", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Path", "typedoc": "Path", "nested": [], "union": false}], "union": true}, "types": ["str", "Path"], "typedocs": {"str": "string", "Path": "Path"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "mappings_path: str | Path = "}, {"name": "invalid_property_default_response", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "422", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "invalid_property_default_response: int = 422"}, {"name": "default_id_property_name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "id", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "default_id_property_name: str = id"}, {"name": "faker_locale", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "List[str]", "None"], "typedocs": {"str": "string", "List": "list", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "faker_locale: str | List[str] | None = None"}, {"name": "recursion_limit", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "recursion_limit: int = 1"}, {"name": "recursion_default", "type": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "types": ["Any"], "typedocs": {"Any": "Any"}, "defaultValue": "{}", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "recursion_default: Any = {}"}, {"name": "username", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "username: str = "}, {"name": "password", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "password: str = "}, {"name": "security_token", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "security_token: str = "}, {"name": "auth", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AuthBase", "typedoc": null, "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["AuthBase", "None"], "typedocs": {"None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "auth: AuthBase | None = None"}, {"name": "cert", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Tuple", "typedoc": "tuple", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "Tuple[str, str]", "None"], "typedocs": {"str": "string", "Tuple": "tuple", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cert: str | Tuple[str, str] | None = None"}, {"name": "verify_tls", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["bool", "str", "None"], "typedocs": {"bool": "boolean", "str": "string", "None": "None"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "verify_tls: bool | str | None = True"}, {"name": "extra_headers", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, str]", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "extra_headers: Dict[str, str] | None = None"}, {"name": "cookies", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "RequestsCookieJar", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, str]", "RequestsCookieJar", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "RequestsCookieJar": "dictionary", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cookies: Dict[str, str] | RequestsCookieJar | None = None"}, {"name": "proxies", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, str]", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "proxies: Dict[str, str] | None = None"}], "doc": "<h3>Base parameters</h3>\n<h4>source</h4>\n<p>An absolute path to an openapi.json or openapi.yaml file or an url to such a file.</p>\n<h4>origin</h4>\n<p>The server (and port) of the target server. E.g. <code>https://localhost:8000</code></p>\n<h4>base_path</h4>\n<p>The routing between <code>origin</code> and the endpoints as found in the <code>paths</code> section in the openapi document. E.g. <code>/petshop/v2</code>.</p>\n<h3>API-specific configurations</h3>\n<h4>mappings_path</h4>\n<p>See <a href=\"https://marketsquare.github.io/robotframework-openapi-libcore/advanced_use.html\">this page</a> for an in-depth explanation.</p>\n<h4>invalid_property_default_response</h4>\n<p>The default response code for requests with a JSON body that does not comply with the schema. Example: a value outside the specified range or a string value for a property defined as integer in the schema.</p>\n<h4>default_id_property_name</h4>\n<p>The default name for the property that identifies a resource (i.e. a unique entity) within the API. The default value for this property name is <code>id</code>. If the target API uses a different name for all the resources within the API, you can configure it globally using this property.</p>\n<p>If different property names are used for the unique identifier for different types of resources, an <code>ID_MAPPING</code> can be implemented using the <code>mappings_path</code>.</p>\n<h4>faker_locale</h4>\n<p>A locale string or list of locale strings to pass to the Faker library to be used in generation of string data for supported format types.</p>\n<h3>Parsing parameters</h3>\n<h4>recursion_limit</h4>\n<p>The recursion depth to which to fully parse recursive references before the <span class=\"name\">recursion_default</span> is used to end the recursion.</p>\n<h4>recursion_default</h4>\n<p>The value that is used instead of the referenced schema when the <span class=\"name\">recursion_limit</span> has been reached. The default <span class=\"name\">{}</span> represents an empty object in JSON. Depending on schema definitions, this may cause schema validation errors. If this is the case, 'None' (<code>${NONE}</code> in Robot Framework) or an empty list can be tried as an alternative.</p>\n<h3>Security-related parameters</h3>\n<p><i>Note: these parameters are equivalent to those in the <code>requests</code> library.</i></p>\n<h4>username</h4>\n<p>The username to be used for Basic Authentication.</p>\n<h4>password</h4>\n<p>The password to be used for Basic Authentication.</p>\n<h4>security_token</h4>\n<p>The token to be used for token based security using the <code>Authorization</code> header.</p>\n<h4>auth</h4>\n<p>A <a href=\"https://requests.readthedocs.io/en/latest/api/#authentication\">requests <code>AuthBase</code> instance</a> to be used for authentication instead of the <code>username</code> and <code>password</code>.</p>\n<h4>cert</h4>\n<p>The SSL certificate to use with all requests. If string: the path to ssl client cert file (.pem). If tuple: the ('cert', 'key') pair.</p>\n<h4>verify_tls</h4>\n<p>Whether or not to verify the TLS / SSL certificate of the server. If boolean: whether or not to verify the server TLS certificate. If string: path to a CA bundle to use for verification.</p>\n<h4>extra_headers</h4>\n<p>A dictionary with extra / custom headers that will be send with every request. This parameter can be used to send headers that are not documented in the openapi document or to provide an API-key.</p>\n<h4>cookies</h4>\n<p>A dictionary or <a href=\"https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookieJar\">CookieJar object</a> to send with all requests.</p>\n<h4>proxies</h4>\n<p>A dictionary of 'protocol': 'proxy url' to use for all requests.</p>", "shortdoc": "== Base parameters ==", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 385}], "keywords": [{"name": "Authorized Request", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}, {"name": "params", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Any", "typedoc": "Any", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, Any]", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "Any": "Any", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "params: Dict[str, Any] | None = None"}, {"name": "headers", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, str]", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "headers: Dict[str, str] | None = None"}, {"name": "json_data", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "ForwardRef('JSON')", "typedoc": null, "nested": [], "union": false}], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "ForwardRef('JSON')", "typedoc": null, "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "ForwardRef('JSON')", "typedoc": null, "nested": [], "union": false}], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "ForwardRef('JSON')", "typedoc": null, "nested": [], "union": false}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}, {"name": "float", "typedoc": "float", "nested": [], "union": false}, {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None]", "List[Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None]", "str", "int", "float", "bool", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "List": "list", "int": "integer", "float": "float", "bool": "boolean", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "json_data: Dict[str, Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None] | List[Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None] | str | int | float | bool | None = None"}], "doc": "<p>Perform a request using the security token or authentication set in the library.</p>\n<p>&gt; Note: provided username / password or auth objects take precedence over token based security</p>", "shortdoc": "Perform a request using the security token or authentication set in the library.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 1477}, {"name": "Ensure In Use", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "resource_relation", "type": {"name": "IdReference", "typedoc": null, "nested": [], "union": false}, "types": ["IdReference"], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "resource_relation: IdReference"}], "doc": "<p>Ensure that the (right-most) <span class=\"name\">id</span> of the resource referenced by the <span class=\"name\">url</span> is used by the resource defined by the <span class=\"name\">resource_relation</span>.</p>", "shortdoc": "Ensure that the (right-most) `id` of the resource referenced by the `url` is used by the resource defined by the `resource_relation`.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 1381}, {"name": "Get Ids From Url", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}], "doc": "<p>Perform a GET request on the <span class=\"name\">url</span> and return the list of resource <span class=\"name\">ids</span> from the response.</p>", "shortdoc": "Perform a GET request on the `url` and return the list of resource `ids` from the response.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 779}, {"name": "Get Invalid Json Data", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}, {"name": "status_code", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "status_code: int"}, {"name": "request_data", "type": {"name": "RequestData", "typedoc": null, "nested": [], "union": false}, "types": ["RequestData"], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "request_data: RequestData"}], "doc": "<p>Return <span class=\"name\">json_data</span> based on the <span class=\"name\">dto</span> on the <span class=\"name\">request_data</span> that will cause the provided <span class=\"name\">status_code</span> for the <span class=\"name\">method</span> operation on the <span class=\"name\">url</span>.</p>\n<p>&gt; Note: applicable UniquePropertyValueConstraint and IdReference Relations are considered before changes to <span class=\"name\">json_data</span> are made.</p>", "shortdoc": "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`.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 1158}, {"name": "Get Invalidated Parameters", "args": [{"name": "status_code", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "status_code: int"}, {"name": "request_data", "type": {"name": "RequestData", "typedoc": null, "nested": [], "union": false}, "types": ["RequestData"], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "request_data: RequestData"}], "doc": "<p>Returns a version of <span class=\"name\">params, headers</span> as present on <span class=\"name\">request_data</span> that has been modified to cause the provided <span class=\"name\">status_code</span>.</p>", "shortdoc": "Returns a version of `params, headers` as present on `request_data` that has been modified to cause the provided `status_code`.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 1206}, {"name": "Get Invalidated Url", "args": [{"name": "valid_url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "valid_url: str"}], "doc": "<p>Return an url with all the path parameters in the <span class=\"name\">valid_url</span> replaced by a random UUID.</p>\n<p>Raises ValueError if the valid_url cannot be invalidated.</p>", "shortdoc": "Return an url with all the path parameters in the `valid_url` replaced by a random UUID.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 1124}, {"name": "Get Json Data For Dto Class", "args": [{"name": "schema", "type": {"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Any", "typedoc": "Any", "nested": [], "union": false}], "union": false}, "types": ["Dict[str, Any]"], "typedocs": {"Dict": "dictionary", "str": "string", "Any": "Any"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "schema: Dict[str, Any]"}, {"name": "dto_class", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dto", "typedoc": null, "nested": [], "union": false}, {"name": "Type", "typedoc": null, "nested": [{"name": "Dto", "typedoc": null, "nested": [], "union": false}], "union": false}], "union": true}, "types": ["Dto", "Type[Dto]"], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "dto_class: Dto | Type[Dto]"}, {"name": "operation_id", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "operation_id: str = "}], "doc": "<p>Generate a valid (json-compatible) dict for all the <span class=\"name\">dto_class</span> properties.</p>", "shortdoc": "Generate a valid (json-compatible) dict for all the `dto_class` properties.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 1027}, {"name": "Get Json Data With Conflict", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}, {"name": "dto", "type": {"name": "Dto", "typedoc": null, "nested": [], "union": false}, "types": ["Dto"], "typedocs": {}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "dto: Dto"}, {"name": "conflict_status_code", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "conflict_status_code: int"}], "doc": "<p>Return <span class=\"name\">json_data</span> based on the <span class=\"name\">UniquePropertyValueConstraint</span> that must be returned by the <span class=\"name\">get_relations</span> implementation on the <span class=\"name\">dto</span> for the given <span class=\"name\">conflict_status_code</span>.</p>", "shortdoc": "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`.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 1425}, {"name": "Get Parameterized Endpoint From Url", "args": [{"name": "url", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "url: str"}], "doc": "<p>Return the endpoint as found in the <span class=\"name\">paths</span> section based on the given <span class=\"name\">url</span>.</p>", "shortdoc": "Return the endpoint as found in the `paths` section based on the given `url`.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 1146}, {"name": "Get Request Data", "args": [{"name": "endpoint", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "endpoint: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}], "doc": "<p>Return an object with valid request data for body, headers and query params.</p>", "shortdoc": "Return an object with valid request data for body, headers and query params.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 819}, {"name": "Get Valid Id For Endpoint", "args": [{"name": "endpoint", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "endpoint: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}], "doc": "<p>Support keyword that returns the <span class=\"name\">id</span> for an existing resource at <span class=\"name\">endpoint</span>.</p>\n<p>To prevent resource conflicts with other test cases, a new resource is created (POST) if possible.</p>", "shortdoc": "Support keyword that returns the `id` for an existing resource at `endpoint`.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 683}, {"name": "Get Valid Url", "args": [{"name": "endpoint", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "endpoint: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}], "doc": "<p>This keyword returns a valid url for the given <span class=\"name\">endpoint</span> and <span class=\"name\">method</span>.</p>\n<p>If the <span class=\"name\">endpoint</span> contains path parameters the Get Valid Id For Endpoint keyword will be executed to retrieve valid ids for the path parameters.</p>\n<p>&gt; Note: if valid ids cannot be retrieved within the scope of the API, the <span class=\"name\">PathPropertiesConstraint</span> Relation can be used. More information can be found <a href=\"https://marketsquare.github.io/robotframework-openapi-libcore/advanced_use.html\">here</a>.</p>", "shortdoc": "This keyword returns a valid url for the given `endpoint` and `method`.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 643}, {"name": "Set Origin", "args": [{"name": "origin", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "origin: str"}], "doc": "<p>Update the <span class=\"name\">origin</span> after the library is imported.</p>\n<p>This can be done during the <span class=\"name\">Suite setup</span> when using DataDriver in situations where the OpenAPI document is available on disk but the target host address is not known before the test starts.</p>\n<p>In combination with OpenApiLibCore, the <span class=\"name\">origin</span> can be used at any point to target another server that hosts an API that complies to the same OAS.</p>", "shortdoc": "Update the `origin` after the library is imported.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py", "lineno": 554}], "dataTypes": {"enums": [], "typedDicts": []}, "typedocs": [{"type": "Standard", "name": "Any", "doc": "<p>Any value is accepted. No conversion is done.</p>", "usages": ["__init__", "Authorized Request", "Get Json Data For Dto Class"], "accepts": ["Any"]}, {"type": "Standard", "name": "boolean", "doc": "<p>Strings <code>TRUE</code>, <code>YES</code>, <code>ON</code> and <code>1</code> are converted to Boolean <code>True</code>, the empty string as well as strings <code>FALSE</code>, <code>NO</code>, <code>OFF</code> and <code>0</code> are converted to Boolean <code>False</code>, and the string <code>NONE</code> is converted to the Python <code>None</code> object. Other strings and other accepted values are passed as-is, allowing keywords to handle them specially if needed. All string comparisons are case-insensitive.</p>\n<p>Examples: <code>TRUE</code> (converted to <code>True</code>), <code>off</code> (converted to <code>False</code>), <code>example</code> (used as-is)</p>", "usages": ["__init__", "Authorized Request"], "accepts": ["string", "integer", "float", "None"]}, {"type": "Standard", "name": "dictionary", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#dict\">dictionary</a> literals. They are converted to actual dictionaries using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including dictionaries and other containers.</p>\n<p>If the type has nested types like <code>dict[str, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>{'a': 1, 'b': 2}</code>, <code>{'key': 1, 'nested': {'key': 2}}</code></p>", "usages": ["__init__", "Authorized Request", "Get Json Data For Dto Class"], "accepts": ["string", "Mapping"]}, {"type": "Standard", "name": "float", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#float\">float</a> built-in function.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>3.14</code>, <code>2.9979e8</code>, <code>10 000.000 01</code></p>", "usages": ["Authorized Request"], "accepts": ["string", "Real"]}, {"type": "Standard", "name": "integer", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#int\">int</a> built-in function. Floating point numbers are accepted only if they can be represented as integers exactly. For example, <code>1.0</code> is accepted and <code>1.1</code> is not.</p>\n<p>Starting from RF 4.1, it is possible to use hexadecimal, octal and binary numbers by prefixing values with <code>0x</code>, <code>0o</code> and <code>0b</code>, respectively.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>42</code>, <code>-1</code>, <code>0b1010</code>, <code>10 000 000</code>, <code>0xBAD_C0FFEE</code></p>", "usages": ["__init__", "Authorized Request", "Get Invalid Json Data", "Get Invalidated Parameters", "Get Json Data With Conflict"], "accepts": ["string", "float"]}, {"type": "Standard", "name": "list", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#list\">list</a> literals. They are converted to actual lists using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including lists and other containers.</p>\n<p>If the type has nested types like <code>list[int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>['one', 'two']</code>, <code>[('one', 1), ('two', 2)]</code></p>", "usages": ["__init__", "Authorized Request"], "accepts": ["string", "Sequence"]}, {"type": "Standard", "name": "None", "doc": "<p>String <code>NONE</code> (case-insensitive) is converted to Python <code>None</code> object. Other values cause an error.</p>", "usages": ["__init__", "Authorized Request"], "accepts": ["string"]}, {"type": "Standard", "name": "Path", "doc": "<p>Strings are converted <a href=\"https://docs.python.org/library/pathlib.html\">Path</a> objects. On Windows <code>/</code> is converted to <code>\\</code> automatically.</p>\n<p>Examples: <code>/tmp/absolute/path</code>, <code>relative/path/to/file.ext</code>, <code>name.txt</code></p>", "usages": ["__init__"], "accepts": ["string", "PurePath"]}, {"type": "Standard", "name": "string", "doc": "<p>All arguments are converted to Unicode strings.</p>", "usages": ["__init__", "Authorized Request", "Ensure In Use", "Get Ids From Url", "Get Invalid Json Data", "Get Invalidated Url", "Get Json Data For Dto Class", "Get Json Data With Conflict", "Get Parameterized Endpoint From Url", "Get Request Data", "Get Valid Id For Endpoint", "Get Valid Url", "Set Origin"], "accepts": ["Any"]}, {"type": "Standard", "name": "tuple", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#tuple\">tuple</a> literals. They are converted to actual tuples using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including tuples and other containers.</p>\n<p>If the type has nested types like <code>tuple[str, int, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>('one', 'two')</code>, <code>(('one', 1), ('two', 2))</code></p>", "usages": ["__init__"], "accepts": ["string", "Sequence"]}]}
 </script>
 <title></title>
 </head>
diff --git a/docs/openapidriver.html b/docs/openapidriver.html
index b41a95b..8d40391 100644
--- a/docs/openapidriver.html
+++ b/docs/openapidriver.html
@@ -1180,7 +1180,7 @@
 jQuery.extend({highlight:function(e,t,n,r){if(e.nodeType===3){var i=e.data.match(t);if(i){var s=document.createElement(n||"span");s.className=r||"highlight";var o=e.splitText(i.index);o.splitText(i[0].length);var u=o.cloneNode(true);s.appendChild(u);o.parentNode.replaceChild(s,o);return 1}}else if(e.nodeType===1&&e.childNodes&&!/(script|style)/i.test(e.tagName)&&!(e.tagName===n.toUpperCase()&&e.className===r)){for(var a=0;a<e.childNodes.length;a++){a+=jQuery.highlight(e.childNodes[a],t,n,r)}}return 0}});jQuery.fn.unhighlight=function(e){var t={className:"highlight",element:"span"};jQuery.extend(t,e);return this.find(t.element+"."+t.className).each(function(){var e=this.parentNode;e.replaceChild(this.firstChild,this);e.normalize()}).end()};jQuery.fn.highlight=function(e,t){var n={className:"highlight",element:"span",caseSensitive:false,wordsOnly:false};jQuery.extend(n,t);if(e.constructor===String){e=[e]}e=jQuery.grep(e,function(e,t){return e!=""});e=jQuery.map(e,function(e,t){return e.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&")});if(e.length==0){return this}var r=n.caseSensitive?"":"i";var i="("+e.join("|")+")";if(n.wordsOnly){i="\\b"+i+"\\b"}var s=new RegExp(i,r);return this.each(function(){jQuery.highlight(this,s,n.element,n.className)})}
 </script>
 <script type="text/javascript">
-libdoc = {"specversion": 2, "name": "OpenApiDriver", "doc": "<p>Visit the <a href=\"https://github.com/MarketSquare/robotframework-openapidriver\">library page</a> for an introduction and examples.</p>", "version": "0.1.1", "generated": "2024-03-08T16:26:37+00:00", "type": "LIBRARY", "scope": "SUITE", "docFormat": "HTML", "source": "/workspaces/robotframework-openapitools/src/OpenApiDriver/openapidriver.py", "lineno": 352, "tags": [], "inits": [{"name": "__init__", "args": [{"name": "source", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source: str"}, {"name": "origin", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "origin: str = "}, {"name": "base_path", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "base_path: str = "}, {"name": "included_paths", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Iterable", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Iterable[str]", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "included_paths: Iterable[str] | None = None"}, {"name": "ignored_paths", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Iterable", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Iterable[str]", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignored_paths: Iterable[str] | None = None"}, {"name": "ignored_responses", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Iterable", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Iterable[int]", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignored_responses: Iterable[int] | None = None"}, {"name": "ignored_testcases", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Iterable", "typedoc": null, "nested": [{"name": "Tuple", "typedoc": "tuple", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Iterable[Tuple[str, str, int]]", "None"], "typedocs": {"Tuple": "tuple", "str": "string", "int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignored_testcases: Iterable[Tuple[str, str, int]] | None = None"}, {"name": "response_validation", "type": {"name": "ValidationLevel", "typedoc": "ValidationLevel", "nested": [], "union": false}, "types": ["ValidationLevel"], "typedocs": {"ValidationLevel": "ValidationLevel"}, "defaultValue": "WARN", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "response_validation: ValidationLevel = WARN"}, {"name": "disable_server_validation", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "disable_server_validation: bool = True"}, {"name": "mappings_path", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Path", "typedoc": "Path", "nested": [], "union": false}], "union": true}, "types": ["str", "Path"], "typedocs": {"str": "string", "Path": "Path"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "mappings_path: str | Path = "}, {"name": "invalid_property_default_response", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "422", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "invalid_property_default_response: int = 422"}, {"name": "default_id_property_name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "id", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "default_id_property_name: str = id"}, {"name": "faker_locale", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "List[str]", "None"], "typedocs": {"str": "string", "List": "list", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "faker_locale: str | List[str] | None = None"}, {"name": "require_body_for_invalid_url", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "require_body_for_invalid_url: bool = False"}, {"name": "recursion_limit", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "recursion_limit: int = 1"}, {"name": "recursion_default", "type": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "types": ["Any"], "typedocs": {"Any": "Any"}, "defaultValue": "{}", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "recursion_default: Any = {}"}, {"name": "username", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "username: str = "}, {"name": "password", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "password: str = "}, {"name": "security_token", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "security_token: str = "}, {"name": "auth", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AuthBase", "typedoc": null, "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["AuthBase", "None"], "typedocs": {"None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "auth: AuthBase | None = None"}, {"name": "cert", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Tuple", "typedoc": "tuple", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "Tuple[str, str]", "None"], "typedocs": {"str": "string", "Tuple": "tuple", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cert: str | Tuple[str, str] | None = None"}, {"name": "verify_tls", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["bool", "str", "None"], "typedocs": {"bool": "boolean", "str": "string", "None": "None"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "verify_tls: bool | str | None = True"}, {"name": "extra_headers", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, str]", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "extra_headers: Dict[str, str] | None = None"}, {"name": "cookies", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "RequestsCookieJar", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, str]", "RequestsCookieJar", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "RequestsCookieJar": "dictionary", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cookies: Dict[str, str] | RequestsCookieJar | None = None"}, {"name": "proxies", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, str]", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "proxies: Dict[str, str] | None = None"}], "doc": "<h3>Base parameters</h3>\n<h4>source</h4>\n<p>An absolute path to an openapi.json or openapi.yaml file or an url to such a file.</p>\n<h4>origin</h4>\n<p>The server (and port) of the target server. E.g. <code>https://localhost:8000</code></p>\n<h4>base_path</h4>\n<p>The routing between <code>origin</code> and the endpoints as found in the <code>paths</code> section in the openapi document. E.g. <code>/petshop/v2</code>.</p>\n<h3>Test case generation and execution</h3>\n<h4>included_paths</h4>\n<p>A list of paths that will be included when generating the test cases. The <code>*</code> character can be used at the end of a partial path to include all paths starting with the partial path (wildcard include).</p>\n<h4>ignored_paths</h4>\n<p>A list of paths that will be ignored when generating the test cases. The <code>*</code> character can be used at the end of a partial path to ignore all paths starting with the partial path (wildcard ignore).</p>\n<h4>ignored_responses</h4>\n<p>A list of responses that will be ignored when generating the test cases.</p>\n<h4>ignored_testcases</h4>\n<p>A list of specific test cases that, if it would be generated, will be ignored. Specific test cases to ignore must be specified as a <code>Tuple</code> or <code>List</code> of <code>path</code>, <code>method</code> and <code>response</code>.</p>\n<h4>response_validation</h4>\n<p>By default, a <code>WARN</code> is logged when the Response received after a Request does not comply with the schema as defined in the openapi document for the given operation. The following values are supported:</p>\n<ul>\n<li><code>DISABLED</code>: All Response validation errors will be ignored</li>\n<li><code>INFO</code>: Any Response validation erros will be logged at <code>INFO</code> level</li>\n<li><code>WARN</code>: Any Response validation erros will be logged at <code>WARN</code> level</li>\n<li><code>STRICT</code>: The Test Case will fail on any Response validation errors</li>\n</ul>\n<h4>disable_server_validation</h4>\n<p>If enabled by setting this parameter to <code>True</code>, the Response validation will also include possible errors for Requests made to a server address that is not defined in the list of servers in the openapi document. This generally means that if there is a mismatch, every Test Case will raise this error. Note that <code>localhost</code> and <code>127.0.0.1</code> are not considered the same by Response validation.</p>\n<h3>API-specific configurations</h3>\n<h4>mappings_path</h4>\n<p>See <a href=\"https://marketsquare.github.io/robotframework-openapi-libcore/advanced_use.html\">this page</a> for an in-depth explanation.</p>\n<h4>invalid_property_default_response</h4>\n<p>The default response code for requests with a JSON body that does not comply with the schema. Example: a value outside the specified range or a string value for a property defined as integer in the schema.</p>\n<h4>default_id_property_name</h4>\n<p>The default name for the property that identifies a resource (i.e. a unique entity) within the API. The default value for this property name is <code>id</code>. If the target API uses a different name for all the resources within the API, you can configure it globally using this property.</p>\n<p>If different property names are used for the unique identifier for different types of resources, an <code>ID_MAPPING</code> can be implemented using the <code>mappings_path</code>.</p>\n<h4>faker_locale</h4>\n<p>A locale string or list of locale strings to pass to the Faker library to be used in generation of string data for supported format types.</p>\n<h4>require_body_for_invalid_url</h4>\n<p>When a request is made against an invalid url, this usually is because of a \"404\" request; a request for a resource that does not exist. Depending on API implementation, when a request with a missing or invalid request body is made on a non-existent resource, either a 404 or a 422 or 400 Response is normally returned. If the API being tested processes the request body before checking if the requested resource exists, set this parameter to True.</p>\n<h3>Parsing parameters</h3>\n<h4>recursion_limit</h4>\n<p>The recursion depth to which to fully parse recursive references before the <span class=\"name\">recursion_default</span> is used to end the recursion.</p>\n<h4>recursion_default</h4>\n<p>The value that is used instead of the referenced schema when the <span class=\"name\">recursion_limit</span> has been reached. The default <span class=\"name\">{}</span> represents an empty object in JSON. Depending on schema definitions, this may cause schema validation errors. If this is the case, 'None' (<code>${NONE}</code> in Robot Framework) or an empty list can be tried as an alternative.</p>\n<h3>Security-related parameters</h3>\n<p><i>Note: these parameters are equivalent to those in the <code>requests</code> library.</i></p>\n<h4>username</h4>\n<p>The username to be used for Basic Authentication.</p>\n<h4>password</h4>\n<p>The password to be used for Basic Authentication.</p>\n<h4>security_token</h4>\n<p>The token to be used for token based security using the <code>Authorization</code> header.</p>\n<h4>auth</h4>\n<p>A <a href=\"https://requests.readthedocs.io/en/latest/api/#authentication\">requests <code>AuthBase</code> instance</a> to be used for authentication instead of the <code>username</code> and <code>password</code>.</p>\n<h4>cert</h4>\n<p>The SSL certificate to use with all requests. If string: the path to ssl client cert file (.pem). If tuple: the ('cert', 'key') pair.</p>\n<h4>verify_tls</h4>\n<p>Whether or not to verify the TLS / SSL certificate of the server. If boolean: whether or not to verify the server TLS certificate. If string: path to a CA bundle to use for verification.</p>\n<h4>extra_headers</h4>\n<p>A dictionary with extra / custom headers that will be send with every request. This parameter can be used to send headers that are not documented in the openapi document or to provide an API-key.</p>\n<h4>cookies</h4>\n<p>A dictionary or <a href=\"https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookieJar\">CookieJar object</a> to send with all requests.</p>\n<h4>proxies</h4>\n<p>A dictionary of 'protocol': 'proxy url' to use for all requests.</p>", "shortdoc": " == Base parameters ==", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiDriver/openapidriver.py", "lineno": 144}], "keywords": [{"name": "Test Endpoint", "args": [{"name": "path", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}, {"name": "status_code", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "status_code: int"}], "doc": "<p>Validate that performing the <span class=\"name\">method</span> operation on <a href=\"#type-Path\" class=\"name\">path</a> results in a <span class=\"name\">status_code</span> response.</p>\n<p>This is the main keyword to be used in the <span class=\"name\">Test Template</span> keyword when using the OpenApiDriver.</p>\n<p>The keyword calls other keywords to generate the neccesary data to perform the desired operation and validate the response against the openapi document.</p>", "shortdoc": "Validate that performing the `method` operation on `path` results in a `status_code` response.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiDriver/openapi_executors.py", "lineno": 157}, {"name": "Test Invalid Url", "args": [{"name": "path", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}, {"name": "expected_status_code", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "404", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "expected_status_code: int = 404"}], "doc": "<p>Perform a request for the provided 'path' and 'method' where the url for the <a href=\"#type-Path\" class=\"name\">path</a> is invalidated.</p>\n<p>This keyword will be <span class=\"name\">SKIPPED</span> if the path contains no parts that can be invalidated.</p>\n<p>The optional <span class=\"name\">expected_status_code</span> parameter (default: 404) can be set to the expected status code for APIs that do not return a 404 on invalid urls.</p>\n<p>&gt; Note: Depending on API design, the url may be validated before or after validation of headers, query parameters and / or (json) body. By default, no parameters are send with the request. The <span class=\"name\">require_body_for_invalid_url</span> parameter can be set to <span class=\"name\">True</span> if needed.</p>", "shortdoc": "Perform a request for the provided 'path' and 'method' where the url for the `path` is invalidated.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiDriver/openapi_executors.py", "lineno": 115}, {"name": "Test Unauthorized", "args": [{"name": "path", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}], "doc": "<p>Perform a request for <span class=\"name\">method</span> on the <a href=\"#type-Path\" class=\"name\">path</a>, with no authorization.</p>\n<p>This keyword only passes if the response code is 401: Unauthorized.</p>\n<p>Any authorization parameters used to initialize the library are ignored for this request. &gt; Note: No headers or (json) body are send with the request. For security reasons, the authorization validation should be checked first.</p>", "shortdoc": "Perform a request for `method` on the `path`, with no authorization.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiDriver/openapi_executors.py", "lineno": 95}], "dataTypes": {"enums": [{"type": "Enum", "name": "ValidationLevel", "doc": "<p>The available levels for the response_validation parameter.</p>", "members": [{"name": "DISABLED", "value": "DISABLED"}, {"name": "INFO", "value": "INFO"}, {"name": "WARN", "value": "WARN"}, {"name": "STRICT", "value": "STRICT"}]}], "typedDicts": []}, "typedocs": [{"type": "Standard", "name": "Any", "doc": "<p>Any value is accepted. No conversion is done.</p>", "usages": ["__init__"], "accepts": ["Any"]}, {"type": "Standard", "name": "boolean", "doc": "<p>Strings <code>TRUE</code>, <code>YES</code>, <code>ON</code> and <code>1</code> are converted to Boolean <code>True</code>, the empty string as well as strings <code>FALSE</code>, <code>NO</code>, <code>OFF</code> and <code>0</code> are converted to Boolean <code>False</code>, and the string <code>NONE</code> is converted to the Python <code>None</code> object. Other strings and other accepted values are passed as-is, allowing keywords to handle them specially if needed. All string comparisons are case-insensitive.</p>\n<p>Examples: <code>TRUE</code> (converted to <code>True</code>), <code>off</code> (converted to <code>False</code>), <code>example</code> (used as-is)</p>", "usages": ["__init__"], "accepts": ["string", "integer", "float", "None"]}, {"type": "Standard", "name": "dictionary", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#dict\">dictionary</a> literals. They are converted to actual dictionaries using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including dictionaries and other containers.</p>\n<p>If the type has nested types like <code>dict[str, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>{'a': 1, 'b': 2}</code>, <code>{'key': 1, 'nested': {'key': 2}}</code></p>", "usages": ["__init__"], "accepts": ["string", "Mapping"]}, {"type": "Standard", "name": "integer", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#int\">int</a> built-in function. Floating point numbers are accepted only if they can be represented as integers exactly. For example, <code>1.0</code> is accepted and <code>1.1</code> is not.</p>\n<p>Starting from RF 4.1, it is possible to use hexadecimal, octal and binary numbers by prefixing values with <code>0x</code>, <code>0o</code> and <code>0b</code>, respectively.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>42</code>, <code>-1</code>, <code>0b1010</code>, <code>10 000 000</code>, <code>0xBAD_C0FFEE</code></p>", "usages": ["__init__", "Test Endpoint", "Test Invalid Url"], "accepts": ["string", "float"]}, {"type": "Standard", "name": "list", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#list\">list</a> literals. They are converted to actual lists using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including lists and other containers.</p>\n<p>If the type has nested types like <code>list[int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>['one', 'two']</code>, <code>[('one', 1), ('two', 2)]</code></p>", "usages": ["__init__"], "accepts": ["string", "Sequence"]}, {"type": "Standard", "name": "None", "doc": "<p>String <code>NONE</code> (case-insensitive) is converted to Python <code>None</code> object. Other values cause an error.</p>", "usages": ["__init__"], "accepts": ["string"]}, {"type": "Standard", "name": "Path", "doc": "<p>Strings are converted <a href=\"https://docs.python.org/library/pathlib.html\">Path</a> objects. On Windows <code>/</code> is converted to <code>\\</code> automatically.</p>\n<p>Examples: <code>/tmp/absolute/path</code>, <code>relative/path/to/file.ext</code>, <code>name.txt</code></p>", "usages": ["__init__"], "accepts": ["string", "PurePath"]}, {"type": "Standard", "name": "string", "doc": "<p>All arguments are converted to Unicode strings.</p>", "usages": ["__init__", "Test Endpoint", "Test Invalid Url", "Test Unauthorized"], "accepts": ["Any"]}, {"type": "Standard", "name": "tuple", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#tuple\">tuple</a> literals. They are converted to actual tuples using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including tuples and other containers.</p>\n<p>If the type has nested types like <code>tuple[str, int, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>('one', 'two')</code>, <code>(('one', 1), ('two', 2))</code></p>", "usages": ["__init__"], "accepts": ["string", "Sequence"]}, {"type": "Enum", "name": "ValidationLevel", "doc": "<p>The available levels for the response_validation parameter.</p>", "usages": ["__init__"], "accepts": ["string"], "members": [{"name": "DISABLED", "value": "DISABLED"}, {"name": "INFO", "value": "INFO"}, {"name": "WARN", "value": "WARN"}, {"name": "STRICT", "value": "STRICT"}]}]}
+libdoc = {"specversion": 2, "name": "OpenApiDriver", "doc": "<p>Visit the <a href=\"https://github.com/MarketSquare/robotframework-openapidriver\">library page</a> for an introduction and examples.</p>", "version": "0.1.2", "generated": "2024-03-15T20:27:49+00:00", "type": "LIBRARY", "scope": "SUITE", "docFormat": "HTML", "source": "/workspaces/robotframework-openapitools/src/OpenApiDriver/openapidriver.py", "lineno": 352, "tags": [], "inits": [{"name": "__init__", "args": [{"name": "source", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "source: str"}, {"name": "origin", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "origin: str = "}, {"name": "base_path", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "base_path: str = "}, {"name": "included_paths", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Iterable", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Iterable[str]", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "included_paths: Iterable[str] | None = None"}, {"name": "ignored_paths", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Iterable", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Iterable[str]", "None"], "typedocs": {"str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignored_paths: Iterable[str] | None = None"}, {"name": "ignored_responses", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Iterable", "typedoc": null, "nested": [{"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Iterable[int]", "None"], "typedocs": {"int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignored_responses: Iterable[int] | None = None"}, {"name": "ignored_testcases", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Iterable", "typedoc": null, "nested": [{"name": "Tuple", "typedoc": "tuple", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "int", "typedoc": "integer", "nested": [], "union": false}], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Iterable[Tuple[str, str, int]]", "None"], "typedocs": {"Tuple": "tuple", "str": "string", "int": "integer", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "ignored_testcases: Iterable[Tuple[str, str, int]] | None = None"}, {"name": "response_validation", "type": {"name": "ValidationLevel", "typedoc": "ValidationLevel", "nested": [], "union": false}, "types": ["ValidationLevel"], "typedocs": {"ValidationLevel": "ValidationLevel"}, "defaultValue": "WARN", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "response_validation: ValidationLevel = WARN"}, {"name": "disable_server_validation", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "disable_server_validation: bool = True"}, {"name": "mappings_path", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Path", "typedoc": "Path", "nested": [], "union": false}], "union": true}, "types": ["str", "Path"], "typedocs": {"str": "string", "Path": "Path"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "mappings_path: str | Path = "}, {"name": "invalid_property_default_response", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "422", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "invalid_property_default_response: int = 422"}, {"name": "default_id_property_name", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "id", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "default_id_property_name: str = id"}, {"name": "faker_locale", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "List", "typedoc": "list", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "List[str]", "None"], "typedocs": {"str": "string", "List": "list", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "faker_locale: str | List[str] | None = None"}, {"name": "require_body_for_invalid_url", "type": {"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, "types": ["bool"], "typedocs": {"bool": "boolean"}, "defaultValue": "False", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "require_body_for_invalid_url: bool = False"}, {"name": "recursion_limit", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "1", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "recursion_limit: int = 1"}, {"name": "recursion_default", "type": {"name": "Any", "typedoc": "Any", "nested": [], "union": false}, "types": ["Any"], "typedocs": {"Any": "Any"}, "defaultValue": "{}", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "recursion_default: Any = {}"}, {"name": "username", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "username: str = "}, {"name": "password", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "password: str = "}, {"name": "security_token", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": "", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "security_token: str = "}, {"name": "auth", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "AuthBase", "typedoc": null, "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["AuthBase", "None"], "typedocs": {"None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "auth: AuthBase | None = None"}, {"name": "cert", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "Tuple", "typedoc": "tuple", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["str", "Tuple[str, str]", "None"], "typedocs": {"str": "string", "Tuple": "tuple", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cert: str | Tuple[str, str] | None = None"}, {"name": "verify_tls", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "bool", "typedoc": "boolean", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["bool", "str", "None"], "typedocs": {"bool": "boolean", "str": "string", "None": "None"}, "defaultValue": "True", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "verify_tls: bool | str | None = True"}, {"name": "extra_headers", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, str]", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "extra_headers: Dict[str, str] | None = None"}, {"name": "cookies", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "RequestsCookieJar", "typedoc": "dictionary", "nested": [], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, str]", "RequestsCookieJar", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "RequestsCookieJar": "dictionary", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "cookies: Dict[str, str] | RequestsCookieJar | None = None"}, {"name": "proxies", "type": {"name": "Union", "typedoc": null, "nested": [{"name": "Dict", "typedoc": "dictionary", "nested": [{"name": "str", "typedoc": "string", "nested": [], "union": false}, {"name": "str", "typedoc": "string", "nested": [], "union": false}], "union": false}, {"name": "None", "typedoc": "None", "nested": [], "union": false}], "union": true}, "types": ["Dict[str, str]", "None"], "typedocs": {"Dict": "dictionary", "str": "string", "None": "None"}, "defaultValue": "None", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "proxies: Dict[str, str] | None = None"}], "doc": "<h3>Base parameters</h3>\n<h4>source</h4>\n<p>An absolute path to an openapi.json or openapi.yaml file or an url to such a file.</p>\n<h4>origin</h4>\n<p>The server (and port) of the target server. E.g. <code>https://localhost:8000</code></p>\n<h4>base_path</h4>\n<p>The routing between <code>origin</code> and the endpoints as found in the <code>paths</code> section in the openapi document. E.g. <code>/petshop/v2</code>.</p>\n<h3>Test case generation and execution</h3>\n<h4>included_paths</h4>\n<p>A list of paths that will be included when generating the test cases. The <code>*</code> character can be used at the end of a partial path to include all paths starting with the partial path (wildcard include).</p>\n<h4>ignored_paths</h4>\n<p>A list of paths that will be ignored when generating the test cases. The <code>*</code> character can be used at the end of a partial path to ignore all paths starting with the partial path (wildcard ignore).</p>\n<h4>ignored_responses</h4>\n<p>A list of responses that will be ignored when generating the test cases.</p>\n<h4>ignored_testcases</h4>\n<p>A list of specific test cases that, if it would be generated, will be ignored. Specific test cases to ignore must be specified as a <code>Tuple</code> or <code>List</code> of <code>path</code>, <code>method</code> and <code>response</code>.</p>\n<h4>response_validation</h4>\n<p>By default, a <code>WARN</code> is logged when the Response received after a Request does not comply with the schema as defined in the openapi document for the given operation. The following values are supported:</p>\n<ul>\n<li><code>DISABLED</code>: All Response validation errors will be ignored</li>\n<li><code>INFO</code>: Any Response validation erros will be logged at <code>INFO</code> level</li>\n<li><code>WARN</code>: Any Response validation erros will be logged at <code>WARN</code> level</li>\n<li><code>STRICT</code>: The Test Case will fail on any Response validation errors</li>\n</ul>\n<h4>disable_server_validation</h4>\n<p>If enabled by setting this parameter to <code>True</code>, the Response validation will also include possible errors for Requests made to a server address that is not defined in the list of servers in the openapi document. This generally means that if there is a mismatch, every Test Case will raise this error. Note that <code>localhost</code> and <code>127.0.0.1</code> are not considered the same by Response validation.</p>\n<h3>API-specific configurations</h3>\n<h4>mappings_path</h4>\n<p>See <a href=\"https://marketsquare.github.io/robotframework-openapi-libcore/advanced_use.html\">this page</a> for an in-depth explanation.</p>\n<h4>invalid_property_default_response</h4>\n<p>The default response code for requests with a JSON body that does not comply with the schema. Example: a value outside the specified range or a string value for a property defined as integer in the schema.</p>\n<h4>default_id_property_name</h4>\n<p>The default name for the property that identifies a resource (i.e. a unique entity) within the API. The default value for this property name is <code>id</code>. If the target API uses a different name for all the resources within the API, you can configure it globally using this property.</p>\n<p>If different property names are used for the unique identifier for different types of resources, an <code>ID_MAPPING</code> can be implemented using the <code>mappings_path</code>.</p>\n<h4>faker_locale</h4>\n<p>A locale string or list of locale strings to pass to the Faker library to be used in generation of string data for supported format types.</p>\n<h4>require_body_for_invalid_url</h4>\n<p>When a request is made against an invalid url, this usually is because of a \"404\" request; a request for a resource that does not exist. Depending on API implementation, when a request with a missing or invalid request body is made on a non-existent resource, either a 404 or a 422 or 400 Response is normally returned. If the API being tested processes the request body before checking if the requested resource exists, set this parameter to True.</p>\n<h3>Parsing parameters</h3>\n<h4>recursion_limit</h4>\n<p>The recursion depth to which to fully parse recursive references before the <span class=\"name\">recursion_default</span> is used to end the recursion.</p>\n<h4>recursion_default</h4>\n<p>The value that is used instead of the referenced schema when the <span class=\"name\">recursion_limit</span> has been reached. The default <span class=\"name\">{}</span> represents an empty object in JSON. Depending on schema definitions, this may cause schema validation errors. If this is the case, 'None' (<code>${NONE}</code> in Robot Framework) or an empty list can be tried as an alternative.</p>\n<h3>Security-related parameters</h3>\n<p><i>Note: these parameters are equivalent to those in the <code>requests</code> library.</i></p>\n<h4>username</h4>\n<p>The username to be used for Basic Authentication.</p>\n<h4>password</h4>\n<p>The password to be used for Basic Authentication.</p>\n<h4>security_token</h4>\n<p>The token to be used for token based security using the <code>Authorization</code> header.</p>\n<h4>auth</h4>\n<p>A <a href=\"https://requests.readthedocs.io/en/latest/api/#authentication\">requests <code>AuthBase</code> instance</a> to be used for authentication instead of the <code>username</code> and <code>password</code>.</p>\n<h4>cert</h4>\n<p>The SSL certificate to use with all requests. If string: the path to ssl client cert file (.pem). If tuple: the ('cert', 'key') pair.</p>\n<h4>verify_tls</h4>\n<p>Whether or not to verify the TLS / SSL certificate of the server. If boolean: whether or not to verify the server TLS certificate. If string: path to a CA bundle to use for verification.</p>\n<h4>extra_headers</h4>\n<p>A dictionary with extra / custom headers that will be send with every request. This parameter can be used to send headers that are not documented in the openapi document or to provide an API-key.</p>\n<h4>cookies</h4>\n<p>A dictionary or <a href=\"https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookieJar\">CookieJar object</a> to send with all requests.</p>\n<h4>proxies</h4>\n<p>A dictionary of 'protocol': 'proxy url' to use for all requests.</p>", "shortdoc": " == Base parameters ==", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiDriver/openapidriver.py", "lineno": 144}], "keywords": [{"name": "Test Endpoint", "args": [{"name": "path", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}, {"name": "status_code", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "status_code: int"}], "doc": "<p>Validate that performing the <span class=\"name\">method</span> operation on <a href=\"#type-Path\" class=\"name\">path</a> results in a <span class=\"name\">status_code</span> response.</p>\n<p>This is the main keyword to be used in the <span class=\"name\">Test Template</span> keyword when using the OpenApiDriver.</p>\n<p>The keyword calls other keywords to generate the neccesary data to perform the desired operation and validate the response against the openapi document.</p>", "shortdoc": "Validate that performing the `method` operation on `path` results in a `status_code` response.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiDriver/openapi_executors.py", "lineno": 157}, {"name": "Test Invalid Url", "args": [{"name": "path", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}, {"name": "expected_status_code", "type": {"name": "int", "typedoc": "integer", "nested": [], "union": false}, "types": ["int"], "typedocs": {"int": "integer"}, "defaultValue": "404", "kind": "POSITIONAL_OR_NAMED", "required": false, "repr": "expected_status_code: int = 404"}], "doc": "<p>Perform a request for the provided 'path' and 'method' where the url for the <a href=\"#type-Path\" class=\"name\">path</a> is invalidated.</p>\n<p>This keyword will be <span class=\"name\">SKIPPED</span> if the path contains no parts that can be invalidated.</p>\n<p>The optional <span class=\"name\">expected_status_code</span> parameter (default: 404) can be set to the expected status code for APIs that do not return a 404 on invalid urls.</p>\n<p>&gt; Note: Depending on API design, the url may be validated before or after validation of headers, query parameters and / or (json) body. By default, no parameters are send with the request. The <span class=\"name\">require_body_for_invalid_url</span> parameter can be set to <span class=\"name\">True</span> if needed.</p>", "shortdoc": "Perform a request for the provided 'path' and 'method' where the url for the `path` is invalidated.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiDriver/openapi_executors.py", "lineno": 115}, {"name": "Test Unauthorized", "args": [{"name": "path", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "path: str"}, {"name": "method", "type": {"name": "str", "typedoc": "string", "nested": [], "union": false}, "types": ["str"], "typedocs": {"str": "string"}, "defaultValue": null, "kind": "POSITIONAL_OR_NAMED", "required": true, "repr": "method: str"}], "doc": "<p>Perform a request for <span class=\"name\">method</span> on the <a href=\"#type-Path\" class=\"name\">path</a>, with no authorization.</p>\n<p>This keyword only passes if the response code is 401: Unauthorized.</p>\n<p>Any authorization parameters used to initialize the library are ignored for this request. &gt; Note: No headers or (json) body are send with the request. For security reasons, the authorization validation should be checked first.</p>", "shortdoc": "Perform a request for `method` on the `path`, with no authorization.", "tags": [], "source": "/workspaces/robotframework-openapitools/src/OpenApiDriver/openapi_executors.py", "lineno": 95}], "dataTypes": {"enums": [{"type": "Enum", "name": "ValidationLevel", "doc": "<p>The available levels for the response_validation parameter.</p>", "members": [{"name": "DISABLED", "value": "DISABLED"}, {"name": "INFO", "value": "INFO"}, {"name": "WARN", "value": "WARN"}, {"name": "STRICT", "value": "STRICT"}]}], "typedDicts": []}, "typedocs": [{"type": "Standard", "name": "Any", "doc": "<p>Any value is accepted. No conversion is done.</p>", "usages": ["__init__"], "accepts": ["Any"]}, {"type": "Standard", "name": "boolean", "doc": "<p>Strings <code>TRUE</code>, <code>YES</code>, <code>ON</code> and <code>1</code> are converted to Boolean <code>True</code>, the empty string as well as strings <code>FALSE</code>, <code>NO</code>, <code>OFF</code> and <code>0</code> are converted to Boolean <code>False</code>, and the string <code>NONE</code> is converted to the Python <code>None</code> object. Other strings and other accepted values are passed as-is, allowing keywords to handle them specially if needed. All string comparisons are case-insensitive.</p>\n<p>Examples: <code>TRUE</code> (converted to <code>True</code>), <code>off</code> (converted to <code>False</code>), <code>example</code> (used as-is)</p>", "usages": ["__init__"], "accepts": ["string", "integer", "float", "None"]}, {"type": "Standard", "name": "dictionary", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#dict\">dictionary</a> literals. They are converted to actual dictionaries using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including dictionaries and other containers.</p>\n<p>If the type has nested types like <code>dict[str, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>{'a': 1, 'b': 2}</code>, <code>{'key': 1, 'nested': {'key': 2}}</code></p>", "usages": ["__init__"], "accepts": ["string", "Mapping"]}, {"type": "Standard", "name": "integer", "doc": "<p>Conversion is done using Python's <a href=\"https://docs.python.org/library/functions.html#int\">int</a> built-in function. Floating point numbers are accepted only if they can be represented as integers exactly. For example, <code>1.0</code> is accepted and <code>1.1</code> is not.</p>\n<p>Starting from RF 4.1, it is possible to use hexadecimal, octal and binary numbers by prefixing values with <code>0x</code>, <code>0o</code> and <code>0b</code>, respectively.</p>\n<p>Starting from RF 4.1, spaces and underscores can be used as visual separators for digit grouping purposes.</p>\n<p>Examples: <code>42</code>, <code>-1</code>, <code>0b1010</code>, <code>10 000 000</code>, <code>0xBAD_C0FFEE</code></p>", "usages": ["__init__", "Test Endpoint", "Test Invalid Url"], "accepts": ["string", "float"]}, {"type": "Standard", "name": "list", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#list\">list</a> literals. They are converted to actual lists using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including lists and other containers.</p>\n<p>If the type has nested types like <code>list[int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>['one', 'two']</code>, <code>[('one', 1), ('two', 2)]</code></p>", "usages": ["__init__"], "accepts": ["string", "Sequence"]}, {"type": "Standard", "name": "None", "doc": "<p>String <code>NONE</code> (case-insensitive) is converted to Python <code>None</code> object. Other values cause an error.</p>", "usages": ["__init__"], "accepts": ["string"]}, {"type": "Standard", "name": "Path", "doc": "<p>Strings are converted <a href=\"https://docs.python.org/library/pathlib.html\">Path</a> objects. On Windows <code>/</code> is converted to <code>\\</code> automatically.</p>\n<p>Examples: <code>/tmp/absolute/path</code>, <code>relative/path/to/file.ext</code>, <code>name.txt</code></p>", "usages": ["__init__"], "accepts": ["string", "PurePath"]}, {"type": "Standard", "name": "string", "doc": "<p>All arguments are converted to Unicode strings.</p>", "usages": ["__init__", "Test Endpoint", "Test Invalid Url", "Test Unauthorized"], "accepts": ["Any"]}, {"type": "Standard", "name": "tuple", "doc": "<p>Strings must be Python <a href=\"https://docs.python.org/library/stdtypes.html#tuple\">tuple</a> literals. They are converted to actual tuples using the <a href=\"https://docs.python.org/library/ast.html#ast.literal_eval\">ast.literal_eval</a> function. They can contain any values <code>ast.literal_eval</code> supports, including tuples and other containers.</p>\n<p>If the type has nested types like <code>tuple[str, int, int]</code>, items are converted to those types automatically. This in new in Robot Framework 6.0.</p>\n<p>Examples: <code>('one', 'two')</code>, <code>(('one', 1), ('two', 2))</code></p>", "usages": ["__init__"], "accepts": ["string", "Sequence"]}, {"type": "Enum", "name": "ValidationLevel", "doc": "<p>The available levels for the response_validation parameter.</p>", "usages": ["__init__"], "accepts": ["string"], "members": [{"name": "DISABLED", "value": "DISABLED"}, {"name": "INFO", "value": "INFO"}, {"name": "WARN", "value": "WARN"}, {"name": "STRICT", "value": "STRICT"}]}]}
 </script>
 <title></title>
 </head>
diff --git a/src/OpenApiDriver/openapidriver.libspec b/src/OpenApiDriver/openapidriver.libspec
index 3fe0c14..db8f664 100644
--- a/src/OpenApiDriver/openapidriver.libspec
+++ b/src/OpenApiDriver/openapidriver.libspec
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<keywordspec name="OpenApiDriver" type="LIBRARY" format="HTML" scope="SUITE" generated="2024-03-08T16:26:38+00:00" specversion="5" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapidriver.py" lineno="352">
-<version>0.1.1</version>
+<keywordspec name="OpenApiDriver" type="LIBRARY" format="HTML" scope="SUITE" generated="2024-03-15T20:27:51+00:00" specversion="5" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapidriver.py" lineno="352">
+<version>0.1.2</version>
 <doc>&lt;p&gt;Visit the &lt;a href="https://github.com/MarketSquare/robotframework-openapidriver"&gt;library page&lt;/a&gt; for an introduction and examples.&lt;/p&gt;</doc>
 <tags>
 </tags>
diff --git a/src/OpenApiLibCore/openapi_libcore.libspec b/src/OpenApiLibCore/openapi_libcore.libspec
index dd59857..7b9f669 100644
--- a/src/OpenApiLibCore/openapi_libcore.libspec
+++ b/src/OpenApiLibCore/openapi_libcore.libspec
@@ -1,12 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<keywordspec name="OpenApiLibCore" type="LIBRARY" format="HTML" scope="SUITE" generated="2024-03-08T16:26:38+00:00" specversion="5" source="/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py" lineno="375">
-<version>0.1.1</version>
+<keywordspec name="OpenApiLibCore" type="LIBRARY" format="HTML" scope="SUITE" generated="2024-03-15T20:27:50+00:00" specversion="5" source="/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py" lineno="377">
+<version>0.1.2</version>
 <doc>&lt;p&gt;Main class providing the keywords and core logic to interact with an OpenAPI server.&lt;/p&gt;
 &lt;p&gt;Visit the &lt;a href="https://github.com/MarketSquare/robotframework-openapi-libcore"&gt;library page&lt;/a&gt; for an introduction.&lt;/p&gt;</doc>
 <tags>
 </tags>
 <inits>
-<init name="__init__" lineno="383">
+<init name="__init__" lineno="385">
 <arguments repr="source: str, origin: str = , base_path: str = , mappings_path: str | Path = , invalid_property_default_response: int = 422, default_id_property_name: str = id, faker_locale: str | List[str] | None = None, recursion_limit: int = 1, recursion_default: Any = {}, username: str = , password: str = , security_token: str = , auth: AuthBase | None = None, cert: str | Tuple[str, str] | None = None, verify_tls: bool | str | None = True, extra_headers: Dict[str, str] | None = None, cookies: Dict[str, str] | RequestsCookieJar | None = None, proxies: Dict[str, str] | None = None">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="source: str">
 <name>source</name>
@@ -144,7 +144,7 @@
 </init>
 </inits>
 <keywords>
-<kw name="Authorized Request" lineno="1457">
+<kw name="Authorized Request" lineno="1477">
 <arguments repr="url: str, method: str, params: Dict[str, Any] | None = None, headers: Dict[str, str] | None = None, json_data: Dict[str, Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None] | List[Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None] | str | int | float | bool | None = None">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -174,7 +174,7 @@
 &lt;p&gt;&amp;gt; Note: provided username / password or auth objects take precedence over token based security&lt;/p&gt;</doc>
 <shortdoc>Perform a request using the security token or authentication set in the library.</shortdoc>
 </kw>
-<kw name="Ensure In Use" lineno="1361">
+<kw name="Ensure In Use" lineno="1381">
 <arguments repr="url: str, resource_relation: IdReference">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -188,7 +188,7 @@
 <doc>&lt;p&gt;Ensure that the (right-most) &lt;span class="name"&gt;id&lt;/span&gt; of the resource referenced by the &lt;span class="name"&gt;url&lt;/span&gt; is used by the resource defined by the &lt;span class="name"&gt;resource_relation&lt;/span&gt;.&lt;/p&gt;</doc>
 <shortdoc>Ensure that the (right-most) `id` of the resource referenced by the `url` is used by the resource defined by the `resource_relation`.</shortdoc>
 </kw>
-<kw name="Get Ids From Url" lineno="774">
+<kw name="Get Ids From Url" lineno="779">
 <arguments repr="url: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -198,7 +198,7 @@
 <doc>&lt;p&gt;Perform a GET request on the &lt;span class="name"&gt;url&lt;/span&gt; and return the list of resource &lt;span class="name"&gt;ids&lt;/span&gt; from the response.&lt;/p&gt;</doc>
 <shortdoc>Perform a GET request on the `url` and return the list of resource `ids` from the response.</shortdoc>
 </kw>
-<kw name="Get Invalid Json Data" lineno="1138">
+<kw name="Get Invalid Json Data" lineno="1158">
 <arguments repr="url: str, method: str, status_code: int, request_data: RequestData">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -221,7 +221,7 @@
 &lt;p&gt;&amp;gt; Note: applicable UniquePropertyValueConstraint and IdReference Relations are considered before changes to &lt;span class="name"&gt;json_data&lt;/span&gt; are made.&lt;/p&gt;</doc>
 <shortdoc>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`.</shortdoc>
 </kw>
-<kw name="Get Invalidated Parameters" lineno="1186">
+<kw name="Get Invalidated Parameters" lineno="1206">
 <arguments repr="status_code: int, request_data: RequestData">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="status_code: int">
 <name>status_code</name>
@@ -235,7 +235,7 @@
 <doc>&lt;p&gt;Returns a version of &lt;span class="name"&gt;params, headers&lt;/span&gt; as present on &lt;span class="name"&gt;request_data&lt;/span&gt; that has been modified to cause the provided &lt;span class="name"&gt;status_code&lt;/span&gt;.&lt;/p&gt;</doc>
 <shortdoc>Returns a version of `params, headers` as present on `request_data` that has been modified to cause the provided `status_code`.</shortdoc>
 </kw>
-<kw name="Get Invalidated Url" lineno="1104">
+<kw name="Get Invalidated Url" lineno="1124">
 <arguments repr="valid_url: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="valid_url: str">
 <name>valid_url</name>
@@ -246,7 +246,7 @@
 &lt;p&gt;Raises ValueError if the valid_url cannot be invalidated.&lt;/p&gt;</doc>
 <shortdoc>Return an url with all the path parameters in the `valid_url` replaced by a random UUID.</shortdoc>
 </kw>
-<kw name="Get Json Data For Dto Class" lineno="1007">
+<kw name="Get Json Data For Dto Class" lineno="1027">
 <arguments repr="schema: Dict[str, Any], dto_class: Dto | Type[Dto], operation_id: str = ">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="schema: Dict[str, Any]">
 <name>schema</name>
@@ -265,7 +265,7 @@
 <doc>&lt;p&gt;Generate a valid (json-compatible) dict for all the &lt;span class="name"&gt;dto_class&lt;/span&gt; properties.&lt;/p&gt;</doc>
 <shortdoc>Generate a valid (json-compatible) dict for all the `dto_class` properties.</shortdoc>
 </kw>
-<kw name="Get Json Data With Conflict" lineno="1405">
+<kw name="Get Json Data With Conflict" lineno="1425">
 <arguments repr="url: str, method: str, dto: Dto, conflict_status_code: int">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -287,7 +287,7 @@
 <doc>&lt;p&gt;Return &lt;span class="name"&gt;json_data&lt;/span&gt; based on the &lt;span class="name"&gt;UniquePropertyValueConstraint&lt;/span&gt; that must be returned by the &lt;span class="name"&gt;get_relations&lt;/span&gt; implementation on the &lt;span class="name"&gt;dto&lt;/span&gt; for the given &lt;span class="name"&gt;conflict_status_code&lt;/span&gt;.&lt;/p&gt;</doc>
 <shortdoc>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`.</shortdoc>
 </kw>
-<kw name="Get Parameterized Endpoint From Url" lineno="1126">
+<kw name="Get Parameterized Endpoint From Url" lineno="1146">
 <arguments repr="url: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
 <name>url</name>
@@ -297,7 +297,7 @@
 <doc>&lt;p&gt;Return the endpoint as found in the &lt;span class="name"&gt;paths&lt;/span&gt; section based on the given &lt;span class="name"&gt;url&lt;/span&gt;.&lt;/p&gt;</doc>
 <shortdoc>Return the endpoint as found in the `paths` section based on the given `url`.</shortdoc>
 </kw>
-<kw name="Get Request Data" lineno="814">
+<kw name="Get Request Data" lineno="819">
 <arguments repr="endpoint: str, method: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
 <name>endpoint</name>
@@ -311,7 +311,7 @@
 <doc>&lt;p&gt;Return an object with valid request data for body, headers and query params.&lt;/p&gt;</doc>
 <shortdoc>Return an object with valid request data for body, headers and query params.</shortdoc>
 </kw>
-<kw name="Get Valid Id For Endpoint" lineno="678">
+<kw name="Get Valid Id For Endpoint" lineno="683">
 <arguments repr="endpoint: str, method: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
 <name>endpoint</name>
@@ -326,7 +326,7 @@
 &lt;p&gt;To prevent resource conflicts with other test cases, a new resource is created (POST) if possible.&lt;/p&gt;</doc>
 <shortdoc>Support keyword that returns the `id` for an existing resource at `endpoint`.</shortdoc>
 </kw>
-<kw name="Get Valid Url" lineno="638">
+<kw name="Get Valid Url" lineno="643">
 <arguments repr="endpoint: str, method: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
 <name>endpoint</name>
@@ -342,7 +342,7 @@
 &lt;p&gt;&amp;gt; Note: if valid ids cannot be retrieved within the scope of the API, the &lt;span class="name"&gt;PathPropertiesConstraint&lt;/span&gt; Relation can be used. More information can be found &lt;a href="https://marketsquare.github.io/robotframework-openapi-libcore/advanced_use.html"&gt;here&lt;/a&gt;.&lt;/p&gt;</doc>
 <shortdoc>This keyword returns a valid url for the given `endpoint` and `method`.</shortdoc>
 </kw>
-<kw name="Set Origin" lineno="552">
+<kw name="Set Origin" lineno="554">
 <arguments repr="origin: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="origin: str">
 <name>origin</name>