V2 release

.devcontainer/Dockerfile

@@ -36,5 +36,8 @@ RUN poetry self update
 # This is done to be compatible with how uv and PDM set up the venvs.
 RUN poetry config virtualenvs.in-project true
 
+# Ensure the latest pyright version is used within the container.
+ENV PYRIGHT_PYTHON_FORCE_VERSION="latest"
+
 EXPOSE 8888
 ENTRYPOINT ["/bin/sh"]

.devcontainer/devcontainer.json

@@ -20,9 +20,8 @@
                 "charliermarsh.ruff",
                 "d-biehl.robotcode",
                 "tamasfe.even-better-toml",
-                "ms-azuretools.vscode-docker",
-                "Gruntfuggly.todo-tree",
-                "shardulm94.trailing-spaces"
+                "ms-azuretools.vscode-docker"
+
 			]
 		}
 	}

.github/workflows/on-push.yml

@@ -53,15 +53,17 @@ jobs:
     strategy:
       matrix:
         os: [ 'ubuntu-latest', 'windows-latest']
-        python-version: ['3.10', '3.11', '3.12', '3.13']
-        robot-version: ['6.1.1', '7.3.2']
+        python-version: ['3.10', '3.11', '3.12', '3.13', '3.14']
+        robot-version: ['6.1.1', '7.4.1']
         exclude:
           - os: 'windows-latest'
             python-version: '3.10'
           - os: 'windows-latest'
             python-version: '3.11'
           - os: 'windows-latest'
             python-version: '3.12'
+          - os: 'windows-latest'
+            python-version: '3.13'
           - os: 'ubuntu-latest'
             python-version: '3.10'
             robot-version: '6.1.1'
@@ -71,6 +73,9 @@ jobs:
           - os: 'ubuntu-latest'
             python-version: '3.12'
             robot-version: '6.1.1'
+          - os: 'ubuntu-latest'
+            python-version: '3.13'
+            robot-version: '6.1.1'
       fail-fast: false
     steps:
     - uses: actions/checkout@v6
@@ -96,7 +101,7 @@ jobs:
         tail: true
         wait-for: 1m
     - name: Run tests on latest RF 7 version
-      if: matrix.robot-version == '7.3.2'
+      if: matrix.robot-version == '7.4.1'
       run: |
         inv tests
     - name: Run tests on latest RF 6 version

.gitignore

@@ -25,9 +25,10 @@ coverage.xml
 env/
 venv/
 
-# IDE config
+# IDE config and local tool settings
 .vscode/launch.json
 .vscode/settings.json
+.robot.toml
 
 # default logs location for the repo
 tests/logs

docs/index.html

@@ -644,10 +644,10 @@ <h2>The custom mappings file</h2>
 <div class="code-block"><pre><code class="language-python">
 from OpenApiLibCore import (
     IGNORE,
-    Dto,
     IdDependency,
     IdReference,
     PathPropertiesConstraint,
+    RelationsMapping,
     PropertyValueConstraint,
     UniquePropertyValueConstraint,
 )
@@ -658,7 +658,7 @@ <h2>The custom mappings file</h2>
 }
 
 
-class MyDtoThatDoesNothing(Dto):
+class MyMappingThatDoesNothing(RelationsMapping):
     @staticmethod
     def get_relations():
         relations = []
@@ -675,13 +675,13 @@ <h2>The custom mappings file</h2>
         return relations
 
 
-DTO_MAPPING = {
-    ("/myspecialpath", "post"): MyDtoThatDoesNothing
+RELATIONS_MAPPING = {
+    ("/myspecialpath", "post"): MyMappingThatDoesNothing
 }
 
 
 PATH_MAPPING = {
-    "/mypathwithexternalid/{external_id}": MyDtoThatDoesNothing
+    "/mypathwithexternalid/{external_id}": MyMappingThatDoesNothing
 }
 
 </code></pre></div>
@@ -693,13 +693,13 @@ <h2>The custom mappings file</h2>
 Here the classes needed to implement custom mappings are imported.
 This section can just be copied without changes.</li>
 <li>The <code class="language-python">ID_MAPPING</code> "constant" definition / assignment.</li>
-<li>The section defining the mapping Dtos. More on this later.</li>
-<li>The <code class="language-python">DTO_MAPPING</code> "constant" definition / assignment.</li>
+<li>The section defining the RelationsMappings. More on this later.</li>
+<li>The <code class="language-python">RELATIONS_MAPPING</code> "constant" definition / assignment.</li>
 <li>The <code class="language-python">PATH_MAPPING</code> "constant" definition / assignment.</li>
 </ol>
 
-<h2>The ID_MAPPING, DTO_MAPPING and PATH_MAPPING</h2>
-When a custom mappings file is used, the OpenApiLibCore will attempt to import it and then import <code>DTO_MAPPING</code>, <code>PATH_MAPPING</code> and <code>ID_MAPPING</code> from it.
+<h2>The ID_MAPPING, RELATIONS_MAPPING and PATH_MAPPING</h2>
+When a custom mappings file is used, the OpenApiLibCore will attempt to import it and then import <code>RELATIONS_MAPPING</code>, <code>PATH_MAPPING</code> and <code>ID_MAPPING</code> from it.
 For this reason, the exact same name must be used in a custom mappings file (capitilization matters).
 
 <h3>The ID_MAPPING</h3>
@@ -721,18 +721,18 @@ <h3>The ID_MAPPING</h3>
 
 </code></pre></div>
 
-<h3>The DTO_MAPPING</h3>
-The <code>DTO_MAPPING</code> is a dictionary with a tuple as its key and a mappings Dto as its value.
+<h3>The RELATIONS_MAPPING</h3>
+The <code>RELATIONS_MAPPING</code> is a dictionary with a tuple as its key and a RelationsMapping as its value.
 The tuple must be in the form <code class="language-python">("path_from_the_paths_section", "method_supported_by_the_path")</code>.
 The <code class="language-python">path_from_the_paths_section</code> must be exactly as found in the openapi document.
 The <code class="language-python">method_supported_by_the_path</code> must be one of the methods supported by the path and must be in lowercase.
 
 <h3>The PATH_MAPPING</h3>
-The <code>PATH_MAPPING</code> is a dictionary with a <code>"path_from_the_paths_section"</code> as its key and a mappings Dto as its value.
+The <code>PATH_MAPPING</code> is a dictionary with a <code>"path_from_the_paths_section"</code> as its key and a RelationsMapping as its value.
 The <code>path_from_the_paths_section</code> must be exactly as found in the openapi document.
 
 
-<h2>Dto mapping classes</h2>
+<h2>RelationsMapping classes</h2>
 As can be seen from the import section above, a number of classes are available to deal with relations between resources and / or constraints on properties.
 Each of these classes is designed to handle a relation or constraint commonly seen in REST APIs.
 
@@ -757,7 +757,7 @@ <h3><code>IdReference</code></h3>
 This relation can be implemented as follows:
 
 <div class="code-block"><pre><code class="language-python">
-class EmployeeDto(Dto):
+class EmployeeMapping(RelationsMapping):
     @staticmethod
     def get_relations():
         relations = [
@@ -769,8 +769,8 @@ <h3><code>IdReference</code></h3>
         ]
         return relations
 
-DTO_MAPPING = {
-    ("/employees", "post"): EmployeeDto
+RELATIONS_MAPPING = {
+    ("/employees", "post"): EmployeeMapping
 }
 
 </code></pre></div>
@@ -801,7 +801,7 @@ <h3><code>IdDependency</code></h3>
 To verify that the specified <code>error_code</code> indeed occurs when attempting to <code>delete</code> the Wagegroup, we can implement the following dependency:
 
 <div class="code-block"><pre><code class="language-python">
-class WagegroupDto(Dto):
+class WagegroupMapping(RelationsMapping):
     @staticmethod
     def get_relations():
         relations = [
@@ -813,8 +813,8 @@ <h3><code>IdDependency</code></h3>
         ]
         return relations
 
-DTO_MAPPING = {
-    ("/wagegroups/{wagegroup_id}", "delete"): WagegroupDto
+RELATIONS_MAPPING = {
+    ("/wagegroups/{wagegroup_id}", "delete"): WagegroupMapping
 }
 
 </code></pre></div>
@@ -833,7 +833,7 @@ <h3><code>UniquePropertyValueConstraint</code></h3>
 To verify that the specified <code>error_code</code> occurs when attempting to <code>post</code> an Employee with an <code>employee_number</code> that is already in use, we can implement the following dependency:
 
 <div class="code-block"><pre><code class="language-python">
-class EmployeeDto(Dto):
+class EmployeeMapping(RelationsMapping):
     @staticmethod
     def get_relations():
         relations = [
@@ -845,15 +845,15 @@ <h3><code>UniquePropertyValueConstraint</code></h3>
         ]
         return relations
 
-DTO_MAPPING = {
-    ("/employees", "post"): EmployeeDto,
-    ("/employees/${employee_id}", "put"): EmployeeDto,
-    ("/employees/${employee_id}", "patch"): EmployeeDto,
+RELATIONS_MAPPING = {
+    ("/employees", "post"): EmployeeMapping,
+    ("/employees/${employee_id}", "put"): EmployeeMapping,
+    ("/employees/${employee_id}", "patch"): EmployeeMapping,
 }
 
 </code></pre></div>
 
-Note how this example reuses the <code>EmployeeDto</code> to model the uniqueness constraint for all the operations (<code>post</code>, <code>put</code> and <code>patch</code>) that all relate to the same <code>employee_number</code>.
+Note how this example reuses the <code>EmployeeMapping</code> to model the uniqueness constraint for all the operations (<code>post</code>, <code>put</code> and <code>patch</code>) that all relate to the same <code>employee_number</code>.
 
 <hr>
 
@@ -867,7 +867,7 @@ <h3><code>PropertyValueConstraint</code></h3>
 This type of constraint can be modeled as follows:
 
 <div class="code-block"><pre><code class="language-python">
-class EmployeeDto(Dto):
+class EmployeeMapping(RelationsMapping):
     @staticmethod
     def get_relations():
         relations = [
@@ -879,10 +879,10 @@ <h3><code>PropertyValueConstraint</code></h3>
         ]
         return relations
 
-DTO_MAPPING = {
-    ("/employees", "post"): EmployeeDto,
-    ("/employees/${employee_id}", "put"): EmployeeDto,
-    ("/employees/${employee_id}", "patch"): EmployeeDto,
+RELATIONS_MAPPING = {
+    ("/employees", "post"): EmployeeMapping,
+    ("/employees/${employee_id}", "put"): EmployeeMapping,
+    ("/employees/${employee_id}", "patch"): EmployeeMapping,
 }
 
 </code></pre></div>
@@ -891,7 +891,7 @@ <h3><code>PropertyValueConstraint</code></h3>
 To support additional restrictions like these, the <code class="language-python">PropertyValueConstraint</code> supports two additional properties: <code class="language-python">error_value</code> and <code class="language-python">invalid_value_error_code</code>:
 
 <div class="code-block"><pre><code class="language-python">
-class EmployeeDto(Dto):
+class EmployeeMapping(RelationsMapping):
     @staticmethod
     def get_relations():
         relations = [
@@ -905,10 +905,10 @@ <h3><code>PropertyValueConstraint</code></h3>
         ]
         return relations
 
-DTO_MAPPING = {
-    ("/employees", "post"): EmployeeDto,
-    ("/employees/${employee_id}", "put"): EmployeeDto,
-    ("/employees/${employee_id}", "patch"): EmployeeDto,
+RELATIONS_MAPPING = {
+    ("/employees", "post"): EmployeeMapping,
+    ("/employees/${employee_id}", "put"): EmployeeMapping,
+    ("/employees/${employee_id}", "patch"): EmployeeMapping,
 }
 
 </code></pre></div>
@@ -920,7 +920,7 @@ <h3><code>PropertyValueConstraint</code></h3>
 This situation can be handled by use of the special <code class="language-python">IGNORE</code> value (see below for other uses):
 
 <div class="code-block"><pre><code class="language-python">
-class EmployeeDto(Dto):
+class EmployeeMapping(RelationsMapping):
     @staticmethod
     def get_relations():
         relations = [
@@ -934,10 +934,10 @@ <h3><code>PropertyValueConstraint</code></h3>
         ]
         return relations
 
-DTO_MAPPING = {
-    ("/employees", "post"): EmployeeDto,
-    ("/employees/${employee_id}", "put"): EmployeeDto,
-    ("/employees/${employee_id}", "patch"): EmployeeDto,
+RELATIONS_MAPPING = {
+    ("/employees", "post"): EmployeeMapping,
+    ("/employees/${employee_id}", "put"): EmployeeMapping,
+    ("/employees/${employee_id}", "patch"): EmployeeMapping,
 }
 
 </code></pre></div>
@@ -950,7 +950,7 @@ <h3><code>PathPropertiesConstraint</code></h3>
 <blockquote><u>Just use this for the <code>path</code></u></blockquote>
 
 <blockquote><i>
-Note: The <code class="language-python">PathPropertiesConstraint</code> is only applicable to the <code class="language-python">get_path_relations</code> in a <code class="language-python">Dto</code> and only the <code class="language-python">PATH_MAPPING</code> uses the <code class="language-python">get_path_relations</code>.
+Note: The <code class="language-python">PathPropertiesConstraint</code> is only applicable to the <code class="language-python">get_path_relations</code> in a <code class="language-python">RelationsMapping</code> and only the <code class="language-python">PATH_MAPPING</code> uses the <code class="language-python">get_path_relations</code>.
 </i></blockquote>
 
 To be able to automatically perform endpoint validations, the OpenApiLibCore has to construct the <code>url</code> for the resource from the <code>path</code> as found in the openapi document.
@@ -970,7 +970,7 @@ <h3><code>PathPropertiesConstraint</code></h3>
 It should be clear that the OpenApiLibCore won't be able to acquire a valid <code>month</code> and <code>date</code>. The <code class="language-python">PathPropertiesConstraint</code> can be used in this case:
 
 <div class="code-block"><pre><code class="language-python">
-class BirthdaysDto(Dto):
+class BirthdaysMapping(RelationsMapping):
     @staticmethod
     def get_path_relations():
         relations = [
@@ -979,7 +979,7 @@ <h3><code>PathPropertiesConstraint</code></h3>
         return relations
 
 PATH_MAPPING = {
-    "/birthdays/{month}/{date}": BirthdaysDto
+    "/birthdays/{month}/{date}": BirthdaysMapping
 }
 
 </code></pre></div>
@@ -999,7 +999,7 @@ <h3><code>IGNORE</code></h3>
 To prevent OpenApiLibCore from generating invalid combinations of path and query parameters in this type of endpoint, the <code class="language-python">IGNORE</code> special value can be used to ensure the related query parameter is never send in a request.
 
 <div class="code-block"><pre><code class="language-python">
-class EnergyLabelDto(Dto):
+class EnergyLabelMapping(RelationsMapping):
     @staticmethod
     def get_parameter_relations():
         relations = [
@@ -1018,8 +1018,8 @@ <h3><code>IGNORE</code></h3>
         ]
         return relations
 
-DTO_MAPPING = {
-    ("/energy_label/{zipcode}/{home_number}", "get"): EnergyLabelDto,
+RELATIONS_MAPPING = {
+    ("/energy_label/{zipcode}/{home_number}", "get"): EnergyLabelMapping,
 }
 
 </code></pre></div>
@@ -1032,7 +1032,7 @@ <h3><code>IGNORE</code></h3>
 Such situations can be handled by a mapping as shown below:
 </p>
 <div class="code-block"><pre><code class="language-python">
-class PatchEmployeeDto(Dto):
+class PatchEmployeeMapping(RelationsMapping):
     @staticmethod
     def get_parameter_relations() -> list[ResourceRelation]:
         relations: list[ResourceRelation] = [
@@ -1051,8 +1051,8 @@ <h3><code>IGNORE</code></h3>
         ]
         return relations
 
-DTO_MAPPING = {
-    ("/employees/{employee_id}", "patch"): PatchEmployeeDto,
+RELATIONS_MAPPING = {
+    ("/employees/{employee_id}", "patch"): PatchEmployeeMapping,
 }
 
 </code></pre></div>