V1 release: major (internal) refactor and interface / terminology corrections

.devcontainer/Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.13-slim-bookworm
+FROM python:3.10-slim-bookworm
 
 # Update the certificates
 RUN apt-get update && \
@@ -32,10 +32,9 @@ ENV PATH="$PATH:$POETRY_HOME/bin"
 RUN curl -sSL https://install.python-poetry.org | python3 -
 RUN poetry self update
 
-# Configure poetry to not create virtual environments.
-# This is done to force package installation to the global Python install so that users
-# other than the Docker root user have access to the installed packages.
-RUN poetry config virtualenvs.create false
+# Configure poetry to create virtual environments in the project.
+# This is done to be compatible with how uv and PDM set up the venvs.
+RUN poetry config virtualenvs.in-project true
 
 EXPOSE 8888
 ENTRYPOINT ["/bin/sh"]

.vscode/example.launch.json

@@ -0,0 +1,20 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python Debugger: testserver",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "uvicorn",
+            "args": [
+                "testserver:app",
+                "--app-dir=./tests/server",
+                "--host=0.0.0.0",
+                "--port=8000",
+            ]
+        }
+    ]
+}

docs/advanced_use.md

@@ -4,7 +4,7 @@
 When working with APIs, there are often relations between resources or constraints on values.
 The property on one resource may refer to the `id` of another resource.
 The value for a certain property may have to be unique within a certain scope.
-Perhaps an endpoint path contains parameters that must match values that are defined outside the API itself.
+Perhaps an url contains parameters that must match values that are defined outside the API itself.
 
 These types of relations and limitations cannot be described / modeled within the openapi document.
 To support automatic validation of API endpoints where such relations apply, OpenApiLibCore supports the usage of a custom mappings file.
@@ -42,7 +42,7 @@ from OpenApiLibCore import (
 
 
 ID_MAPPING = {
-    "/myspecialendpoint", "special_thing_id",
+    "/myspecialpath", "special_thing_id",
 }
 
 
@@ -54,7 +54,7 @@ class MyDtoThatDoesNothing(Dto):
 
 
 DTO_MAPPING = {
-    ("/myspecialendpoint", "post"): MyDtoThatDoesNothing
+    ("/myspecialpath", "post"): MyDtoThatDoesNothing
 }
 
 ```
@@ -88,16 +88,16 @@ def my_transformer(identifier_name: str) -> str:
 
 
 ID_MAPPING = {
-    "/myspecialendpoint": ("special_thing_id", my_transformer),
+    "/myspecialpath": ("special_thing_id", my_transformer),
 }
 
 ```
 
 ### The DTO_MAPPING
 The `DTO_MAPPING` is a dictionary with a tuple as its key and a mappings Dto as its value.
-The tuple must be in the form `("endpoint_from_the_paths_section", "method_supported_by_the_endpoint")`.
-The `endpoint_from_the_paths_section` must be exactly as found in the openapi document.
-The `method_supported_by_the_endpoint` must be one of the methods supported by the endpoint and must be in lowercase.
+The tuple must be in the form `("path_from_the_paths_section", "method_supported_by_the_path")`.
+The `path_from_the_paths_section` must be exactly as found in the openapi document.
+The `method_supported_by_the_path` must be one of the methods supported by the path and must be in lowercase.
 
 
 ## Dto mapping classes
@@ -108,10 +108,10 @@ Each of these classes is designed to handle a relation or constraint commonly se
 
 To explain the different mapping classes, we'll use the following example:
 
-Imagine we have an API endpoint `/employees` where we can create (`post`) a new Employee resource.
+Imagine we have an API path `/employees` where we can create (`post`) a new Employee resource.
 The Employee has a number of required properties; name, employee_number, wagegroup_id, and date_of_birth.
 
-There is also the the `/wagegroups` endpoint where a Wagegroup resource can be created.
+There is also the the `/wagegroups` path where a Wagegroup resource can be created.
 This Wagegroup also has a number of required properties: name and hourly rate.
 
 ---
@@ -159,7 +159,7 @@ This `error_code` should be described as one of the `responses` in the openapi d
 
 If an Employee has been added to the system, this Employee refers to the `id` of a Wagegroup for its required `employee_number` property.
 
-Now let's say there is also the `/wagegroups/${wagegroup_id}` endpoint that supports the `delete` operation.
+Now let's say there is also the `/wagegroups/${wagegroup_id}` path that supports the `delete` operation.
 If the Wagegroup refered to the Employee would be deleted, the Employee would be left with an invalid reference for one of its required properties.
 To prevent this, an API typically returns an `error_code` when such a `delete` operation is attempted on a resource that is refered to in this fashion.
 This `error_code` should be described as one of the `responses` in the openapi document for the `delete` operation of the `/wagegroups/${wagegroup_id}` path.
@@ -314,9 +314,9 @@ To be able to automatically perform endpoint validations, the OpenApiLibCore has
 Often, such a `path` contains a reference to a resource id, e.g. `/employees/${employee_id}`.
 When such an `id` is needed, the OpenApiLibCore tries to obtain a valid `id` by taking these steps:
 
-1. Attempt a `post` on the "parent endpoint" and extract the `id` from the response.
-In our example: perform a `post` request on the `/employees` endpoint and get the `id` from the response.
-2. If 1. fails, perform a `get` request on the `/employees` endpoint. It is assumed that this will return a list of Employee objects with an `id`.
+1. Attempt a `post` on the "parent path" and extract the `id` from the response.
+In our example: perform a `post` request on the `/employees` path and get the `id` from the response.
+2. If 1. fails, perform a `get` request on the `/employees` path. It is assumed that this will return a list of Employee objects with an `id`.
 One item from the returned list is picked at rondom and its `id` is used.
 
 This mechanism relies on the standard REST structure and patterns.
@@ -339,14 +339,15 @@ DTO_MAPPING = {
     ("/birthdays/{month}/{date}", "get"): BirthdaysDto
 }
 ```
+> Note: To take a `PathPropertiesConstraint` into use, the related Dto must be mapped to the `get` operation for the `path` in the `DTO_MAPPING` even if no such endpoint exists in the API.
 
 ---
 
 ### `IGNORE`
 > *Never send this query parameter as part of a request*
 
 Some optional query parameters have a range of valid values that depend on one or more path parameters.
-Since path parameters are part of a url, they cannot be optional or empty so to extend the path parameters with optional parameters, query parameters can be used.
+Since path parameters are part of an url, they cannot be optional or empty so to extend the path parameters with optional parameters, query parameters can be used.
 
 To illustrate this, let's imagine an API where the energy label for a building can be requested: `/energylabel/${zipcode}/${home_number}`.
 Some addresses however have an address extension, e.g. 1234AB 42 <sup>2.C</sup>.

docs/driver.md

@@ -37,7 +37,7 @@ The OpenAPI Specification (OAS) defines a standard, language-agnostic interface
 to RESTful APIs, see https://swagger.io/specification/
 
 The OpenApiDriver module implements a reader class that generates a test case for
-each endpoint, method and response that is defined in an OpenAPI document, typically
+each path, method and response that is defined in an OpenAPI document, typically
 an openapi.json or openapi.yaml file.
 
 > Note: OpenApiDriver is designed for APIs based on the OAS v3
@@ -88,13 +88,13 @@ Library            OpenApiDriver
 Test Template      Validate Using Test Endpoint Keyword
 
 *** Test Cases ***
-Test Endpoint for ${method} on ${endpoint} where ${status_code} is expected
+Test Endpoint for ${method} on ${path} where ${status_code} is expected
 
 *** Keywords ***
 Validate Using Test Endpoint Keyword
-    [Arguments]    ${endpoint}    ${method}    ${status_code}
+    [Arguments]    ${path}    ${method}    ${status_code}
     Test Endpoint
-    ...    endpoint=${endpoint}    method=${method}    status_code=${status_code}
+    ...    path=${path}    method=${method}    status_code=${status_code}
 
 ```
 

docs/libcore.md

@@ -76,7 +76,7 @@ recursion in them. See the `recursion_limit` and `recursion_default` parameters.
 
 If the openapi document passes this validation, the next step is trying to do a test
 run with a minimal test suite.
-The example below can be used, with `source`, `origin` and 'endpoint' altered to
+The example below can be used, with `source`, `origin` and `path` altered to
 fit your situation.
 
 ``` robotframework
@@ -87,7 +87,7 @@ Library            OpenApiLibCore
 
 *** Test Cases ***
 Getting Started
-    ${url}=    Get Valid Url    endpoint=/employees/{employee_id}   method=get
+    ${url}=    Get Valid Url    path=/employees/{employee_id}
 
 ```