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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. OpenApiDriver/__init__.py +44 -41
  2. OpenApiDriver/openapi_executors.py +40 -39
  3. OpenApiDriver/openapi_reader.py +115 -116
  4. OpenApiDriver/openapidriver.libspec +71 -61
  5. OpenApiDriver/openapidriver.py +25 -19
  6. OpenApiLibCore/__init__.py +13 -11
  7. OpenApiLibCore/annotations.py +3 -0
  8. OpenApiLibCore/data_generation/__init__.py +12 -0
  9. OpenApiLibCore/data_generation/body_data_generation.py +269 -0
  10. OpenApiLibCore/data_generation/data_generation_core.py +240 -0
  11. OpenApiLibCore/data_invalidation.py +281 -0
  12. OpenApiLibCore/dto_base.py +29 -35
  13. OpenApiLibCore/dto_utils.py +97 -85
  14. OpenApiLibCore/oas_cache.py +14 -13
  15. OpenApiLibCore/openapi_libcore.libspec +346 -193
  16. OpenApiLibCore/openapi_libcore.py +389 -1702
  17. OpenApiLibCore/parameter_utils.py +91 -0
  18. OpenApiLibCore/path_functions.py +215 -0
  19. OpenApiLibCore/path_invalidation.py +44 -0
  20. OpenApiLibCore/protocols.py +30 -0
  21. OpenApiLibCore/request_data.py +281 -0
  22. OpenApiLibCore/resource_relations.py +54 -0
  23. OpenApiLibCore/validation.py +497 -0
  24. OpenApiLibCore/value_utils.py +528 -481
  25. openapi_libgen/__init__.py +46 -0
  26. openapi_libgen/command_line.py +87 -0
  27. openapi_libgen/parsing_utils.py +26 -0
  28. openapi_libgen/spec_parser.py +221 -0
  29. openapi_libgen/templates/__init__.jinja +3 -0
  30. openapi_libgen/templates/library.jinja +30 -0
  31. robotframework_openapitools-1.0.0b2.dist-info/METADATA +237 -0
  32. robotframework_openapitools-1.0.0b2.dist-info/RECORD +37 -0
  33. {robotframework_openapitools-0.4.0.dist-info → robotframework_openapitools-1.0.0b2.dist-info}/WHEEL +1 -1
  34. robotframework_openapitools-1.0.0b2.dist-info/entry_points.txt +3 -0
  35. roboswag/__init__.py +0 -9
  36. roboswag/__main__.py +0 -3
  37. roboswag/auth.py +0 -44
  38. roboswag/cli.py +0 -80
  39. roboswag/core.py +0 -85
  40. roboswag/generate/__init__.py +0 -1
  41. roboswag/generate/generate.py +0 -121
  42. roboswag/generate/models/__init__.py +0 -0
  43. roboswag/generate/models/api.py +0 -219
  44. roboswag/generate/models/definition.py +0 -28
  45. roboswag/generate/models/endpoint.py +0 -68
  46. roboswag/generate/models/parameter.py +0 -25
  47. roboswag/generate/models/response.py +0 -8
  48. roboswag/generate/models/tag.py +0 -16
  49. roboswag/generate/models/utils.py +0 -60
  50. roboswag/generate/templates/api_init.jinja +0 -15
  51. roboswag/generate/templates/models.jinja +0 -7
  52. roboswag/generate/templates/paths.jinja +0 -68
  53. roboswag/logger.py +0 -33
  54. roboswag/validate/__init__.py +0 -6
  55. roboswag/validate/core.py +0 -3
  56. roboswag/validate/schema.py +0 -21
  57. roboswag/validate/text_response.py +0 -14
  58. robotframework_openapitools-0.4.0.dist-info/METADATA +0 -42
  59. robotframework_openapitools-0.4.0.dist-info/RECORD +0 -41
  60. {robotframework_openapitools-0.4.0.dist-info → robotframework_openapitools-1.0.0b2.dist-info}/LICENSE +0 -0
OpenApiLibCore/openapi_libcore.libspec CHANGED
@@ -1,13 +1,13 @@
1
1
  <?xml version="1.0" encoding="UTF-8"?>
2
- <keywordspec name="OpenApiLibCore" type="LIBRARY" format="HTML" scope="SUITE" generated="2024-12-04T12:16:36+00:00" specversion="6" source="/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py" lineno="457">
3
- <version>0.4.0</version>
2
+ <keywordspec name="OpenApiLibCore" type="LIBRARY" format="HTML" scope="SUITE" generated="2025-04-03T11:37:50+00:00" specversion="6" source="/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py" lineno="170">
3
+ <version>1.0.0b2</version>
4
4
  <doc>&lt;p&gt;Main class providing the keywords and core logic to interact with an OpenAPI server.&lt;/p&gt;
5
5
  &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>
6
6
  <tags>
7
7
  </tags>
8
8
  <inits>
9
- <init name="__init__" lineno="465">
10
- <arguments repr="source: str, origin: str = , base_path: str = , 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] | None = None, require_body_for_invalid_url: bool = False, 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">
9
+ <init name="__init__" lineno="178">
10
+ <arguments repr="source: str, origin: str = , base_path: str = , 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: dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None = {}, 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">
11
11
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="source: str">
12
12
  <name>source</name>
13
13
  <type name="str" typedoc="string"/>
@@ -50,16 +50,15 @@
50
50
  <type name="str" typedoc="string"/>
51
51
  <default>id</default>
52
52
  </arg>
53
- <arg kind="POSITIONAL_OR_NAMED" required="false" repr="faker_locale: str | List[str] | None = None">
53
+ <arg kind="POSITIONAL_OR_NAMED" required="false" repr="faker_locale: str | list[str] = ">
54
54
  <name>faker_locale</name>
55
55
  <type name="Union" union="true">
56
56
  <type name="str" typedoc="string"/>
57
- <type name="List" typedoc="list">
57
+ <type name="list" typedoc="list">
58
58
  <type name="str" typedoc="string"/>
59
59
  </type>
60
- <type name="None" typedoc="None"/>
61
60
  </type>
62
- <default>None</default>
61
+ <default/>
63
62
  </arg>
64
63
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="require_body_for_invalid_url: bool = False">
65
64
  <name>require_body_for_invalid_url</name>
@@ -71,9 +70,23 @@
71
70
  <type name="int" typedoc="integer"/>
72
71
  <default>1</default>
73
72
  </arg>
74
- <arg kind="POSITIONAL_OR_NAMED" required="false" repr="recursion_default: Any = {}">
73
+ <arg kind="POSITIONAL_OR_NAMED" required="false" repr="recursion_default: dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None = {}">
75
74
  <name>recursion_default</name>
76
- <type name="Any" typedoc="Any"/>
75
+ <type name="Union" union="true">
76
+ <type name="dict" typedoc="dictionary">
77
+ <type name="str" typedoc="string"/>
78
+ <type name="JSON"/>
79
+ </type>
80
+ <type name="list" typedoc="list">
81
+ <type name="JSON"/>
82
+ </type>
83
+ <type name="str" typedoc="string"/>
84
+ <type name="bytes" typedoc="bytes"/>
85
+ <type name="int" typedoc="integer"/>
86
+ <type name="float" typedoc="float"/>
87
+ <type name="bool" typedoc="boolean"/>
88
+ <type name="None" typedoc="None"/>
89
+ </type>
77
90
  <default>{}</default>
78
91
  </arg>
79
92
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="username: str = ">
@@ -99,42 +112,37 @@
99
112
  </type>
100
113
  <default>None</default>
101
114
  </arg>
102
- <arg kind="POSITIONAL_OR_NAMED" required="false" repr="cert: str | Tuple[str, str] | None = None">
115
+ <arg kind="POSITIONAL_OR_NAMED" required="false" repr="cert: str | tuple[str, str] = ">
103
116
  <name>cert</name>
104
117
  <type name="Union" union="true">
105
118
  <type name="str" typedoc="string"/>
106
- <type name="Tuple" typedoc="tuple">
119
+ <type name="tuple" typedoc="tuple">
107
120
  <type name="str" typedoc="string"/>
108
121
  <type name="str" typedoc="string"/>
109
122
  </type>
110
- <type name="None" typedoc="None"/>
111
123
  </type>
112
- <default>None</default>
124
+ <default/>
113
125
  </arg>
114
- <arg kind="POSITIONAL_OR_NAMED" required="false" repr="verify_tls: bool | str | None = True">
126
+ <arg kind="POSITIONAL_OR_NAMED" required="false" repr="verify_tls: bool | str = True">
115
127
  <name>verify_tls</name>
116
128
  <type name="Union" union="true">
117
129
  <type name="bool" typedoc="boolean"/>
118
130
  <type name="str" typedoc="string"/>
119
- <type name="None" typedoc="None"/>
120
131
  </type>
121
132
  <default>True</default>
122
133
  </arg>
123
- <arg kind="POSITIONAL_OR_NAMED" required="false" repr="extra_headers: Dict[str, str] | None = None">
134
+ <arg kind="POSITIONAL_OR_NAMED" required="false" repr="extra_headers: Mapping[str, str] = {}">
124
135
  <name>extra_headers</name>
125
- <type name="Union" union="true">
126
- <type name="Dict" typedoc="dictionary">
136
+ <type name="Mapping" typedoc="dictionary">
127
137
  <type name="str" typedoc="string"/>
128
138
  <type name="str" typedoc="string"/>
129
139
  </type>
130
- <type name="None" typedoc="None"/>
131
- </type>
132
- <default>None</default>
140
+ <default>{}</default>
133
141
  </arg>
134
- <arg kind="POSITIONAL_OR_NAMED" required="false" repr="cookies: Dict[str, str] | RequestsCookieJar | None = None">
142
+ <arg kind="POSITIONAL_OR_NAMED" required="false" repr="cookies: MutableMapping[str, str] | RequestsCookieJar | None = None">
135
143
  <name>cookies</name>
136
144
  <type name="Union" union="true">
137
- <type name="Dict" typedoc="dictionary">
145
+ <type name="MutableMapping" typedoc="dictionary">
138
146
  <type name="str" typedoc="string"/>
139
147
  <type name="str" typedoc="string"/>
140
148
  </type>
@@ -143,10 +151,10 @@
143
151
  </type>
144
152
  <default>None</default>
145
153
  </arg>
146
- <arg kind="POSITIONAL_OR_NAMED" required="false" repr="proxies: Dict[str, str] | None = None">
154
+ <arg kind="POSITIONAL_OR_NAMED" required="false" repr="proxies: MutableMapping[str, str] | None = None">
147
155
  <name>proxies</name>
148
156
  <type name="Union" union="true">
149
- <type name="Dict" typedoc="dictionary">
157
+ <type name="MutableMapping" typedoc="dictionary">
150
158
  <type name="str" typedoc="string"/>
151
159
  <type name="str" typedoc="string"/>
152
160
  </type>
@@ -161,7 +169,7 @@
161
169
  &lt;h4&gt;origin&lt;/h4&gt;
162
170
  &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;
163
171
  &lt;h4&gt;base_path&lt;/h4&gt;
164
- &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;
172
+ &lt;p&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;/p&gt;
165
173
  &lt;h3&gt;Test case execution&lt;/h3&gt;
166
174
  &lt;h4&gt;response_validation&lt;/h4&gt;
167
175
  &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;
@@ -214,8 +222,39 @@
214
222
  </init>
215
223
  </inits>
216
224
  <keywords>
217
- <kw name="Authorized Request" lineno="1731">
218
- <arguments repr="url: str, method: str, params: Dict[str, Any] | None = None, headers: Dict[str, str] | None = None, json_data: Dict[str, Dict[str, JSON] | List[JSON] | str | int | float | bool | None] | List[Dict[str, JSON] | List[JSON] | str | int | float | bool | None] | str | int | float | bool | None = None, data: Any = None, files: Any = None">
225
+ <kw name="Assert Href To Resource Is Valid" lineno="735">
226
+ <arguments repr="href: str, referenced_resource: dict[str, dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None]">
227
+ <arg kind="POSITIONAL_OR_NAMED" required="true" repr="href: str">
228
+ <name>href</name>
229
+ <type name="str" typedoc="string"/>
230
+ </arg>
231
+ <arg kind="POSITIONAL_OR_NAMED" required="true" repr="referenced_resource: dict[str, dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None]">
232
+ <name>referenced_resource</name>
233
+ <type name="dict" typedoc="dictionary">
234
+ <type name="str" typedoc="string"/>
235
+ <type name="Union" union="true">
236
+ <type name="dict" typedoc="dictionary">
237
+ <type name="str" typedoc="string"/>
238
+ <type name="JSON"/>
239
+ </type>
240
+ <type name="list" typedoc="list">
241
+ <type name="JSON"/>
242
+ </type>
243
+ <type name="str" typedoc="string"/>
244
+ <type name="bytes" typedoc="bytes"/>
245
+ <type name="int" typedoc="integer"/>
246
+ <type name="float" typedoc="float"/>
247
+ <type name="bool" typedoc="boolean"/>
248
+ <type name="None" typedoc="None"/>
249
+ </type>
250
+ </type>
251
+ </arg>
252
+ </arguments>
253
+ <doc>&lt;p&gt;Attempt to GET the resource referenced by the &lt;span class="name"&gt;href&lt;/span&gt; and validate it's equal to the provided &lt;span class="name"&gt;referenced_resource&lt;/span&gt; object / dictionary.&lt;/p&gt;</doc>
254
+ <shortdoc>Attempt to GET the resource referenced by the `href` and validate it's equal to the provided `referenced_resource` object / dictionary.</shortdoc>
255
+ </kw>
256
+ <kw name="Authorized Request" lineno="655">
257
+ <arguments repr="url: str, method: str, params: dict[str, Any] | None = None, headers: dict[str, str] | None = None, json_data: dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None = None, data: Any | None = None, files: Any | None = None">
219
258
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
220
259
  <name>url</name>
221
260
  <type name="str" typedoc="string"/>
@@ -224,10 +263,10 @@
224
263
  <name>method</name>
225
264
  <type name="str" typedoc="string"/>
226
265
  </arg>
227
- <arg kind="POSITIONAL_OR_NAMED" required="false" repr="params: Dict[str, Any] | None = None">
266
+ <arg kind="POSITIONAL_OR_NAMED" required="false" repr="params: dict[str, Any] | None = None">
228
267
  <name>params</name>
229
268
  <type name="Union" union="true">
230
- <type name="Dict" typedoc="dictionary">
269
+ <type name="dict" typedoc="dictionary">
231
270
  <type name="str" typedoc="string"/>
232
271
  <type name="Any" typedoc="Any"/>
233
272
  </type>
@@ -235,10 +274,10 @@
235
274
  </type>
236
275
  <default>None</default>
237
276
  </arg>
238
- <arg kind="POSITIONAL_OR_NAMED" required="false" repr="headers: Dict[str, str] | None = None">
277
+ <arg kind="POSITIONAL_OR_NAMED" required="false" repr="headers: dict[str, str] | None = None">
239
278
  <name>headers</name>
240
279
  <type name="Union" union="true">
241
- <type name="Dict" typedoc="dictionary">
280
+ <type name="dict" typedoc="dictionary">
242
281
  <type name="str" typedoc="string"/>
243
282
  <type name="str" typedoc="string"/>
244
283
  </type>
@@ -246,43 +285,18 @@
246
285
  </type>
247
286
  <default>None</default>
248
287
  </arg>
249
- <arg kind="POSITIONAL_OR_NAMED" required="false" repr="json_data: Dict[str, Dict[str, JSON] | List[JSON] | str | int | float | bool | None] | List[Dict[str, JSON] | List[JSON] | str | int | float | bool | None] | str | int | float | bool | None = None">
288
+ <arg kind="POSITIONAL_OR_NAMED" required="false" repr="json_data: dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None = None">
250
289
  <name>json_data</name>
251
290
  <type name="Union" union="true">
252
- <type name="Dict" typedoc="dictionary">
253
- <type name="str" typedoc="string"/>
254
- <type name="Union" union="true">
255
- <type name="Dict" typedoc="dictionary">
291
+ <type name="dict" typedoc="dictionary">
256
292
  <type name="str" typedoc="string"/>
257
293
  <type name="JSON"/>
258
294
  </type>
259
- <type name="List" typedoc="list">
295
+ <type name="list" typedoc="list">
260
296
  <type name="JSON"/>
261
297
  </type>
262
298
  <type name="str" typedoc="string"/>
263
- <type name="int" typedoc="integer"/>
264
- <type name="float" typedoc="float"/>
265
- <type name="bool" typedoc="boolean"/>
266
- <type name="None" typedoc="None"/>
267
- </type>
268
- </type>
269
- <type name="List" typedoc="list">
270
- <type name="Union" union="true">
271
- <type name="Dict" typedoc="dictionary">
272
- <type name="str" typedoc="string"/>
273
- <type name="JSON"/>
274
- </type>
275
- <type name="List" typedoc="list">
276
- <type name="JSON"/>
277
- </type>
278
- <type name="str" typedoc="string"/>
279
- <type name="int" typedoc="integer"/>
280
- <type name="float" typedoc="float"/>
281
- <type name="bool" typedoc="boolean"/>
282
- <type name="None" typedoc="None"/>
283
- </type>
284
- </type>
285
- <type name="str" typedoc="string"/>
299
+ <type name="bytes" typedoc="bytes"/>
286
300
  <type name="int" typedoc="integer"/>
287
301
  <type name="float" typedoc="float"/>
288
302
  <type name="bool" typedoc="boolean"/>
@@ -290,14 +304,20 @@
290
304
  </type>
291
305
  <default>None</default>
292
306
  </arg>
293
- <arg kind="POSITIONAL_OR_NAMED" required="false" repr="data: Any = None">
307
+ <arg kind="POSITIONAL_OR_NAMED" required="false" repr="data: Any | None = None">
294
308
  <name>data</name>
309
+ <type name="Union" union="true">
295
310
  <type name="Any" typedoc="Any"/>
311
+ <type name="None" typedoc="None"/>
312
+ </type>
296
313
  <default>None</default>
297
314
  </arg>
298
- <arg kind="POSITIONAL_OR_NAMED" required="false" repr="files: Any = None">
315
+ <arg kind="POSITIONAL_OR_NAMED" required="false" repr="files: Any | None = None">
299
316
  <name>files</name>
317
+ <type name="Union" union="true">
300
318
  <type name="Any" typedoc="Any"/>
319
+ <type name="None" typedoc="None"/>
320
+ </type>
301
321
  <default>None</default>
302
322
  </arg>
303
323
  </arguments>
@@ -307,7 +327,7 @@
307
327
  &lt;p&gt;&amp;gt; Note: provided username / password or auth objects take precedence over token based security&lt;/p&gt;</doc>
308
328
  <shortdoc>Perform a request using the security token or authentication set in the library.</shortdoc>
309
329
  </kw>
310
- <kw name="Ensure In Use" lineno="1635">
330
+ <kw name="Ensure In Use" lineno="640">
311
331
  <arguments repr="url: str, resource_relation: IdReference">
312
332
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
313
333
  <name>url</name>
@@ -321,20 +341,20 @@
321
341
  <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>
322
342
  <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>
323
343
  </kw>
324
- <kw name="Get Ids From Url" lineno="984">
344
+ <kw name="Get Ids From Url" lineno="605">
325
345
  <arguments repr="url: str">
326
346
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
327
347
  <name>url</name>
328
348
  <type name="str" typedoc="string"/>
329
349
  </arg>
330
350
  </arguments>
331
- <returntype name="List" typedoc="list">
351
+ <returntype name="list" typedoc="list">
332
352
  <type name="str" typedoc="string"/>
333
353
  </returntype>
334
354
  <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>
335
355
  <shortdoc>Perform a GET request on the `url` and return the list of resource `ids` from the response.</shortdoc>
336
356
  </kw>
337
- <kw name="Get Invalid Json Data" lineno="1409">
357
+ <kw name="Get Invalid Json Data" lineno="502">
338
358
  <arguments repr="url: str, method: str, status_code: int, request_data: RequestData">
339
359
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
340
360
  <name>url</name>
@@ -353,15 +373,29 @@
353
373
  <type name="RequestData"/>
354
374
  </arg>
355
375
  </arguments>
356
- <returntype name="Dict" typedoc="dictionary">
376
+ <returntype name="dict" typedoc="dictionary">
357
377
  <type name="str" typedoc="string"/>
358
- <type name="Any" typedoc="Any"/>
378
+ <type name="Union" union="true">
379
+ <type name="dict" typedoc="dictionary">
380
+ <type name="str" typedoc="string"/>
381
+ <type name="JSON"/>
382
+ </type>
383
+ <type name="list" typedoc="list">
384
+ <type name="JSON"/>
385
+ </type>
386
+ <type name="str" typedoc="string"/>
387
+ <type name="bytes" typedoc="bytes"/>
388
+ <type name="int" typedoc="integer"/>
389
+ <type name="float" typedoc="float"/>
390
+ <type name="bool" typedoc="boolean"/>
391
+ <type name="None" typedoc="None"/>
392
+ </type>
359
393
  </returntype>
360
394
  <doc>&lt;p&gt;Return &lt;span class="name"&gt;json_data&lt;/span&gt; based on the &lt;span class="name"&gt;dto&lt;/span&gt; on the &lt;span class="name"&gt;request_data&lt;/span&gt; that will cause the provided &lt;span class="name"&gt;status_code&lt;/span&gt; for the &lt;span class="name"&gt;method&lt;/span&gt; operation on the &lt;span class="name"&gt;url&lt;/span&gt;.&lt;/p&gt;
361
395
  &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>
362
396
  <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>
363
397
  </kw>
364
- <kw name="Get Invalidated Parameters" lineno="1460">
398
+ <kw name="Get Invalidated Parameters" lineno="525">
365
399
  <arguments repr="status_code: int, request_data: RequestData">
366
400
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="status_code: int">
367
401
  <name>status_code</name>
@@ -372,12 +406,26 @@
372
406
  <type name="RequestData"/>
373
407
  </arg>
374
408
  </arguments>
375
- <returntype name="Tuple" typedoc="tuple">
376
- <type name="Dict" typedoc="dictionary">
409
+ <returntype name="tuple" typedoc="tuple">
410
+ <type name="dict" typedoc="dictionary">
377
411
  <type name="str" typedoc="string"/>
378
- <type name="Any" typedoc="Any"/>
412
+ <type name="Union" union="true">
413
+ <type name="dict" typedoc="dictionary">
414
+ <type name="str" typedoc="string"/>
415
+ <type name="JSON"/>
416
+ </type>
417
+ <type name="list" typedoc="list">
418
+ <type name="JSON"/>
379
419
  </type>
380
- <type name="Dict" typedoc="dictionary">
420
+ <type name="str" typedoc="string"/>
421
+ <type name="bytes" typedoc="bytes"/>
422
+ <type name="int" typedoc="integer"/>
423
+ <type name="float" typedoc="float"/>
424
+ <type name="bool" typedoc="boolean"/>
425
+ <type name="None" typedoc="None"/>
426
+ </type>
427
+ </type>
428
+ <type name="dict" typedoc="dictionary">
381
429
  <type name="str" typedoc="string"/>
382
430
  <type name="str" typedoc="string"/>
383
431
  </type>
@@ -385,8 +433,8 @@
385
433
  <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>
386
434
  <shortdoc>Returns a version of `params, headers` as present on `request_data` that has been modified to cause the provided `status_code`.</shortdoc>
387
435
  </kw>
388
- <kw name="Get Invalidated Url" lineno="1356">
389
- <arguments repr="valid_url: str, path: str = , method: str = , expected_status_code: int = 404">
436
+ <kw name="Get Invalidated Url" lineno="615">
437
+ <arguments repr="valid_url: str, path: str = , expected_status_code: int = 404">
390
438
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="valid_url: str">
391
439
  <name>valid_url</name>
392
440
  <type name="str" typedoc="string"/>
@@ -396,41 +444,44 @@
396
444
  <type name="str" typedoc="string"/>
397
445
  <default/>
398
446
  </arg>
399
- <arg kind="POSITIONAL_OR_NAMED" required="false" repr="method: str = ">
400
- <name>method</name>
401
- <type name="str" typedoc="string"/>
402
- <default/>
403
- </arg>
404
447
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="expected_status_code: int = 404">
405
448
  <name>expected_status_code</name>
406
449
  <type name="int" typedoc="integer"/>
407
450
  <default>404</default>
408
451
  </arg>
409
452
  </arguments>
410
- <returntype name="Union" union="true">
411
- <type name="str" typedoc="string"/>
412
- <type name="None" typedoc="None"/>
413
- </returntype>
414
- <doc>&lt;p&gt;Return an url with all the path parameters in the &lt;span class="name"&gt;valid_url&lt;/span&gt; replaced by a random UUID if no PathPropertiesConstraint is mapped for the &lt;a href="#type-Path" class="name"&gt;path&lt;/a&gt;, &lt;span class="name"&gt;method&lt;/span&gt; and &lt;span class="name"&gt;expected_status_code&lt;/span&gt;. If a PathPropertiesConstraint is mapped, the &lt;span class="name"&gt;invalid_value&lt;/span&gt; is returned.&lt;/p&gt;
453
+ <returntype name="str" typedoc="string"/>
454
+ <doc>&lt;p&gt;Return an url with all the path parameters in the &lt;span class="name"&gt;valid_url&lt;/span&gt; replaced by a random UUID if no PathPropertiesConstraint is mapped for the &lt;span class="name"&gt;"get"&lt;/span&gt; operation on the mapped &lt;a href="#type-Path" class="name"&gt;path&lt;/a&gt; and &lt;span class="name"&gt;expected_status_code&lt;/span&gt;. If a PathPropertiesConstraint is mapped, the &lt;span class="name"&gt;invalid_value&lt;/span&gt; is returned.&lt;/p&gt;
415
455
  &lt;p&gt;Raises ValueError if the valid_url cannot be invalidated.&lt;/p&gt;</doc>
416
- <shortdoc>Return an url with all the path parameters in the `valid_url` replaced by a random UUID if no PathPropertiesConstraint is mapped for the `path`, `method` and `expected_status_code`. If a PathPropertiesConstraint is mapped, the `invalid_value` is returned.</shortdoc>
456
+ <shortdoc>Return an url with all the path parameters in the `valid_url` replaced by a random UUID if no PathPropertiesConstraint is mapped for the `"get"` operation on the mapped `path` and `expected_status_code`. If a PathPropertiesConstraint is mapped, the `invalid_value` is returned.</shortdoc>
417
457
  </kw>
418
- <kw name="Get Json Data For Dto Class" lineno="1232">
419
- <arguments repr="schema: Dict[str, Any], dto_class: Dto | Type[Dto], operation_id: str = ">
420
- <arg kind="POSITIONAL_OR_NAMED" required="true" repr="schema: Dict[str, Any]">
458
+ <kw name="Get Json Data For Dto Class" lineno="485">
459
+ <arguments repr="schema: dict[str, dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None], dto_class: type[Dto], operation_id: str = ">
460
+ <arg kind="POSITIONAL_OR_NAMED" required="true" repr="schema: dict[str, dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None]">
421
461
  <name>schema</name>
422
- <type name="Dict" typedoc="dictionary">
462
+ <type name="dict" typedoc="dictionary">
423
463
  <type name="str" typedoc="string"/>
424
- <type name="Any" typedoc="Any"/>
464
+ <type name="Union" union="true">
465
+ <type name="dict" typedoc="dictionary">
466
+ <type name="str" typedoc="string"/>
467
+ <type name="JSON"/>
468
+ </type>
469
+ <type name="list" typedoc="list">
470
+ <type name="JSON"/>
471
+ </type>
472
+ <type name="str" typedoc="string"/>
473
+ <type name="bytes" typedoc="bytes"/>
474
+ <type name="int" typedoc="integer"/>
475
+ <type name="float" typedoc="float"/>
476
+ <type name="bool" typedoc="boolean"/>
477
+ <type name="None" typedoc="None"/>
478
+ </type>
425
479
  </type>
426
480
  </arg>
427
- <arg kind="POSITIONAL_OR_NAMED" required="true" repr="dto_class: Dto | Type[Dto]">
481
+ <arg kind="POSITIONAL_OR_NAMED" required="true" repr="dto_class: type[Dto]">
428
482
  <name>dto_class</name>
429
- <type name="Union" union="true">
483
+ <type name="type">
430
484
  <type name="Dto"/>
431
- <type name="Type">
432
- <type name="Dto"/>
433
- </type>
434
485
  </type>
435
486
  </arg>
436
487
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="operation_id: str = ">
@@ -440,16 +491,24 @@
440
491
  </arg>
441
492
  </arguments>
442
493
  <returntype name="Union" union="true">
443
- <type name="Dict" typedoc="dictionary">
494
+ <type name="dict" typedoc="dictionary">
444
495
  <type name="str" typedoc="string"/>
445
- <type name="Any" typedoc="Any"/>
496
+ <type name="JSON"/>
497
+ </type>
498
+ <type name="list" typedoc="list">
499
+ <type name="JSON"/>
446
500
  </type>
501
+ <type name="str" typedoc="string"/>
502
+ <type name="bytes" typedoc="bytes"/>
503
+ <type name="int" typedoc="integer"/>
504
+ <type name="float" typedoc="float"/>
505
+ <type name="bool" typedoc="boolean"/>
447
506
  <type name="None" typedoc="None"/>
448
507
  </returntype>
449
- <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>
450
- <shortdoc>Generate a valid (json-compatible) dict for all the `dto_class` properties.</shortdoc>
508
+ <doc>&lt;p&gt;Generate valid (json-compatible) data for the &lt;span class="name"&gt;dto_class&lt;/span&gt;.&lt;/p&gt;</doc>
509
+ <shortdoc>Generate valid (json-compatible) data for the `dto_class`.</shortdoc>
451
510
  </kw>
452
- <kw name="Get Json Data With Conflict" lineno="1679">
511
+ <kw name="Get Json Data With Conflict" lineno="541">
453
512
  <arguments repr="url: str, method: str, dto: Dto, conflict_status_code: int">
454
513
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
455
514
  <name>url</name>
@@ -468,14 +527,28 @@
468
527
  <type name="int" typedoc="integer"/>
469
528
  </arg>
470
529
  </arguments>
471
- <returntype name="Dict" typedoc="dictionary">
530
+ <returntype name="dict" typedoc="dictionary">
472
531
  <type name="str" typedoc="string"/>
473
- <type name="Any" typedoc="Any"/>
532
+ <type name="Union" union="true">
533
+ <type name="dict" typedoc="dictionary">
534
+ <type name="str" typedoc="string"/>
535
+ <type name="JSON"/>
536
+ </type>
537
+ <type name="list" typedoc="list">
538
+ <type name="JSON"/>
539
+ </type>
540
+ <type name="str" typedoc="string"/>
541
+ <type name="bytes" typedoc="bytes"/>
542
+ <type name="int" typedoc="integer"/>
543
+ <type name="float" typedoc="float"/>
544
+ <type name="bool" typedoc="boolean"/>
545
+ <type name="None" typedoc="None"/>
546
+ </type>
474
547
  </returntype>
475
548
  <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>
476
549
  <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>
477
550
  </kw>
478
- <kw name="Get Parameterized Endpoint From Url" lineno="1397">
551
+ <kw name="Get Parameterized Path From Url" lineno="591">
479
552
  <arguments repr="url: str">
480
553
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
481
554
  <name>url</name>
@@ -483,13 +556,13 @@
483
556
  </arg>
484
557
  </arguments>
485
558
  <returntype name="str" typedoc="string"/>
486
- <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>
487
- <shortdoc>Return the endpoint as found in the `paths` section based on the given `url`.</shortdoc>
559
+ <doc>&lt;p&gt;Return the path 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>
560
+ <shortdoc>Return the path as found in the `paths` section based on the given `url`.</shortdoc>
488
561
  </kw>
489
- <kw name="Get Request Data" lineno="1024">
490
- <arguments repr="endpoint: str, method: str">
491
- <arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
492
- <name>endpoint</name>
562
+ <kw name="Get Request Data" lineno="474">
563
+ <arguments repr="path: str, method: str">
564
+ <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
565
+ <name>path</name>
493
566
  <type name="str" typedoc="string"/>
494
567
  </arg>
495
568
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
@@ -501,45 +574,60 @@
501
574
  <doc>&lt;p&gt;Return an object with valid request data for body, headers and query params.&lt;/p&gt;</doc>
502
575
  <shortdoc>Return an object with valid request data for body, headers and query params.</shortdoc>
503
576
  </kw>
504
- <kw name="Get Valid Id For Endpoint" lineno="888">
505
- <arguments repr="endpoint: str, method: str">
506
- <arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
507
- <name>endpoint</name>
577
+ <kw name="Get Request Values" lineno="433">
578
+ <arguments repr="path: str, method: str, overrides: Mapping[str, object] = {}">
579
+ <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
580
+ <name>path</name>
508
581
  <type name="str" typedoc="string"/>
509
582
  </arg>
510
583
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
511
584
  <name>method</name>
512
585
  <type name="str" typedoc="string"/>
513
586
  </arg>
587
+ <arg kind="POSITIONAL_OR_NAMED" required="false" repr="overrides: Mapping[str, object] = {}">
588
+ <name>overrides</name>
589
+ <type name="Mapping" typedoc="dictionary">
590
+ <type name="str" typedoc="string"/>
591
+ <type name="object"/>
592
+ </type>
593
+ <default>{}</default>
594
+ </arg>
595
+ </arguments>
596
+ <returntype name="RequestValues"/>
597
+ <doc>&lt;p&gt;Return an object with all (valid) request values needed to make a request.&lt;/p&gt;</doc>
598
+ <shortdoc>Return an object with all (valid) request values needed to make a request.</shortdoc>
599
+ </kw>
600
+ <kw name="Get Valid Id For Path" lineno="579">
601
+ <arguments repr="path: str">
602
+ <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
603
+ <name>path</name>
604
+ <type name="str" typedoc="string"/>
605
+ </arg>
514
606
  </arguments>
515
607
  <returntype name="Union" union="true">
516
608
  <type name="str" typedoc="string"/>
517
609
  <type name="int" typedoc="integer"/>
518
610
  <type name="float" typedoc="float"/>
519
611
  </returntype>
520
- <doc>&lt;p&gt;Support keyword that returns the &lt;span class="name"&gt;id&lt;/span&gt; for an existing resource at &lt;span class="name"&gt;endpoint&lt;/span&gt;.&lt;/p&gt;
521
- &lt;p&gt;To prevent resource conflicts with other test cases, a new resource is created (POST) if possible.&lt;/p&gt;</doc>
522
- <shortdoc>Support keyword that returns the `id` for an existing resource at `endpoint`.</shortdoc>
612
+ <doc>&lt;p&gt;Support keyword that returns the &lt;span class="name"&gt;id&lt;/span&gt; for an existing resource at &lt;a href="#type-Path" class="name"&gt;path&lt;/a&gt;.&lt;/p&gt;
613
+ &lt;p&gt;To prevent resource conflicts with other test cases, a new resource is created (by a POST operation) if possible.&lt;/p&gt;</doc>
614
+ <shortdoc>Support keyword that returns the `id` for an existing resource at `path`.</shortdoc>
523
615
  </kw>
524
- <kw name="Get Valid Url" lineno="848">
525
- <arguments repr="endpoint: str, method: str">
526
- <arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
527
- <name>endpoint</name>
528
- <type name="str" typedoc="string"/>
529
- </arg>
530
- <arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
531
- <name>method</name>
616
+ <kw name="Get Valid Url" lineno="560">
617
+ <arguments repr="path: str">
618
+ <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
619
+ <name>path</name>
532
620
  <type name="str" typedoc="string"/>
533
621
  </arg>
534
622
  </arguments>
535
623
  <returntype name="str" typedoc="string"/>
536
- <doc>&lt;p&gt;This keyword returns a valid url for the given &lt;span class="name"&gt;endpoint&lt;/span&gt; and &lt;span class="name"&gt;method&lt;/span&gt;.&lt;/p&gt;
537
- &lt;p&gt;If the &lt;span class="name"&gt;endpoint&lt;/span&gt; contains path parameters the Get Valid Id For Endpoint keyword will be executed to retrieve valid ids for the path parameters.&lt;/p&gt;
538
- &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>
539
- <shortdoc>This keyword returns a valid url for the given `endpoint` and `method`.</shortdoc>
624
+ <doc>&lt;p&gt;This keyword returns a valid url for the given &lt;a href="#type-Path" class="name"&gt;path&lt;/a&gt;.&lt;/p&gt;
625
+ &lt;p&gt;If the &lt;a href="#type-Path" class="name"&gt;path&lt;/a&gt; contains path parameters the Get Valid Id For Path keyword will be executed to retrieve valid ids for the path parameters.&lt;/p&gt;
626
+ &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-openapitools/advanced_use.html"&gt;here&lt;/a&gt;.&lt;/p&gt;</doc>
627
+ <shortdoc>This keyword returns a valid url for the given `path`.</shortdoc>
540
628
  </kw>
541
- <kw name="Perform Validated Request" lineno="1778">
542
- <arguments repr="path: str, status_code: int, request_values: RequestValues, original_data: Dict[str, Any] | None = None">
629
+ <kw name="Perform Validated Request" lineno="704">
630
+ <arguments repr="path: str, status_code: int, request_values: RequestValues, original_data: Mapping[str, object] = {}">
543
631
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
544
632
  <name>path</name>
545
633
  <type name="str" typedoc="string"/>
@@ -552,22 +640,19 @@
552
640
  <name>request_values</name>
553
641
  <type name="RequestValues"/>
554
642
  </arg>
555
- <arg kind="POSITIONAL_OR_NAMED" required="false" repr="original_data: Dict[str, Any] | None = None">
643
+ <arg kind="POSITIONAL_OR_NAMED" required="false" repr="original_data: Mapping[str, object] = {}">
556
644
  <name>original_data</name>
557
- <type name="Union" union="true">
558
- <type name="Dict" typedoc="dictionary">
645
+ <type name="Mapping" typedoc="dictionary">
559
646
  <type name="str" typedoc="string"/>
560
- <type name="Any" typedoc="Any"/>
647
+ <type name="object"/>
561
648
  </type>
562
- <type name="None" typedoc="None"/>
563
- </type>
564
- <default>None</default>
649
+ <default>{}</default>
565
650
  </arg>
566
651
  </arguments>
567
652
  <doc>&lt;p&gt;This keyword first calls the Authorized Request keyword, then the Validate Response keyword and finally validates, for &lt;span class="name"&gt;DELETE&lt;/span&gt; operations, whether the target resource was indeed deleted (OK response) or not (error responses).&lt;/p&gt;</doc>
568
653
  <shortdoc>This keyword first calls the Authorized Request keyword, then the Validate Response keyword and finally validates, for `DELETE` operations, whether the target resource was indeed deleted (OK response) or not (error responses).</shortdoc>
569
654
  </kw>
570
- <kw name="Set Auth" lineno="703">
655
+ <kw name="Set Auth" lineno="411">
571
656
  <arguments repr="auth: AuthBase">
572
657
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="auth: AuthBase">
573
658
  <name>auth</name>
@@ -578,7 +663,7 @@
578
663
  &lt;p&gt;After calling this keyword, subsequent requests will use the provided &lt;span class="name"&gt;auth&lt;/span&gt; instance.&lt;/p&gt;</doc>
579
664
  <shortdoc>Set the `auth` used for authentication after the library is imported.</shortdoc>
580
665
  </kw>
581
- <kw name="Set Basic Auth" lineno="691">
666
+ <kw name="Set Basic Auth" lineno="399">
582
667
  <arguments repr="username: str, password: str">
583
668
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="username: str">
584
669
  <name>username</name>
@@ -593,11 +678,11 @@
593
678
  &lt;p&gt;After calling this keyword, subsequent requests will use the provided credentials.&lt;/p&gt;</doc>
594
679
  <shortdoc>Set the `username` and `password` used for basic authentication after the library is imported.</shortdoc>
595
680
  </kw>
596
- <kw name="Set Extra Headers" lineno="713">
597
- <arguments repr="extra_headers: Dict[str, str]">
598
- <arg kind="POSITIONAL_OR_NAMED" required="true" repr="extra_headers: Dict[str, str]">
681
+ <kw name="Set Extra Headers" lineno="421">
682
+ <arguments repr="extra_headers: dict[str, str]">
683
+ <arg kind="POSITIONAL_OR_NAMED" required="true" repr="extra_headers: dict[str, str]">
599
684
  <name>extra_headers</name>
600
- <type name="Dict" typedoc="dictionary">
685
+ <type name="dict" typedoc="dictionary">
601
686
  <type name="str" typedoc="string"/>
602
687
  <type name="str" typedoc="string"/>
603
688
  </type>
@@ -607,7 +692,7 @@
607
692
  &lt;p&gt;After calling this keyword, subsequent requests will use the provided &lt;span class="name"&gt;extra_headers&lt;/span&gt;.&lt;/p&gt;</doc>
608
693
  <shortdoc>Set the `extra_headers` used in requests after the library is imported.</shortdoc>
609
694
  </kw>
610
- <kw name="Set Origin" lineno="668">
695
+ <kw name="Set Origin" lineno="376">
611
696
  <arguments repr="origin: str">
612
697
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="origin: str">
613
698
  <name>origin</name>
@@ -619,7 +704,7 @@
619
704
  &lt;p&gt;In combination with OpenApiLibCore, the &lt;span class="name"&gt;origin&lt;/span&gt; can be used at any point to target another server that hosts an API that complies to the same OAS.&lt;/p&gt;</doc>
620
705
  <shortdoc>Set the `origin` after the library is imported.</shortdoc>
621
706
  </kw>
622
- <kw name="Set Security Token" lineno="682">
707
+ <kw name="Set Security Token" lineno="390">
623
708
  <arguments repr="security_token: str">
624
709
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="security_token: str">
625
710
  <name>security_token</name>
@@ -630,28 +715,56 @@
630
715
  &lt;p&gt;After calling this keyword, subsequent requests will use the provided token.&lt;/p&gt;</doc>
631
716
  <shortdoc>Set the `security_token` after the library is imported.</shortdoc>
632
717
  </kw>
633
- <kw name="Validate Resource Properties" lineno="2019">
634
- <arguments repr="resource: Dict[str, Any], schema: Dict[str, Any]">
635
- <arg kind="POSITIONAL_OR_NAMED" required="true" repr="resource: Dict[str, Any]">
718
+ <kw name="Validate Resource Properties" lineno="779">
719
+ <arguments repr="resource: dict[str, dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None], schema: dict[str, dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None]">
720
+ <arg kind="POSITIONAL_OR_NAMED" required="true" repr="resource: dict[str, dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None]">
636
721
  <name>resource</name>
637
- <type name="Dict" typedoc="dictionary">
722
+ <type name="dict" typedoc="dictionary">
638
723
  <type name="str" typedoc="string"/>
639
- <type name="Any" typedoc="Any"/>
724
+ <type name="Union" union="true">
725
+ <type name="dict" typedoc="dictionary">
726
+ <type name="str" typedoc="string"/>
727
+ <type name="JSON"/>
728
+ </type>
729
+ <type name="list" typedoc="list">
730
+ <type name="JSON"/>
731
+ </type>
732
+ <type name="str" typedoc="string"/>
733
+ <type name="bytes" typedoc="bytes"/>
734
+ <type name="int" typedoc="integer"/>
735
+ <type name="float" typedoc="float"/>
736
+ <type name="bool" typedoc="boolean"/>
737
+ <type name="None" typedoc="None"/>
738
+ </type>
640
739
  </type>
641
740
  </arg>
642
- <arg kind="POSITIONAL_OR_NAMED" required="true" repr="schema: Dict[str, Any]">
741
+ <arg kind="POSITIONAL_OR_NAMED" required="true" repr="schema: dict[str, dict[str, JSON] | list[JSON] | str | bytes | int | float | bool | None]">
643
742
  <name>schema</name>
644
- <type name="Dict" typedoc="dictionary">
743
+ <type name="dict" typedoc="dictionary">
645
744
  <type name="str" typedoc="string"/>
646
- <type name="Any" typedoc="Any"/>
745
+ <type name="Union" union="true">
746
+ <type name="dict" typedoc="dictionary">
747
+ <type name="str" typedoc="string"/>
748
+ <type name="JSON"/>
749
+ </type>
750
+ <type name="list" typedoc="list">
751
+ <type name="JSON"/>
752
+ </type>
753
+ <type name="str" typedoc="string"/>
754
+ <type name="bytes" typedoc="bytes"/>
755
+ <type name="int" typedoc="integer"/>
756
+ <type name="float" typedoc="float"/>
757
+ <type name="bool" typedoc="boolean"/>
758
+ <type name="None" typedoc="None"/>
759
+ </type>
647
760
  </type>
648
761
  </arg>
649
762
  </arguments>
650
763
  <doc>&lt;p&gt;Validate that the &lt;span class="name"&gt;resource&lt;/span&gt; does not contain any properties that are not defined in the &lt;span class="name"&gt;schema_properties&lt;/span&gt;.&lt;/p&gt;</doc>
651
764
  <shortdoc>Validate that the `resource` does not contain any properties that are not defined in the `schema_properties`.</shortdoc>
652
765
  </kw>
653
- <kw name="Validate Response" lineno="1852">
654
- <arguments repr="path: str, response: Response, original_data: Dict[str, Any] | None = None">
766
+ <kw name="Validate Response" lineno="750">
767
+ <arguments repr="path: str, response: Response, original_data: Mapping[str, object] = {}">
655
768
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
656
769
  <name>path</name>
657
770
  <type name="str" typedoc="string"/>
@@ -660,45 +773,49 @@
660
773
  <name>response</name>
661
774
  <type name="Response"/>
662
775
  </arg>
663
- <arg kind="POSITIONAL_OR_NAMED" required="false" repr="original_data: Dict[str, Any] | None = None">
776
+ <arg kind="POSITIONAL_OR_NAMED" required="false" repr="original_data: Mapping[str, object] = {}">
664
777
  <name>original_data</name>
665
- <type name="Union" union="true">
666
- <type name="Dict" typedoc="dictionary">
778
+ <type name="Mapping" typedoc="dictionary">
667
779
  <type name="str" typedoc="string"/>
668
- <type name="Any" typedoc="Any"/>
669
- </type>
670
- <type name="None" typedoc="None"/>
780
+ <type name="object"/>
671
781
  </type>
672
- <default>None</default>
782
+ <default>{}</default>
673
783
  </arg>
674
784
  </arguments>
675
785
  <doc>&lt;p&gt;Validate the &lt;span class="name"&gt;response&lt;/span&gt; by performing the following validations:&lt;/p&gt;
676
786
  &lt;ul&gt;
677
- &lt;li&gt;validate the &lt;span class="name"&gt;response&lt;/span&gt; against the openapi schema for the &lt;span class="name"&gt;endpoint&lt;/span&gt;&lt;/li&gt;
787
+ &lt;li&gt;validate the &lt;span class="name"&gt;response&lt;/span&gt; against the openapi schema for the &lt;a href="#type-Path" class="name"&gt;path&lt;/a&gt;&lt;/li&gt;
678
788
  &lt;li&gt;validate that the response does not contain extra properties&lt;/li&gt;
679
789
  &lt;li&gt;validate that a href, if present, refers to the correct resource&lt;/li&gt;
680
790
  &lt;li&gt;validate that the value for a property that is in the response is equal to the property value that was send&lt;/li&gt;
681
791
  &lt;li&gt;validate that no &lt;span class="name"&gt;original_data&lt;/span&gt; is preserved when performing a PUT operation&lt;/li&gt;
682
792
  &lt;li&gt;validate that a PATCH operation only updates the provided properties&lt;/li&gt;
683
793
  &lt;/ul&gt;</doc>
684
- <shortdoc>Validate the `response` by performing the following validations: - validate the `response` against the openapi schema for the `endpoint` - validate that the response does not contain extra properties - validate that a href, if present, refers to the correct resource - validate that the value for a property that is in the response is equal to the property value that was send - validate that no `original_data` is preserved when performing a PUT operation - validate that a PATCH operation only updates the provided properties</shortdoc>
794
+ <shortdoc>Validate the `response` by performing the following validations: - validate the `response` against the openapi schema for the `path` - validate that the response does not contain extra properties - validate that a href, if present, refers to the correct resource - validate that the value for a property that is in the response is equal to the property value that was send - validate that no `original_data` is preserved when performing a PUT operation - validate that a PATCH operation only updates the provided properties</shortdoc>
685
795
  </kw>
686
- <kw name="Validate Send Response" lineno="2137">
687
- <arguments repr="response: Response, original_data: Dict[str, Any] | None = None">
796
+ <kw name="Validate Response Using Validator" lineno="724">
797
+ <arguments repr="response: Response">
688
798
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="response: Response">
689
799
  <name>response</name>
690
800
  <type name="Response"/>
691
801
  </arg>
692
- <arg kind="POSITIONAL_OR_NAMED" required="false" repr="original_data: Dict[str, Any] | None = None">
802
+ </arguments>
803
+ <doc>&lt;p&gt;Validate the &lt;span class="name"&gt;response&lt;/span&gt; against the OpenAPI Spec that is loaded during library initialization.&lt;/p&gt;</doc>
804
+ <shortdoc>Validate the `response` against the OpenAPI Spec that is loaded during library initialization.</shortdoc>
805
+ </kw>
806
+ <kw name="Validate Send Response" lineno="793">
807
+ <arguments repr="response: Response, original_data: Mapping[str, object] = {}">
808
+ <arg kind="POSITIONAL_OR_NAMED" required="true" repr="response: Response">
809
+ <name>response</name>
810
+ <type name="Response"/>
811
+ </arg>
812
+ <arg kind="POSITIONAL_OR_NAMED" required="false" repr="original_data: Mapping[str, object] = {}">
693
813
  <name>original_data</name>
694
- <type name="Union" union="true">
695
- <type name="Dict" typedoc="dictionary">
814
+ <type name="Mapping" typedoc="dictionary">
696
815
  <type name="str" typedoc="string"/>
697
- <type name="Any" typedoc="Any"/>
816
+ <type name="object"/>
698
817
  </type>
699
- <type name="None" typedoc="None"/>
700
- </type>
701
- <default>None</default>
818
+ <default>{}</default>
702
819
  </arg>
703
820
  </arguments>
704
821
  <doc>&lt;p&gt;Validate that each property that was send that is in the response has the value that was send. In case a PATCH request, validate that only the properties that were patched have changed and that other properties are still at their pre-patch values.&lt;/p&gt;</doc>
@@ -712,16 +829,7 @@
712
829
  <type>Any</type>
713
830
  </accepts>
714
831
  <usages>
715
- <usage>__init__</usage>
716
832
  <usage>Authorized Request</usage>
717
- <usage>Get Invalid Json Data</usage>
718
- <usage>Get Invalidated Parameters</usage>
719
- <usage>Get Json Data For Dto Class</usage>
720
- <usage>Get Json Data With Conflict</usage>
721
- <usage>Perform Validated Request</usage>
722
- <usage>Validate Resource Properties</usage>
723
- <usage>Validate Response</usage>
724
- <usage>Validate Send Response</usage>
725
833
  </usages>
726
834
  </type>
727
835
  <type name="boolean" type="Standard">
@@ -735,7 +843,31 @@
735
843
  </accepts>
736
844
  <usages>
737
845
  <usage>__init__</usage>
846
+ <usage>Assert Href To Resource Is Valid</usage>
738
847
  <usage>Authorized Request</usage>
848
+ <usage>Get Invalid Json Data</usage>
849
+ <usage>Get Invalidated Parameters</usage>
850
+ <usage>Get Json Data For Dto Class</usage>
851
+ <usage>Get Json Data With Conflict</usage>
852
+ <usage>Validate Resource Properties</usage>
853
+ </usages>
854
+ </type>
855
+ <type name="bytes" type="Standard">
856
+ <doc>&lt;p&gt;Strings are converted to bytes so that each Unicode code point below 256 is directly mapped to a matching byte. Higher code points are not allowed. Robot Framework's &lt;code&gt;\xHH&lt;/code&gt; escape syntax is convenient with bytes having non-printable values.&lt;/p&gt;
857
+ &lt;p&gt;Examples: &lt;code&gt;good&lt;/code&gt;, &lt;code&gt;hyvä&lt;/code&gt; (same as &lt;code&gt;hyv\xE4&lt;/code&gt;), &lt;code&gt;\x00&lt;/code&gt; (the null byte)&lt;/p&gt;</doc>
858
+ <accepts>
859
+ <type>string</type>
860
+ <type>bytearray</type>
861
+ </accepts>
862
+ <usages>
863
+ <usage>__init__</usage>
864
+ <usage>Assert Href To Resource Is Valid</usage>
865
+ <usage>Authorized Request</usage>
866
+ <usage>Get Invalid Json Data</usage>
867
+ <usage>Get Invalidated Parameters</usage>
868
+ <usage>Get Json Data For Dto Class</usage>
869
+ <usage>Get Json Data With Conflict</usage>
870
+ <usage>Validate Resource Properties</usage>
739
871
  </usages>
740
872
  </type>
741
873
  <type name="dictionary" type="Standard">
@@ -748,11 +880,13 @@
748
880
  </accepts>
749
881
  <usages>
750
882
  <usage>__init__</usage>
883
+ <usage>Assert Href To Resource Is Valid</usage>
751
884
  <usage>Authorized Request</usage>
752
885
  <usage>Get Invalid Json Data</usage>
753
886
  <usage>Get Invalidated Parameters</usage>
754
887
  <usage>Get Json Data For Dto Class</usage>
755
888
  <usage>Get Json Data With Conflict</usage>
889
+ <usage>Get Request Values</usage>
756
890
  <usage>Perform Validated Request</usage>
757
891
  <usage>Set Extra Headers</usage>
758
892
  <usage>Validate Resource Properties</usage>
@@ -769,8 +903,15 @@
769
903
  <type>Real</type>
770
904
  </accepts>
771
905
  <usages>
906
+ <usage>__init__</usage>
907
+ <usage>Assert Href To Resource Is Valid</usage>
772
908
  <usage>Authorized Request</usage>
773
- <usage>Get Valid Id For Endpoint</usage>
909
+ <usage>Get Invalid Json Data</usage>
910
+ <usage>Get Invalidated Parameters</usage>
911
+ <usage>Get Json Data For Dto Class</usage>
912
+ <usage>Get Json Data With Conflict</usage>
913
+ <usage>Get Valid Id For Path</usage>
914
+ <usage>Validate Resource Properties</usage>
774
915
  </usages>
775
916
  </type>
776
917
  <type name="integer" type="Standard">
@@ -784,13 +925,16 @@
784
925
  </accepts>
785
926
  <usages>
786
927
  <usage>__init__</usage>
928
+ <usage>Assert Href To Resource Is Valid</usage>
787
929
  <usage>Authorized Request</usage>
788
930
  <usage>Get Invalid Json Data</usage>
789
931
  <usage>Get Invalidated Parameters</usage>
790
932
  <usage>Get Invalidated Url</usage>
933
+ <usage>Get Json Data For Dto Class</usage>
791
934
  <usage>Get Json Data With Conflict</usage>
792
- <usage>Get Valid Id For Endpoint</usage>
935
+ <usage>Get Valid Id For Path</usage>
793
936
  <usage>Perform Validated Request</usage>
937
+ <usage>Validate Resource Properties</usage>
794
938
  </usages>
795
939
  </type>
796
940
  <type name="list" type="Standard">
@@ -803,8 +947,14 @@
803
947
  </accepts>
804
948
  <usages>
805
949
  <usage>__init__</usage>
950
+ <usage>Assert Href To Resource Is Valid</usage>
806
951
  <usage>Authorized Request</usage>
807
952
  <usage>Get Ids From Url</usage>
953
+ <usage>Get Invalid Json Data</usage>
954
+ <usage>Get Invalidated Parameters</usage>
955
+ <usage>Get Json Data For Dto Class</usage>
956
+ <usage>Get Json Data With Conflict</usage>
957
+ <usage>Validate Resource Properties</usage>
808
958
  </usages>
809
959
  </type>
810
960
  <type name="None" type="Standard">
@@ -814,12 +964,13 @@
814
964
  </accepts>
815
965
  <usages>
816
966
  <usage>__init__</usage>
967
+ <usage>Assert Href To Resource Is Valid</usage>
817
968
  <usage>Authorized Request</usage>
818
- <usage>Get Invalidated Url</usage>
969
+ <usage>Get Invalid Json Data</usage>
970
+ <usage>Get Invalidated Parameters</usage>
819
971
  <usage>Get Json Data For Dto Class</usage>
820
- <usage>Perform Validated Request</usage>
821
- <usage>Validate Response</usage>
822
- <usage>Validate Send Response</usage>
972
+ <usage>Get Json Data With Conflict</usage>
973
+ <usage>Validate Resource Properties</usage>
823
974
  </usages>
824
975
  </type>
825
976
  <type name="Path" type="Standard">
@@ -840,6 +991,7 @@
840
991
  </accepts>
841
992
  <usages>
842
993
  <usage>__init__</usage>
994
+ <usage>Assert Href To Resource Is Valid</usage>
843
995
  <usage>Authorized Request</usage>
844
996
  <usage>Ensure In Use</usage>
845
997
  <usage>Get Ids From Url</usage>
@@ -848,9 +1000,10 @@
848
1000
  <usage>Get Invalidated Url</usage>
849
1001
  <usage>Get Json Data For Dto Class</usage>
850
1002
  <usage>Get Json Data With Conflict</usage>
851
- <usage>Get Parameterized Endpoint From Url</usage>
1003
+ <usage>Get Parameterized Path From Url</usage>
852
1004
  <usage>Get Request Data</usage>
853
- <usage>Get Valid Id For Endpoint</usage>
1005
+ <usage>Get Request Values</usage>
1006
+ <usage>Get Valid Id For Path</usage>
854
1007
  <usage>Get Valid Url</usage>
855
1008
  <usage>Perform Validated Request</usage>
856
1009
  <usage>Set Basic Auth</usage>