robotframework-openapitools 1.0.0b5__tar.gz → 1.0.1__tar.gz

{robotframework_openapitools-1.0.0b5 → robotframework_openapitools-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: robotframework-openapitools
-Version: 1.0.0b5
+Version: 1.0.1
 Summary: A set of Robot Framework libraries to test APIs for which the OAS is available.
 License: Apache License
                                     Version 2.0, January 2004
@@ -210,6 +210,9 @@ Maintainer-email: r.a.mackaij@gmail.com
 Requires-Python: >=3.10, <4
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Topic :: Software Development :: Testing
@@ -226,109 +229,24 @@ Requires-Dist: rich_click (>=1.7.0)
 Requires-Dist: robotframework (>=6.0.0,!=7.0.0)
 Requires-Dist: robotframework-datadriver (>=1.10.0)
 Requires-Dist: rstr (>=3.2.0)
+Project-URL: Documentation, https://marketsquare.github.io/robotframework-openapitools
 Project-URL: Homepage, https://github.com/MarketSquare/robotframework-openapitools
+Project-URL: Repository, https://github.com/MarketSquare/robotframework-openapitools.git
 Description-Content-Type: text/markdown
 
-# OpenApiTools for Robot Framework
-
-OpenApiTools is a set of libraries centered around the OpenAPI Specification:
-
-- [OpenApiDriver](./driver.md)
-- [OpenApiLibCore](./libcore.md)
-
-
-## New in OpenApiTools v1.0.0
-
-Inspired by the work Bartlomiej and Mateusz did on #roboswag, I've created a CLI tool that generates a fully functional Robot Framework (Python) library that builds on OpenApiLibCore for automatic request data generation and request execution.
-
-### So how does it work?
-After installing / updating to the v1.0.0 beta (`pip install robotframework-openapitools==1.0.0b3`) , there's a new CLI command available in your (virtual) environment: `generate-library`. You'll have to provide a path to the openapi spec (json or yaml, can be a url or path to the file), provide a path to where to generate the library and (optionally) a name for the library:
-
-```
-$ generate-library
-Please provide a source for the generation:
-$ http://127.0.0.1:8000/openapi.json
-Please provide a path to where the library will be generated:
-$ ./generated
-Please provide a name for the library [default: FastAPI]:
-$ My Generated Library
-generated/MyGeneratedLibrary/__init__.py created
-generated/MyGeneratedLibrary/my_generated_library.py created
-```
-
-> Note: there's currently 2 environment variables that are taken into account by the generator; USE_SUMMARY_AS_KEYWORD_NAME can result in nicer keyword names (but: uniqueness is not guaranteed, so you might need to rename some of the generated keywords manually) and EXPAND_BODY_ARGUMENTS is what a recent poll in #api-testing was about.
-
-If the location where the library is located is in your Python search path, you'll be able to use it like a regular Robot Framework library (in fact, it's a drop-in replacement for OpenApiLibCore):
+[![build](https://github.com/MarketSquare/robotframework-openapitools/actions/workflows/on-push.yml/badge.svg)](https://github.com/MarketSquare/robotframework-openapitools/actions/workflows/on-push.yml)
+![coverage](coverage-badge.svg)
 
-```{robot}
-*** Settings ***
-Library         MyGeneratedLibrary
-...                 source=${ORIGIN}/openapi.json
-...                 origin=${ORIGIN}
-...                 base_path=${EMPTY}
-...                 mappings_path=${ROOT}/tests/user_implemented/custom_user_mappings.py
-Variables       ${ROOT}/tests/variables.py
+![latest release](https://img.shields.io/pypi/v/robotframework-openapitools?label=latest%20release)
+![Python versions](https://img.shields.io/pypi/pyversions/robotframework-openapitools)
+![PyPi downloads](https://img.shields.io/pypi/dm/robotframework-openapitools)
+![license](https://img.shields.io/pypi/l/robotframework-openapitools)
 
+# OpenApiTools for Robot Framework
 
-*** Variables ***
-${ORIGIN}=      http://localhost:8000
-
-
-*** Test Cases ***
-Test Generated Keywords: Get Employees
-    ${response}=    Get Employees
-    Should Be Equal As Integers    ${response.status_code}    200
-
-Test Generated Keywords: Post Employee
-    VAR    &{body}    name=Robin the Robot
-    ${response}=    Post Employee    body=${body}
-    # ${response}=    Post Employee    name=Robin the Robot
-    Should Be Equal As Integers    ${response.status_code}    201
-    Should Be Equal    ${response.json()}[name]    Robin the Robot
-
-Test Generated Keywords: Get Employee
-    ${response}=    Get Employee
-    Should Be Equal As Integers    ${response.status_code}    200
-
-Test Generated Keywords: Patch Employee
-    ${employee_id}=    Get Valid Id For Path    path=/employees/{employee_id}
-    VAR    &{body}    date_of_birth=2021-12-31
-    ${response}=    Patch Employee    employee_id=${employee_id}    body=${body}
-    # ${response}=    Patch Employee    employee_id=${employee_id}    date_of_birth=2021-12-31
-    Should Be Equal As Integers    ${response.status_code}    403
-
-Test Generated Keywords: Post WageGroup
-    VAR    &{body}    hourly_rate=99.99
-    ${response}=    Post Wagegroup    body=${body}
-    # ${response}=    Post Wagegroup    hourly_rate=99.99
-    Should Be Equal As Integers    ${response.status_code}    201
-    Should Be Equal As Numbers    ${response.json()}[hourly-rate]    99.99
-
-Test Generated Keywords: Get Energy Label
-    ${response}=    Get Energy Label
-    ...    zipcode=1111AA
-    ...    home_number=10
-    ...    extension=too long to be acceptable
-    ...    validate_against_schema=${FALSE}
-    Should Be Equal As Integers    ${response.status_code}    422
-
-    VAR    @{omit}    extension
-    ${response}=    Get Energy Label
-    ...    zipcode=1111AA
-    ...    home_number=10
-    ...    extension=too long to be acceptable
-    ...    omit_parameters=${omit}
-    Should Be Equal As Integers    ${response.status_code}    200
-```
-
-### Contributions and feedback
+If you're testing an API for which an OpenAPI specification is available (if you have a Swagger UI available, you are), OpenApiTools is for you!
 
-So now I need your feedback! Does the library generator work for your openapi spec? Does the library work / do all the generated keywords work? Please let me know of any issues you run into!
-Things I'd like to address / improve before an official release:
-- parameters with union types (e.g. int or float) are currently annotated as Any.
-- support for lists / arrays is limited (i.e. not supported as body)
-- objects / dicts are currently only typed as dict; I'm looking into TypedDict annotation for better auto-complete / auto-conversion
-- a documentation rework
+To read everything about it, see the [html documentation](https://marketsquare.github.io/robotframework-openapitools).
 
-  Subscribe to https://app.slack.com/client/T07PJQ9S7/CKK0X68KD for updates
+The latest release notes can be found [here](./release_notes/1.0.1.md).
 

robotframework_openapitools-1.0.1/docs/README.md

@@ -0,0 +1,15 @@
+[![build](https://github.com/MarketSquare/robotframework-openapitools/actions/workflows/on-push.yml/badge.svg)](https://github.com/MarketSquare/robotframework-openapitools/actions/workflows/on-push.yml)
+![coverage](coverage-badge.svg)
+
+![latest release](https://img.shields.io/pypi/v/robotframework-openapitools?label=latest%20release)
+![Python versions](https://img.shields.io/pypi/pyversions/robotframework-openapitools)
+![PyPi downloads](https://img.shields.io/pypi/dm/robotframework-openapitools)
+![license](https://img.shields.io/pypi/l/robotframework-openapitools)
+
+# OpenApiTools for Robot Framework
+
+If you're testing an API for which an OpenAPI specification is available (if you have a Swagger UI available, you are), OpenApiTools is for you!
+
+To read everything about it, see the [html documentation](https://marketsquare.github.io/robotframework-openapitools).
+
+The latest release notes can be found [here](./release_notes/1.0.1.md).

{robotframework_openapitools-1.0.0b5 → robotframework_openapitools-1.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name="robotframework-openapitools"
-version = "1.0.0b5"
+version = "1.0.1"
 description = "A set of Robot Framework libraries to test APIs for which the OAS is available."
 authors = [
     {name = "Robin Mackaij", email = "r.a.mackaij@gmail.com"},
@@ -13,6 +13,9 @@ license = { file = "LICENSE"}
 classifiers = [
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "License :: OSI Approved :: Apache Software License",
     "Operating System :: OS Independent",
     "Topic :: Software Development :: Testing",
@@ -42,6 +45,7 @@ dev = [
     "fastapi >= 0.109.0",
     "coverage[toml] >= 7.2.0",
     "robotcode-runner >= 1.0.3",
+    "genbadge[coverage] >= 1.1.2",
 ]
 type-checking = [
     "mypy >= 1.14.1",
@@ -58,7 +62,9 @@ lint-and-format = [
 ]
 
 [project.urls]
-homepage = "https://github.com/MarketSquare/robotframework-openapitools"
+Homepage = "https://github.com/MarketSquare/robotframework-openapitools"
+Documentation = "https://marketsquare.github.io/robotframework-openapitools"
+Repository = "https://github.com/MarketSquare/robotframework-openapitools.git"
 
 [project.scripts]
 generate-library = 'openapi_libgen.command_line:main'
@@ -69,6 +75,7 @@ packages = [
     {include = "OpenApiDriver", from = "src"},
     {include = "OpenApiLibCore", from = "src"},
     {include = "openapi_libgen", from = "src"},
+    {include = "openapitools_docs", from = "src"}
 ]
 include = ["*.libspec", "*.jinja"]
 
@@ -79,6 +86,7 @@ uvicorn = ">=0.27.0"
 fastapi = ">=0.109.0"
 coverage = {version = ">=7.2.0", extras = ["toml"]}
 robotcode-runner = ">=1.0.3"
+genbadge = {version = ">=1.1.2", extras = ["coverage"]}
 
 [tool.poetry.group.lint-and-format.dependencies]
 ruff = ">=0.9.0"

{robotframework_openapitools-1.0.0b5 → robotframework_openapitools-1.0.1}/src/OpenApiDriver/__init__.py

@@ -30,6 +30,7 @@ try:
 except Exception:  # pragma: no cover pylint: disable=broad-exception-caught
     pass
 
+
 __all__ = [
     "IGNORE",
     "Dto",

{robotframework_openapitools-1.0.0b5 → robotframework_openapitools-1.0.1}/src/OpenApiDriver/openapi_executors.py

@@ -2,6 +2,7 @@
 
 from collections.abc import Mapping, MutableMapping
 from http import HTTPStatus
+from os import getenv
 from pathlib import Path
 from random import choice
 from types import MappingProxyType
@@ -14,13 +15,29 @@ from robot.api.deco import keyword, library
 from robot.api.exceptions import SkipExecution
 from robot.libraries.BuiltIn import BuiltIn
 
-from OpenApiLibCore import OpenApiLibCore, RequestData, RequestValues, ValidationLevel
+from OpenApiLibCore import (
+    KEYWORD_NAMES as LIBCORE_KEYWORD_NAMES,
+)
+from OpenApiLibCore import (
+    OpenApiLibCore,
+    RequestData,
+    RequestValues,
+    ValidationLevel,
+)
 from OpenApiLibCore.annotations import JSON
 
 run_keyword = BuiltIn().run_keyword
 default_str_mapping: Mapping[str, str] = MappingProxyType({})
 
 
+KEYWORD_NAMES = [
+    "test_unauthorized",
+    "test_forbidden",
+    "test_invalid_url",
+    "test_endpoint",
+]
+
+
 @library(scope="SUITE", doc_format="ROBOT")
 class OpenApiExecutors(OpenApiLibCore):
     """Main class providing the keywords and core logic to perform endpoint validations."""
@@ -305,3 +322,10 @@ class OpenApiExecutors(OpenApiLibCore):
         if response.ok:
             original_data = response.json()
         return original_data
+
+    @staticmethod
+    def get_keyword_names() -> list[str]:
+        """Curated keywords for libdoc and libspec."""
+        if getenv("HIDE_INHERITED_KEYWORDS") == "true":
+            return KEYWORD_NAMES
+        return KEYWORD_NAMES + LIBCORE_KEYWORD_NAMES

{robotframework_openapitools-1.0.0b5 → robotframework_openapitools-1.0.1}/src/OpenApiDriver/openapidriver.libspec

@@ -1,11 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<keywordspec name="OpenApiDriver" type="LIBRARY" format="HTML" scope="SUITE" generated="2025-06-09T18:38:35+00:00" specversion="6" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapidriver.py" lineno="358">
-<version>1.0.0b5</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>
+<keywordspec name="OpenApiDriver" type="LIBRARY" format="HTML" scope="SUITE" generated="2025-09-12T09:00:23+00:00" specversion="6" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapidriver.py" lineno="24">
+<version>1.0.1</version>
+<doc>The OpenApiDriver library provides the keywords and logic for execution of generated test cases based on an OpenAPI document.
+
+Visit the &lt;a href="./index.html" target="_blank"&gt;OpenApiTools documentation&lt;/a&gt; for an introduction.</doc>
 <tags>
 </tags>
 <inits>
-<init name="__init__" lineno="150">
+<init name="__init__" lineno="25">
 <arguments repr="source: str, origin: str = , base_path: str = , included_paths: Iterable[str] = frozenset(), ignored_paths: Iterable[str] = frozenset(), ignored_responses: Iterable[int] = frozenset(), ignored_testcases: Iterable[tuple[str, str, int]] = frozenset(), response_validation: ValidationLevel = WARN, disable_server_validation: bool = True, mappings_path: str | Path = , invalid_property_default_response: int = 422, default_id_property_name: str = id, faker_locale: str | list[str] = , require_body_for_invalid_url: bool = False, recursion_limit: int = 1, recursion_default: JSON = {}, username: str = , password: str = , security_token: str = , auth: AuthBase | None = None, cert: str | tuple[str, str] = , verify_tls: bool | str = True, extra_headers: Mapping[str, str] = {}, cookies: MutableMapping[str, str] | RequestsCookieJar | None = None, proxies: MutableMapping[str, str] | None = None">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="source: str">
 <name>source</name>
@@ -180,74 +182,150 @@
 <default>None</default>
 </arg>
 </arguments>
-<doc>&lt;h3&gt;Base parameters&lt;/h3&gt;
-&lt;h4&gt;source&lt;/h4&gt;
-&lt;p&gt;An absolute path to an openapi.json or openapi.yaml file or an url to such a file.&lt;/p&gt;
-&lt;h4&gt;origin&lt;/h4&gt;
-&lt;p&gt;The server (and port) of the target server. E.g. &lt;code&gt;https://localhost:8000&lt;/code&gt;&lt;/p&gt;
-&lt;h4&gt;base_path&lt;/h4&gt;
-&lt;p&gt;The routing between &lt;code&gt;origin&lt;/code&gt; and the endpoints as found in the &lt;code&gt;paths&lt;/code&gt; section in the openapi document. E.g. &lt;code&gt;/petshop/v2&lt;/code&gt;.&lt;/p&gt;
-&lt;h3&gt;Test case generation and execution&lt;/h3&gt;
-&lt;h4&gt;included_paths&lt;/h4&gt;
-&lt;p&gt;A list of paths that will be included when generating the test cases. The &lt;code&gt;*&lt;/code&gt; character can be used at the end of a partial path to include all paths starting with the partial path (wildcard include).&lt;/p&gt;
-&lt;h4&gt;ignored_paths&lt;/h4&gt;
-&lt;p&gt;A list of paths that will be ignored when generating the test cases. The &lt;code&gt;*&lt;/code&gt; character can be used at the end of a partial path to ignore all paths starting with the partial path (wildcard ignore).&lt;/p&gt;
-&lt;h4&gt;ignored_responses&lt;/h4&gt;
-&lt;p&gt;A list of responses that will be ignored when generating the test cases.&lt;/p&gt;
-&lt;h4&gt;ignored_testcases&lt;/h4&gt;
-&lt;p&gt;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 &lt;code&gt;tuple&lt;/code&gt; or &lt;code&gt;list&lt;/code&gt; of &lt;code&gt;path&lt;/code&gt;, &lt;code&gt;method&lt;/code&gt; and &lt;code&gt;response&lt;/code&gt;.&lt;/p&gt;
-&lt;h4&gt;response_validation&lt;/h4&gt;
-&lt;p&gt;By default, a &lt;code&gt;WARN&lt;/code&gt; 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:&lt;/p&gt;
+<doc>&lt;h2&gt;Test case generation and execution&lt;/h2&gt;
+
+&lt;h3&gt;included_paths&lt;/h3&gt;
+A list of paths that will be included when generating the test cases.
+The &lt;code&gt;*&lt;/code&gt; character can be used at the end of a partial path to include all paths
+starting with the partial path (wildcard include).
+
+&lt;h3&gt;ignored_paths&lt;/h3&gt;
+A list of paths that will be ignored when generating the test cases.
+The &lt;code&gt;*&lt;/code&gt; character can be used at the end of a partial path to ignore all paths
+starting with the partial path (wildcard ignore).
+
+&lt;h3&gt;ignored_responses&lt;/h3&gt;
+A list of responses that will be ignored when generating the test cases.
+
+&lt;h3&gt;ignored_testcases&lt;/h3&gt;
+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 &lt;code&gt;tuple&lt;/code&gt; or
+&lt;code&gt;list&lt;/code&gt; of &lt;code&gt;path&lt;/code&gt;, &lt;code&gt;method&lt;/code&gt; and &lt;code&gt;response&lt;/code&gt;.
+
+
+&lt;h2&gt;Base parameters&lt;/h2&gt;
+
+&lt;h3&gt;source&lt;/h3&gt;
+An absolute path to an openapi.json or openapi.yaml file or an url to such a file.
+
+&lt;h3&gt;origin&lt;/h3&gt;
+The server (and port) of the target server. E.g. &lt;code&gt;https://localhost:8000&lt;/code&gt;
+
+&lt;h3&gt;base_path&lt;/h3&gt;
+The routing between &lt;code&gt;origin&lt;/code&gt; and the paths as found in the &lt;code&gt;paths&lt;/code&gt;
+section in the openapi document.
+E.g. &lt;code&gt;/petshop/v2&lt;/code&gt;.
+
+&lt;h2&gt;Test case execution&lt;/h2&gt;
+
+&lt;h3&gt;response_validation&lt;/h3&gt;
+By default, a &lt;code&gt;WARN&lt;/code&gt; 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:
 &lt;ul&gt;
 &lt;li&gt;&lt;code&gt;DISABLED&lt;/code&gt;: All Response validation errors will be ignored&lt;/li&gt;
 &lt;li&gt;&lt;code&gt;INFO&lt;/code&gt;: Any Response validation erros will be logged at &lt;code&gt;INFO&lt;/code&gt; level&lt;/li&gt;
 &lt;li&gt;&lt;code&gt;WARN&lt;/code&gt;: Any Response validation erros will be logged at &lt;code&gt;WARN&lt;/code&gt; level&lt;/li&gt;
 &lt;li&gt;&lt;code&gt;STRICT&lt;/code&gt;: The Test Case will fail on any Response validation errors&lt;/li&gt;
 &lt;/ul&gt;
-&lt;h4&gt;disable_server_validation&lt;/h4&gt;
-&lt;p&gt;If enabled by setting this parameter to &lt;code&gt;True&lt;/code&gt;, 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 &lt;code&gt;localhost&lt;/code&gt; and &lt;code&gt;127.0.0.1&lt;/code&gt; are not considered the same by Response validation.&lt;/p&gt;
-&lt;h3&gt;API-specific configurations&lt;/h3&gt;
-&lt;h4&gt;mappings_path&lt;/h4&gt;
-&lt;p&gt;See &lt;a href="https://marketsquare.github.io/robotframework-openapi-libcore/advanced_use.html"&gt;this page&lt;/a&gt; for an in-depth explanation.&lt;/p&gt;
-&lt;h4&gt;invalid_property_default_response&lt;/h4&gt;
-&lt;p&gt;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.&lt;/p&gt;
-&lt;h4&gt;default_id_property_name&lt;/h4&gt;
-&lt;p&gt;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 &lt;code&gt;id&lt;/code&gt;. If the target API uses a different name for all the resources within the API, you can configure it globally using this property.&lt;/p&gt;
-&lt;p&gt;If different property names are used for the unique identifier for different types of resources, an &lt;code&gt;ID_MAPPING&lt;/code&gt; can be implemented using the &lt;code&gt;mappings_path&lt;/code&gt;.&lt;/p&gt;
-&lt;h4&gt;faker_locale&lt;/h4&gt;
-&lt;p&gt;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.&lt;/p&gt;
-&lt;h4&gt;require_body_for_invalid_url&lt;/h4&gt;
-&lt;p&gt;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.&lt;/p&gt;
-&lt;h3&gt;Parsing parameters&lt;/h3&gt;
-&lt;h4&gt;recursion_limit&lt;/h4&gt;
-&lt;p&gt;The recursion depth to which to fully parse recursive references before the &lt;span class="name"&gt;recursion_default&lt;/span&gt; is used to end the recursion.&lt;/p&gt;
-&lt;h4&gt;recursion_default&lt;/h4&gt;
-&lt;p&gt;The value that is used instead of the referenced schema when the &lt;span class="name"&gt;recursion_limit&lt;/span&gt; has been reached. The default &lt;span class="name"&gt;{}&lt;/span&gt; represents an empty object in JSON. Depending on schema definitions, this may cause schema validation errors. If this is the case, 'None' (&lt;code&gt;${NONE}&lt;/code&gt; in Robot Framework) or an empty list can be tried as an alternative.&lt;/p&gt;
-&lt;h3&gt;Security-related parameters&lt;/h3&gt;
-&lt;p&gt;&lt;i&gt;Note: these parameters are equivalent to those in the &lt;code&gt;requests&lt;/code&gt; library.&lt;/i&gt;&lt;/p&gt;
-&lt;h4&gt;username&lt;/h4&gt;
-&lt;p&gt;The username to be used for Basic Authentication.&lt;/p&gt;
-&lt;h4&gt;password&lt;/h4&gt;
-&lt;p&gt;The password to be used for Basic Authentication.&lt;/p&gt;
-&lt;h4&gt;security_token&lt;/h4&gt;
-&lt;p&gt;The token to be used for token based security using the &lt;code&gt;Authorization&lt;/code&gt; header.&lt;/p&gt;
-&lt;h4&gt;auth&lt;/h4&gt;
-&lt;p&gt;A &lt;a href="https://requests.readthedocs.io/en/latest/api/#authentication"&gt;requests &lt;code&gt;AuthBase&lt;/code&gt; instance&lt;/a&gt; to be used for authentication instead of the &lt;code&gt;username&lt;/code&gt; and &lt;code&gt;password&lt;/code&gt;.&lt;/p&gt;
-&lt;h4&gt;cert&lt;/h4&gt;
-&lt;p&gt;The SSL certificate to use with all requests. If string: the path to ssl client cert file (.pem). If tuple: the ('cert', 'key') pair.&lt;/p&gt;
-&lt;h4&gt;verify_tls&lt;/h4&gt;
-&lt;p&gt;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.&lt;/p&gt;
-&lt;h4&gt;extra_headers&lt;/h4&gt;
-&lt;p&gt;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.&lt;/p&gt;
-&lt;h4&gt;cookies&lt;/h4&gt;
-&lt;p&gt;A dictionary or &lt;a href="https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookieJar"&gt;CookieJar object&lt;/a&gt; to send with all requests.&lt;/p&gt;
-&lt;h4&gt;proxies&lt;/h4&gt;
-&lt;p&gt;A dictionary of 'protocol': 'proxy url' to use for all requests.&lt;/p&gt;</doc>
-<shortdoc> == Base parameters ==</shortdoc>
+
+&lt;h3&gt;disable_server_validation&lt;/h3&gt;
+If enabled by setting this parameter to &lt;code class="language-robotframework"&gt;${TRUE}&lt;/code&gt;,
+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 &lt;code&gt;localhost&lt;/code&gt; and &lt;code&gt;127.0.0.1&lt;/code&gt; are not considered the same
+by Response validation.
+
+&lt;h2&gt;API-specific configurations&lt;/h2&gt;
+
+&lt;h3&gt;mappings_path&lt;/h3&gt;
+See the Advanced Use tab for an in-depth explanation.
+
+&lt;h3&gt;invalid_property_default_response&lt;/h3&gt;
+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.
+
+&lt;h3&gt;default_id_property_name&lt;/h3&gt;
+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 &lt;code&gt;id&lt;/code&gt;.
+If the target API uses a different name for all the resources within the API,
+you can configure it globally using this property.
+
+If different property names are used for the unique identifier for different
+types of resources, an &lt;code&gt;ID_MAPPING&lt;/code&gt; can be implemented using the &lt;code&gt;mappings_path&lt;/code&gt;.
+
+&lt;h3&gt;faker_locale&lt;/h3&gt;
+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.
+
+&lt;h3&gt;require_body_for_invalid_url&lt;/h3&gt;
+    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.
+
+&lt;h2&gt;Parsing parameters&lt;/h2&gt;
+
+&lt;h3&gt;recursion_limit&lt;/h3&gt;
+The recursion depth to which to fully parse recursive references before the
+&lt;code&gt;recursion_default&lt;/code&gt; is used to end the recursion.
+
+&lt;h3&gt;recursion_default&lt;/h3&gt;
+The value that is used instead of the referenced schema when the
+&lt;code&gt;recursion_limit&lt;/code&gt; has been reached.
+The default &lt;code class="language-python"&gt;{}&lt;/code&gt; represents an empty object in JSON.
+Depending on schema definitions, this may cause schema validation errors.
+If this is the case &lt;code class="language-robotframework"&gt;${NONE}&lt;/code&gt; or an empty list
+can be tried as an alternative.
+
+&lt;h2&gt;Security-related parameters&lt;/h2&gt;
+&lt;blockquote&gt;&lt;i&gt;Note: these parameters are equivalent to those in the &lt;code&gt;requests&lt;/code&gt; library.&lt;/i&gt;&lt;/blockquote&gt;
+
+&lt;h3&gt;username&lt;/h3&gt;
+The username to be used for Basic Authentication.
+
+&lt;h3&gt;password&lt;/h3&gt;
+The password to be used for Basic Authentication.
+
+&lt;h3&gt;security_token&lt;/h3&gt;
+The token to be used for token based security using the &lt;code&gt;Authorization&lt;/code&gt; header.
+
+&lt;h3&gt;auth&lt;/h3&gt;
+A &lt;a href="https://requests.readthedocs.io/en/latest/api/#authentication" target="_blank"&gt;requests &lt;code&gt;AuthBase&lt;/code&gt; instance&lt;/a&gt; to be used for authentication instead of the &lt;code&gt;username&lt;/code&gt; and &lt;code&gt;password&lt;/code&gt;.
+
+&lt;h3&gt;cert&lt;/h3&gt;
+The SSL certificate to use with all requests.
+If string: the path to ssl client cert file (&lt;code&gt;.pem&lt;/code&gt;).
+If tuple: the &lt;code class="language-python"&gt;("cert", "key")&lt;/code&gt; pair.
+
+&lt;h3&gt;verify_tls&lt;/h3&gt;
+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.
+
+&lt;h3&gt;extra_headers&lt;/h3&gt;
+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.
+
+&lt;h3&gt;cookies&lt;/h3&gt;
+A dictionary or
+&lt;a href="https://docs.python.org/3/library/http.cookiejar.html#http.cookiejar.CookieJar" target="_blank"&gt;&lt;code&gt;CookieJar&lt;/code&gt; object&lt;/a&gt;
+to send with all requests.
+
+&lt;h3&gt;proxies&lt;/h3&gt;
+A dictionary of &lt;code&gt;"protocol": "proxy url"&lt;/code&gt; to use for all requests.</doc>
+<shortdoc>&lt;h2&gt;Test case generation and execution&lt;/h2&gt;</shortdoc>
 </init>
 </inits>
 <keywords>
-<kw name="Test Endpoint" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapi_executors.py" lineno="166">
+<kw name="Test Endpoint" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapi_executors.py" lineno="183">
 <arguments repr="path: str, method: str, status_code: int">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
 <name>path</name>
@@ -262,12 +340,17 @@
 <type name="int" typedoc="integer"/>
 </arg>
 </arguments>
-<doc>&lt;p&gt;Validate that performing the &lt;span class="name"&gt;method&lt;/span&gt; operation on &lt;a href="#type-Path" class="name"&gt;path&lt;/a&gt; results in a &lt;span class="name"&gt;status_code&lt;/span&gt; response.&lt;/p&gt;
-&lt;p&gt;This is the main keyword to be used in the &lt;span class="name"&gt;Test Template&lt;/span&gt; keyword when using the OpenApiDriver.&lt;/p&gt;
-&lt;p&gt;The keyword calls other keywords to generate the neccesary data to perform the desired operation and validate the response against the openapi document.&lt;/p&gt;</doc>
+<doc>Validate that performing the &lt;span class="name"&gt;method&lt;/span&gt; operation on &lt;a href="#type-Path" class="name"&gt;path&lt;/a&gt; results in a
+&lt;span class="name"&gt;status_code&lt;/span&gt; response.
+
+This is the main keyword to be used in the &lt;span class="name"&gt;Test Template&lt;/span&gt; keyword when using
+the OpenApiDriver.
+
+The keyword calls other keywords to generate the neccesary data to perform
+the desired operation and validate the response against the openapi document.</doc>
 <shortdoc>Validate that performing the `method` operation on `path` results in a `status_code` response.</shortdoc>
 </kw>
-<kw name="Test Forbidden" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapi_executors.py" lineno="98">
+<kw name="Test Forbidden" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapi_executors.py" lineno="115">
 <arguments repr="path: str, method: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
 <name>path</name>
@@ -278,12 +361,17 @@
 <type name="str" typedoc="string"/>
 </arg>
 </arguments>
-<doc>&lt;p&gt;Perform a request for &lt;span class="name"&gt;method&lt;/span&gt; on the &lt;a href="#type-Path" class="name"&gt;path&lt;/a&gt;, with the provided authorization.&lt;/p&gt;
-&lt;p&gt;This keyword only passes if the response code is 403: Forbidden.&lt;/p&gt;
-&lt;p&gt;For this keyword to pass, the authorization parameters used to initialize the library should grant insufficient access rights to the target endpoint. &amp;gt; Note: No headers or (json) body are send with the request. For security reasons, the access rights validation should be checked first.&lt;/p&gt;</doc>
+<doc>Perform a request for &lt;span class="name"&gt;method&lt;/span&gt; on the &lt;a href="#type-Path" class="name"&gt;path&lt;/a&gt;, with the provided authorization.
+
+This keyword only passes if the response code is 403: Forbidden.
+
+For this keyword to pass, the authorization parameters used to initialize the
+library should grant insufficient access rights to the target endpoint.
+&gt; Note: No headers or (json) body are send with the request. For security
+reasons, the access rights validation should be checked first.</doc>
 <shortdoc>Perform a request for `method` on the `path`, with the provided authorization.</shortdoc>
 </kw>
-<kw name="Test Invalid Url" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapi_executors.py" lineno="115">
+<kw name="Test Invalid Url" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapi_executors.py" lineno="132">
 <arguments repr="path: str, method: str, expected_status_code: int = 404">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
 <name>path</name>
@@ -299,13 +387,23 @@
 <default>404</default>
 </arg>
 </arguments>
-<doc>&lt;p&gt;Perform a request for the provided 'path' and 'method' where the url for the &lt;a href="#type-Path" class="name"&gt;path&lt;/a&gt; is invalidated.&lt;/p&gt;
-&lt;p&gt;This keyword will be &lt;span class="name"&gt;SKIPPED&lt;/span&gt; if the path contains no parts that can be invalidated and there is no mapping for a PathPropertiesConstraint for the &lt;span class="name"&gt;expected_status_code&lt;/span&gt;.&lt;/p&gt;
-&lt;p&gt;The optional &lt;span class="name"&gt;expected_status_code&lt;/span&gt; parameter (default: 404) can be set to the expected status code for APIs that do not return a 404 on invalid urls.&lt;/p&gt;
-&lt;p&gt;&amp;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 &lt;span class="name"&gt;require_body_for_invalid_url&lt;/span&gt; parameter can be set to &lt;span class="name"&gt;True&lt;/span&gt; if needed.&lt;/p&gt;</doc>
+<doc>Perform a request for the provided 'path' and 'method' where the url for
+the &lt;a href="#type-Path" class="name"&gt;path&lt;/a&gt; is invalidated.
+
+This keyword will be &lt;span class="name"&gt;SKIPPED&lt;/span&gt; if the path contains no parts
+that can be invalidated and there is no mapping for a
+PathPropertiesConstraint for the &lt;span class="name"&gt;expected_status_code&lt;/span&gt;.
+
+The optional &lt;span class="name"&gt;expected_status_code&lt;/span&gt; parameter (default: 404) can be set to the
+expected status code for APIs that do not return a 404 on invalid urls.
+
+&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 &lt;span class="name"&gt;require_body_for_invalid_url&lt;/span&gt;
+parameter can be set to &lt;span class="name"&gt;True&lt;/span&gt; if needed.</doc>
 <shortdoc>Perform a request for the provided 'path' and 'method' where the url for the `path` is invalidated.</shortdoc>
 </kw>
-<kw name="Test Unauthorized" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapi_executors.py" lineno="77">
+<kw name="Test Unauthorized" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapi_executors.py" lineno="94">
 <arguments repr="path: str, method: str">
 <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
 <name>path</name>
@@ -316,9 +414,14 @@
 <type name="str" typedoc="string"/>
 </arg>
 </arguments>
-<doc>&lt;p&gt;Perform a request for &lt;span class="name"&gt;method&lt;/span&gt; on the &lt;a href="#type-Path" class="name"&gt;path&lt;/a&gt;, with no authorization.&lt;/p&gt;
-&lt;p&gt;This keyword only passes if the response code is 401: Unauthorized.&lt;/p&gt;
-&lt;p&gt;Any authorization parameters used to initialize the library are ignored for this request. &amp;gt; Note: No headers or (json) body are send with the request. For security reasons, the authorization validation should be checked first.&lt;/p&gt;</doc>
+<doc>Perform a request for &lt;span class="name"&gt;method&lt;/span&gt; on the &lt;a href="#type-Path" class="name"&gt;path&lt;/a&gt;, with no authorization.
+
+This keyword only passes if the response code is 401: Unauthorized.
+
+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.</doc>
 <shortdoc>Perform a request for `method` on the `path`, with no authorization.</shortdoc>
 </kw>
 </keywords>
@@ -421,7 +524,7 @@
 </usages>
 </type>
 <type name="ValidationLevel" type="Enum">
-<doc>&lt;p&gt;The available levels for the response_validation parameter.&lt;/p&gt;</doc>
+<doc>The available levels for the response_validation parameter.</doc>
 <accepts>
 <type>string</type>
 </accepts>