robotframework-openapitools 0.2.2__py3-none-any.whl → 0.2.3__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 (8) hide show
  1. OpenApiDriver/openapi_executors.py +0 -0
  2. OpenApiDriver/openapidriver.libspec +103 -50
  3. OpenApiLibCore/openapi_libcore.libspec +242 -65
  4. OpenApiLibCore/openapi_libcore.py +0 -0
  5. {robotframework_openapitools-0.2.2.dist-info → robotframework_openapitools-0.2.3.dist-info}/METADATA +1 -1
  6. {robotframework_openapitools-0.2.2.dist-info → robotframework_openapitools-0.2.3.dist-info}/RECORD +6 -6
  7. {robotframework_openapitools-0.2.2.dist-info → robotframework_openapitools-0.2.3.dist-info}/LICENSE +0 -0
  8. {robotframework_openapitools-0.2.2.dist-info → robotframework_openapitools-0.2.3.dist-info}/WHEEL +0 -0
OpenApiDriver/openapi_executors.py CHANGED
File without changes
OpenApiDriver/openapidriver.libspec CHANGED
@@ -1,6 +1,6 @@
1
1
  <?xml version="1.0" encoding="UTF-8"?>
2
- <keywordspec name="OpenApiDriver" type="LIBRARY" format="HTML" scope="SUITE" generated="2024-05-15T18:47:16+00:00" specversion="5" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapidriver.py" lineno="352">
3
- <version>0.2.2</version>
2
+ <keywordspec name="OpenApiDriver" type="LIBRARY" format="HTML" scope="SUITE" generated="2024-06-20T15:30:31+00:00" specversion="6" source="/workspaces/robotframework-openapitools/src/OpenApiDriver/openapidriver.py" lineno="352">
3
+ <version>0.2.3</version>
4
4
  <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>
5
5
  <tags>
6
6
  </tags>
@@ -9,126 +9,192 @@
9
9
  <arguments repr="source: str, origin: str = , base_path: str = , included_paths: Iterable[str] | None = None, ignored_paths: Iterable[str] | None = None, ignored_responses: Iterable[int] | None = None, ignored_testcases: Iterable[Tuple[str, str, int]] | None = None, 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">
10
10
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="source: str">
11
11
  <name>source</name>
12
- <type name="str" typedoc="string">str</type>
12
+ <type name="str" typedoc="string"/>
13
13
  </arg>
14
14
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="origin: str = ">
15
15
  <name>origin</name>
16
- <type name="str" typedoc="string">str</type>
16
+ <type name="str" typedoc="string"/>
17
17
  <default/>
18
18
  </arg>
19
19
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="base_path: str = ">
20
20
  <name>base_path</name>
21
- <type name="str" typedoc="string">str</type>
21
+ <type name="str" typedoc="string"/>
22
22
  <default/>
23
23
  </arg>
24
24
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="included_paths: Iterable[str] | None = None">
25
25
  <name>included_paths</name>
26
- <type name="Union" union="true">Iterable[str] | None<type name="Iterable">Iterable[str]<type name="str" typedoc="string">str</type></type><type name="None" typedoc="None">None</type></type>
26
+ <type name="Union" union="true">
27
+ <type name="Iterable">
28
+ <type name="str" typedoc="string"/>
29
+ </type>
30
+ <type name="None" typedoc="None"/>
31
+ </type>
27
32
  <default>None</default>
28
33
  </arg>
29
34
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="ignored_paths: Iterable[str] | None = None">
30
35
  <name>ignored_paths</name>
31
- <type name="Union" union="true">Iterable[str] | None<type name="Iterable">Iterable[str]<type name="str" typedoc="string">str</type></type><type name="None" typedoc="None">None</type></type>
36
+ <type name="Union" union="true">
37
+ <type name="Iterable">
38
+ <type name="str" typedoc="string"/>
39
+ </type>
40
+ <type name="None" typedoc="None"/>
41
+ </type>
32
42
  <default>None</default>
33
43
  </arg>
34
44
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="ignored_responses: Iterable[int] | None = None">
35
45
  <name>ignored_responses</name>
36
- <type name="Union" union="true">Iterable[int] | None<type name="Iterable">Iterable[int]<type name="int" typedoc="integer">int</type></type><type name="None" typedoc="None">None</type></type>
46
+ <type name="Union" union="true">
47
+ <type name="Iterable">
48
+ <type name="int" typedoc="integer"/>
49
+ </type>
50
+ <type name="None" typedoc="None"/>
51
+ </type>
37
52
  <default>None</default>
38
53
  </arg>
39
54
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="ignored_testcases: Iterable[Tuple[str, str, int]] | None = None">
40
55
  <name>ignored_testcases</name>
41
- <type name="Union" union="true">Iterable[Tuple[str, str, int]] | None<type name="Iterable">Iterable[Tuple[str, str, int]]<type name="Tuple" typedoc="tuple">Tuple[str, str, int]<type name="str" typedoc="string">str</type><type name="str" typedoc="string">str</type><type name="int" typedoc="integer">int</type></type></type><type name="None" typedoc="None">None</type></type>
56
+ <type name="Union" union="true">
57
+ <type name="Iterable">
58
+ <type name="Tuple" typedoc="tuple">
59
+ <type name="str" typedoc="string"/>
60
+ <type name="str" typedoc="string"/>
61
+ <type name="int" typedoc="integer"/>
62
+ </type>
63
+ </type>
64
+ <type name="None" typedoc="None"/>
65
+ </type>
42
66
  <default>None</default>
43
67
  </arg>
44
68
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="response_validation: ValidationLevel = WARN">
45
69
  <name>response_validation</name>
46
- <type name="ValidationLevel" typedoc="ValidationLevel">ValidationLevel</type>
70
+ <type name="ValidationLevel" typedoc="ValidationLevel"/>
47
71
  <default>WARN</default>
48
72
  </arg>
49
73
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="disable_server_validation: bool = True">
50
74
  <name>disable_server_validation</name>
51
- <type name="bool" typedoc="boolean">bool</type>
75
+ <type name="bool" typedoc="boolean"/>
52
76
  <default>True</default>
53
77
  </arg>
54
78
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="mappings_path: str | Path = ">
55
79
  <name>mappings_path</name>
56
- <type name="Union" union="true">str | Path<type name="str" typedoc="string">str</type><type name="Path" typedoc="Path">Path</type></type>
80
+ <type name="Union" union="true">
81
+ <type name="str" typedoc="string"/>
82
+ <type name="Path" typedoc="Path"/>
83
+ </type>
57
84
  <default/>
58
85
  </arg>
59
86
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="invalid_property_default_response: int = 422">
60
87
  <name>invalid_property_default_response</name>
61
- <type name="int" typedoc="integer">int</type>
88
+ <type name="int" typedoc="integer"/>
62
89
  <default>422</default>
63
90
  </arg>
64
91
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="default_id_property_name: str = id">
65
92
  <name>default_id_property_name</name>
66
- <type name="str" typedoc="string">str</type>
93
+ <type name="str" typedoc="string"/>
67
94
  <default>id</default>
68
95
  </arg>
69
96
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="faker_locale: str | List[str] | None = None">
70
97
  <name>faker_locale</name>
71
- <type name="Union" union="true">str | List[str] | None<type name="str" typedoc="string">str</type><type name="List" typedoc="list">List[str]<type name="str" typedoc="string">str</type></type><type name="None" typedoc="None">None</type></type>
98
+ <type name="Union" union="true">
99
+ <type name="str" typedoc="string"/>
100
+ <type name="List" typedoc="list">
101
+ <type name="str" typedoc="string"/>
102
+ </type>
103
+ <type name="None" typedoc="None"/>
104
+ </type>
72
105
  <default>None</default>
73
106
  </arg>
74
107
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="require_body_for_invalid_url: bool = False">
75
108
  <name>require_body_for_invalid_url</name>
76
- <type name="bool" typedoc="boolean">bool</type>
109
+ <type name="bool" typedoc="boolean"/>
77
110
  <default>False</default>
78
111
  </arg>
79
112
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="recursion_limit: int = 1">
80
113
  <name>recursion_limit</name>
81
- <type name="int" typedoc="integer">int</type>
114
+ <type name="int" typedoc="integer"/>
82
115
  <default>1</default>
83
116
  </arg>
84
117
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="recursion_default: Any = {}">
85
118
  <name>recursion_default</name>
86
- <type name="Any" typedoc="Any">Any</type>
119
+ <type name="Any" typedoc="Any"/>
87
120
  <default>{}</default>
88
121
  </arg>
89
122
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="username: str = ">
90
123
  <name>username</name>
91
- <type name="str" typedoc="string">str</type>
124
+ <type name="str" typedoc="string"/>
92
125
  <default/>
93
126
  </arg>
94
127
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="password: str = ">
95
128
  <name>password</name>
96
- <type name="str" typedoc="string">str</type>
129
+ <type name="str" typedoc="string"/>
97
130
  <default/>
98
131
  </arg>
99
132
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="security_token: str = ">
100
133
  <name>security_token</name>
101
- <type name="str" typedoc="string">str</type>
134
+ <type name="str" typedoc="string"/>
102
135
  <default/>
103
136
  </arg>
104
137
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="auth: AuthBase | None = None">
105
138
  <name>auth</name>
106
- <type name="Union" union="true">AuthBase | None<type name="AuthBase">AuthBase</type><type name="None" typedoc="None">None</type></type>
139
+ <type name="Union" union="true">
140
+ <type name="AuthBase"/>
141
+ <type name="None" typedoc="None"/>
142
+ </type>
107
143
  <default>None</default>
108
144
  </arg>
109
145
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="cert: str | Tuple[str, str] | None = None">
110
146
  <name>cert</name>
111
- <type name="Union" union="true">str | Tuple[str, str] | None<type name="str" typedoc="string">str</type><type name="Tuple" typedoc="tuple">Tuple[str, str]<type name="str" typedoc="string">str</type><type name="str" typedoc="string">str</type></type><type name="None" typedoc="None">None</type></type>
147
+ <type name="Union" union="true">
148
+ <type name="str" typedoc="string"/>
149
+ <type name="Tuple" typedoc="tuple">
150
+ <type name="str" typedoc="string"/>
151
+ <type name="str" typedoc="string"/>
152
+ </type>
153
+ <type name="None" typedoc="None"/>
154
+ </type>
112
155
  <default>None</default>
113
156
  </arg>
114
157
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="verify_tls: bool | str | None = True">
115
158
  <name>verify_tls</name>
116
- <type name="Union" union="true">bool | str | None<type name="bool" typedoc="boolean">bool</type><type name="str" typedoc="string">str</type><type name="None" typedoc="None">None</type></type>
159
+ <type name="Union" union="true">
160
+ <type name="bool" typedoc="boolean"/>
161
+ <type name="str" typedoc="string"/>
162
+ <type name="None" typedoc="None"/>
163
+ </type>
117
164
  <default>True</default>
118
165
  </arg>
119
166
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="extra_headers: Dict[str, str] | None = None">
120
167
  <name>extra_headers</name>
121
- <type name="Union" union="true">Dict[str, str] | None<type name="Dict" typedoc="dictionary">Dict[str, str]<type name="str" typedoc="string">str</type><type name="str" typedoc="string">str</type></type><type name="None" typedoc="None">None</type></type>
168
+ <type name="Union" union="true">
169
+ <type name="Dict" typedoc="dictionary">
170
+ <type name="str" typedoc="string"/>
171
+ <type name="str" typedoc="string"/>
172
+ </type>
173
+ <type name="None" typedoc="None"/>
174
+ </type>
122
175
  <default>None</default>
123
176
  </arg>
124
177
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="cookies: Dict[str, str] | RequestsCookieJar | None = None">
125
178
  <name>cookies</name>
126
- <type name="Union" union="true">Dict[str, str] | RequestsCookieJar | None<type name="Dict" typedoc="dictionary">Dict[str, str]<type name="str" typedoc="string">str</type><type name="str" typedoc="string">str</type></type><type name="RequestsCookieJar" typedoc="dictionary">RequestsCookieJar</type><type name="None" typedoc="None">None</type></type>
179
+ <type name="Union" union="true">
180
+ <type name="Dict" typedoc="dictionary">
181
+ <type name="str" typedoc="string"/>
182
+ <type name="str" typedoc="string"/>
183
+ </type>
184
+ <type name="RequestsCookieJar" typedoc="dictionary"/>
185
+ <type name="None" typedoc="None"/>
186
+ </type>
127
187
  <default>None</default>
128
188
  </arg>
129
189
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="proxies: Dict[str, str] | None = None">
130
190
  <name>proxies</name>
131
- <type name="Union" union="true">Dict[str, str] | None<type name="Dict" typedoc="dictionary">Dict[str, str]<type name="str" typedoc="string">str</type><type name="str" typedoc="string">str</type></type><type name="None" typedoc="None">None</type></type>
191
+ <type name="Union" union="true">
192
+ <type name="Dict" typedoc="dictionary">
193
+ <type name="str" typedoc="string"/>
194
+ <type name="str" typedoc="string"/>
195
+ </type>
196
+ <type name="None" typedoc="None"/>
197
+ </type>
132
198
  <default>None</default>
133
199
  </arg>
134
200
  </arguments>
@@ -203,15 +269,15 @@
203
269
  <arguments repr="path: str, method: str, status_code: int">
204
270
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
205
271
  <name>path</name>
206
- <type name="str" typedoc="string">str</type>
272
+ <type name="str" typedoc="string"/>
207
273
  </arg>
208
274
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
209
275
  <name>method</name>
210
- <type name="str" typedoc="string">str</type>
276
+ <type name="str" typedoc="string"/>
211
277
  </arg>
212
278
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="status_code: int">
213
279
  <name>status_code</name>
214
- <type name="int" typedoc="integer">int</type>
280
+ <type name="int" typedoc="integer"/>
215
281
  </arg>
216
282
  </arguments>
217
283
  <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;
@@ -223,11 +289,11 @@
223
289
  <arguments repr="path: str, method: str">
224
290
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
225
291
  <name>path</name>
226
- <type name="str" typedoc="string">str</type>
292
+ <type name="str" typedoc="string"/>
227
293
  </arg>
228
294
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
229
295
  <name>method</name>
230
- <type name="str" typedoc="string">str</type>
296
+ <type name="str" typedoc="string"/>
231
297
  </arg>
232
298
  </arguments>
233
299
  <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;
@@ -239,15 +305,15 @@
239
305
  <arguments repr="path: str, method: str, expected_status_code: int = 404">
240
306
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
241
307
  <name>path</name>
242
- <type name="str" typedoc="string">str</type>
308
+ <type name="str" typedoc="string"/>
243
309
  </arg>
244
310
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
245
311
  <name>method</name>
246
- <type name="str" typedoc="string">str</type>
312
+ <type name="str" typedoc="string"/>
247
313
  </arg>
248
314
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="expected_status_code: int = 404">
249
315
  <name>expected_status_code</name>
250
- <type name="int" typedoc="integer">int</type>
316
+ <type name="int" typedoc="integer"/>
251
317
  <default>404</default>
252
318
  </arg>
253
319
  </arguments>
@@ -261,11 +327,11 @@
261
327
  <arguments repr="path: str, method: str">
262
328
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
263
329
  <name>path</name>
264
- <type name="str" typedoc="string">str</type>
330
+ <type name="str" typedoc="string"/>
265
331
  </arg>
266
332
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
267
333
  <name>method</name>
268
- <type name="str" typedoc="string">str</type>
334
+ <type name="str" typedoc="string"/>
269
335
  </arg>
270
336
  </arguments>
271
337
  <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;
@@ -274,19 +340,6 @@
274
340
  <shortdoc>Perform a request for `method` on the `path`, with no authorization.</shortdoc>
275
341
  </kw>
276
342
  </keywords>
277
- <datatypes>
278
- <enums>
279
- <enum name="ValidationLevel">
280
- <doc>&lt;p&gt;The available levels for the response_validation parameter.&lt;/p&gt;</doc>
281
- <members>
282
- <member name="DISABLED" value="DISABLED"/>
283
- <member name="INFO" value="INFO"/>
284
- <member name="WARN" value="WARN"/>
285
- <member name="STRICT" value="STRICT"/>
286
- </members>
287
- </enum>
288
- </enums>
289
- </datatypes>
290
343
  <typedocs>
291
344
  <type name="Any" type="Standard">
292
345
  <doc>&lt;p&gt;Any value is accepted. No conversion is done.&lt;/p&gt;</doc>
OpenApiLibCore/openapi_libcore.libspec CHANGED
@@ -1,6 +1,6 @@
1
1
  <?xml version="1.0" encoding="UTF-8"?>
2
- <keywordspec name="OpenApiLibCore" type="LIBRARY" format="HTML" scope="SUITE" generated="2024-05-15T18:47:15+00:00" specversion="5" source="/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py" lineno="430">
3
- <version>0.2.2</version>
2
+ <keywordspec name="OpenApiLibCore" type="LIBRARY" format="HTML" scope="SUITE" generated="2024-06-20T15:30:30+00:00" specversion="6" source="/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py" lineno="430">
3
+ <version>0.2.3</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>
@@ -10,91 +10,133 @@
10
10
  <arguments repr="source: str, origin: str = , base_path: str = , mappings_path: str | Path = , invalid_property_default_response: int = 422, default_id_property_name: str = id, faker_locale: str | List[str] | None = None, recursion_limit: int = 1, recursion_default: Any = {}, username: str = , password: str = , security_token: str = , auth: AuthBase | None = None, cert: str | Tuple[str, str] | None = None, verify_tls: bool | str | None = True, extra_headers: Dict[str, str] | None = None, cookies: Dict[str, str] | RequestsCookieJar | None = None, proxies: Dict[str, str] | None = None">
11
11
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="source: str">
12
12
  <name>source</name>
13
- <type name="str" typedoc="string">str</type>
13
+ <type name="str" typedoc="string"/>
14
14
  </arg>
15
15
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="origin: str = ">
16
16
  <name>origin</name>
17
- <type name="str" typedoc="string">str</type>
17
+ <type name="str" typedoc="string"/>
18
18
  <default/>
19
19
  </arg>
20
20
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="base_path: str = ">
21
21
  <name>base_path</name>
22
- <type name="str" typedoc="string">str</type>
22
+ <type name="str" typedoc="string"/>
23
23
  <default/>
24
24
  </arg>
25
25
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="mappings_path: str | Path = ">
26
26
  <name>mappings_path</name>
27
- <type name="Union" union="true">str | Path<type name="str" typedoc="string">str</type><type name="Path" typedoc="Path">Path</type></type>
27
+ <type name="Union" union="true">
28
+ <type name="str" typedoc="string"/>
29
+ <type name="Path" typedoc="Path"/>
30
+ </type>
28
31
  <default/>
29
32
  </arg>
30
33
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="invalid_property_default_response: int = 422">
31
34
  <name>invalid_property_default_response</name>
32
- <type name="int" typedoc="integer">int</type>
35
+ <type name="int" typedoc="integer"/>
33
36
  <default>422</default>
34
37
  </arg>
35
38
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="default_id_property_name: str = id">
36
39
  <name>default_id_property_name</name>
37
- <type name="str" typedoc="string">str</type>
40
+ <type name="str" typedoc="string"/>
38
41
  <default>id</default>
39
42
  </arg>
40
43
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="faker_locale: str | List[str] | None = None">
41
44
  <name>faker_locale</name>
42
- <type name="Union" union="true">str | List[str] | None<type name="str" typedoc="string">str</type><type name="List" typedoc="list">List[str]<type name="str" typedoc="string">str</type></type><type name="None" typedoc="None">None</type></type>
45
+ <type name="Union" union="true">
46
+ <type name="str" typedoc="string"/>
47
+ <type name="List" typedoc="list">
48
+ <type name="str" typedoc="string"/>
49
+ </type>
50
+ <type name="None" typedoc="None"/>
51
+ </type>
43
52
  <default>None</default>
44
53
  </arg>
45
54
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="recursion_limit: int = 1">
46
55
  <name>recursion_limit</name>
47
- <type name="int" typedoc="integer">int</type>
56
+ <type name="int" typedoc="integer"/>
48
57
  <default>1</default>
49
58
  </arg>
50
59
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="recursion_default: Any = {}">
51
60
  <name>recursion_default</name>
52
- <type name="Any" typedoc="Any">Any</type>
61
+ <type name="Any" typedoc="Any"/>
53
62
  <default>{}</default>
54
63
  </arg>
55
64
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="username: str = ">
56
65
  <name>username</name>
57
- <type name="str" typedoc="string">str</type>
66
+ <type name="str" typedoc="string"/>
58
67
  <default/>
59
68
  </arg>
60
69
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="password: str = ">
61
70
  <name>password</name>
62
- <type name="str" typedoc="string">str</type>
71
+ <type name="str" typedoc="string"/>
63
72
  <default/>
64
73
  </arg>
65
74
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="security_token: str = ">
66
75
  <name>security_token</name>
67
- <type name="str" typedoc="string">str</type>
76
+ <type name="str" typedoc="string"/>
68
77
  <default/>
69
78
  </arg>
70
79
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="auth: AuthBase | None = None">
71
80
  <name>auth</name>
72
- <type name="Union" union="true">AuthBase | None<type name="AuthBase">AuthBase</type><type name="None" typedoc="None">None</type></type>
81
+ <type name="Union" union="true">
82
+ <type name="AuthBase"/>
83
+ <type name="None" typedoc="None"/>
84
+ </type>
73
85
  <default>None</default>
74
86
  </arg>
75
87
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="cert: str | Tuple[str, str] | None = None">
76
88
  <name>cert</name>
77
- <type name="Union" union="true">str | Tuple[str, str] | None<type name="str" typedoc="string">str</type><type name="Tuple" typedoc="tuple">Tuple[str, str]<type name="str" typedoc="string">str</type><type name="str" typedoc="string">str</type></type><type name="None" typedoc="None">None</type></type>
89
+ <type name="Union" union="true">
90
+ <type name="str" typedoc="string"/>
91
+ <type name="Tuple" typedoc="tuple">
92
+ <type name="str" typedoc="string"/>
93
+ <type name="str" typedoc="string"/>
94
+ </type>
95
+ <type name="None" typedoc="None"/>
96
+ </type>
78
97
  <default>None</default>
79
98
  </arg>
80
99
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="verify_tls: bool | str | None = True">
81
100
  <name>verify_tls</name>
82
- <type name="Union" union="true">bool | str | None<type name="bool" typedoc="boolean">bool</type><type name="str" typedoc="string">str</type><type name="None" typedoc="None">None</type></type>
101
+ <type name="Union" union="true">
102
+ <type name="bool" typedoc="boolean"/>
103
+ <type name="str" typedoc="string"/>
104
+ <type name="None" typedoc="None"/>
105
+ </type>
83
106
  <default>True</default>
84
107
  </arg>
85
108
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="extra_headers: Dict[str, str] | None = None">
86
109
  <name>extra_headers</name>
87
- <type name="Union" union="true">Dict[str, str] | None<type name="Dict" typedoc="dictionary">Dict[str, str]<type name="str" typedoc="string">str</type><type name="str" typedoc="string">str</type></type><type name="None" typedoc="None">None</type></type>
110
+ <type name="Union" union="true">
111
+ <type name="Dict" typedoc="dictionary">
112
+ <type name="str" typedoc="string"/>
113
+ <type name="str" typedoc="string"/>
114
+ </type>
115
+ <type name="None" typedoc="None"/>
116
+ </type>
88
117
  <default>None</default>
89
118
  </arg>
90
119
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="cookies: Dict[str, str] | RequestsCookieJar | None = None">
91
120
  <name>cookies</name>
92
- <type name="Union" union="true">Dict[str, str] | RequestsCookieJar | None<type name="Dict" typedoc="dictionary">Dict[str, str]<type name="str" typedoc="string">str</type><type name="str" typedoc="string">str</type></type><type name="RequestsCookieJar" typedoc="dictionary">RequestsCookieJar</type><type name="None" typedoc="None">None</type></type>
121
+ <type name="Union" union="true">
122
+ <type name="Dict" typedoc="dictionary">
123
+ <type name="str" typedoc="string"/>
124
+ <type name="str" typedoc="string"/>
125
+ </type>
126
+ <type name="RequestsCookieJar" typedoc="dictionary"/>
127
+ <type name="None" typedoc="None"/>
128
+ </type>
93
129
  <default>None</default>
94
130
  </arg>
95
131
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="proxies: Dict[str, str] | None = None">
96
132
  <name>proxies</name>
97
- <type name="Union" union="true">Dict[str, str] | None<type name="Dict" typedoc="dictionary">Dict[str, str]<type name="str" typedoc="string">str</type><type name="str" typedoc="string">str</type></type><type name="None" typedoc="None">None</type></type>
133
+ <type name="Union" union="true">
134
+ <type name="Dict" typedoc="dictionary">
135
+ <type name="str" typedoc="string"/>
136
+ <type name="str" typedoc="string"/>
137
+ </type>
138
+ <type name="None" typedoc="None"/>
139
+ </type>
98
140
  <default>None</default>
99
141
  </arg>
100
142
  </arguments>
@@ -145,31 +187,83 @@
145
187
  </inits>
146
188
  <keywords>
147
189
  <kw name="Authorized Request" lineno="1607">
148
- <arguments repr="url: str, method: str, params: Dict[str, Any] | None = None, headers: Dict[str, str] | None = None, json_data: Dict[str, Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None] | List[Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None] | str | int | float | bool | None = None">
190
+ <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">
149
191
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
150
192
  <name>url</name>
151
- <type name="str" typedoc="string">str</type>
193
+ <type name="str" typedoc="string"/>
152
194
  </arg>
153
195
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
154
196
  <name>method</name>
155
- <type name="str" typedoc="string">str</type>
197
+ <type name="str" typedoc="string"/>
156
198
  </arg>
157
199
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="params: Dict[str, Any] | None = None">
158
200
  <name>params</name>
159
- <type name="Union" union="true">Dict[str, Any] | None<type name="Dict" typedoc="dictionary">Dict[str, Any]<type name="str" typedoc="string">str</type><type name="Any" typedoc="Any">Any</type></type><type name="None" typedoc="None">None</type></type>
201
+ <type name="Union" union="true">
202
+ <type name="Dict" typedoc="dictionary">
203
+ <type name="str" typedoc="string"/>
204
+ <type name="Any" typedoc="Any"/>
205
+ </type>
206
+ <type name="None" typedoc="None"/>
207
+ </type>
160
208
  <default>None</default>
161
209
  </arg>
162
210
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="headers: Dict[str, str] | None = None">
163
211
  <name>headers</name>
164
- <type name="Union" union="true">Dict[str, str] | None<type name="Dict" typedoc="dictionary">Dict[str, str]<type name="str" typedoc="string">str</type><type name="str" typedoc="string">str</type></type><type name="None" typedoc="None">None</type></type>
212
+ <type name="Union" union="true">
213
+ <type name="Dict" typedoc="dictionary">
214
+ <type name="str" typedoc="string"/>
215
+ <type name="str" typedoc="string"/>
216
+ </type>
217
+ <type name="None" typedoc="None"/>
218
+ </type>
165
219
  <default>None</default>
166
220
  </arg>
167
- <arg kind="POSITIONAL_OR_NAMED" required="false" repr="json_data: Dict[str, Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None] | List[Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None] | str | int | float | bool | None = None">
221
+ <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">
168
222
  <name>json_data</name>
169
- <type name="Union" union="true">Dict[str, Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None] | List[Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None] | str | int | float | bool | None<type name="Dict" typedoc="dictionary">Dict[str, Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None]<type name="str" typedoc="string">str</type><type name="Union" union="true">Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None<type name="Dict" typedoc="dictionary">Dict[str, ForwardRef('JSON')]<type name="str" typedoc="string">str</type><type name="ForwardRef('JSON')">ForwardRef('JSON')</type></type><type name="List" typedoc="list">List[ForwardRef('JSON')]<type name="ForwardRef('JSON')">ForwardRef('JSON')</type></type><type name="str" typedoc="string">str</type><type name="int" typedoc="integer">int</type><type name="float" typedoc="float">float</type><type name="bool" typedoc="boolean">bool</type><type name="None" typedoc="None">None</type></type></type><type name="List" typedoc="list">List[Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None]<type name="Union" union="true">Dict[str, ForwardRef('JSON')] | List[ForwardRef('JSON')] | str | int | float | bool | None<type name="Dict" typedoc="dictionary">Dict[str, ForwardRef('JSON')]<type name="str" typedoc="string">str</type><type name="ForwardRef('JSON')">ForwardRef('JSON')</type></type><type name="List" typedoc="list">List[ForwardRef('JSON')]<type name="ForwardRef('JSON')">ForwardRef('JSON')</type></type><type name="str" typedoc="string">str</type><type name="int" typedoc="integer">int</type><type name="float" typedoc="float">float</type><type name="bool" typedoc="boolean">bool</type><type name="None" typedoc="None">None</type></type></type><type name="str" typedoc="string">str</type><type name="int" typedoc="integer">int</type><type name="float" typedoc="float">float</type><type name="bool" typedoc="boolean">bool</type><type name="None" typedoc="None">None</type></type>
223
+ <type name="Union" union="true">
224
+ <type name="Dict" typedoc="dictionary">
225
+ <type name="str" typedoc="string"/>
226
+ <type name="Union" union="true">
227
+ <type name="Dict" typedoc="dictionary">
228
+ <type name="str" typedoc="string"/>
229
+ <type name="JSON"/>
230
+ </type>
231
+ <type name="List" typedoc="list">
232
+ <type name="JSON"/>
233
+ </type>
234
+ <type name="str" typedoc="string"/>
235
+ <type name="int" typedoc="integer"/>
236
+ <type name="float" typedoc="float"/>
237
+ <type name="bool" typedoc="boolean"/>
238
+ <type name="None" typedoc="None"/>
239
+ </type>
240
+ </type>
241
+ <type name="List" typedoc="list">
242
+ <type name="Union" union="true">
243
+ <type name="Dict" typedoc="dictionary">
244
+ <type name="str" typedoc="string"/>
245
+ <type name="JSON"/>
246
+ </type>
247
+ <type name="List" typedoc="list">
248
+ <type name="JSON"/>
249
+ </type>
250
+ <type name="str" typedoc="string"/>
251
+ <type name="int" typedoc="integer"/>
252
+ <type name="float" typedoc="float"/>
253
+ <type name="bool" typedoc="boolean"/>
254
+ <type name="None" typedoc="None"/>
255
+ </type>
256
+ </type>
257
+ <type name="str" typedoc="string"/>
258
+ <type name="int" typedoc="integer"/>
259
+ <type name="float" typedoc="float"/>
260
+ <type name="bool" typedoc="boolean"/>
261
+ <type name="None" typedoc="None"/>
262
+ </type>
170
263
  <default>None</default>
171
264
  </arg>
172
265
  </arguments>
266
+ <returntype name="Response"/>
173
267
  <doc>&lt;p&gt;Perform a request using the security token or authentication set in the library.&lt;/p&gt;
174
268
  &lt;p&gt;&amp;gt; Note: provided username / password or auth objects take precedence over token based security&lt;/p&gt;</doc>
175
269
  <shortdoc>Perform a request using the security token or authentication set in the library.</shortdoc>
@@ -178,11 +272,11 @@
178
272
  <arguments repr="url: str, resource_relation: IdReference">
179
273
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
180
274
  <name>url</name>
181
- <type name="str" typedoc="string">str</type>
275
+ <type name="str" typedoc="string"/>
182
276
  </arg>
183
277
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="resource_relation: IdReference">
184
278
  <name>resource_relation</name>
185
- <type name="IdReference">IdReference</type>
279
+ <type name="IdReference"/>
186
280
  </arg>
187
281
  </arguments>
188
282
  <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>
@@ -192,9 +286,12 @@
192
286
  <arguments repr="url: str">
193
287
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
194
288
  <name>url</name>
195
- <type name="str" typedoc="string">str</type>
289
+ <type name="str" typedoc="string"/>
196
290
  </arg>
197
291
  </arguments>
292
+ <returntype name="List" typedoc="list">
293
+ <type name="str" typedoc="string"/>
294
+ </returntype>
198
295
  <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>
199
296
  <shortdoc>Perform a GET request on the `url` and return the list of resource `ids` from the response.</shortdoc>
200
297
  </kw>
@@ -202,21 +299,25 @@
202
299
  <arguments repr="url: str, method: str, status_code: int, request_data: RequestData">
203
300
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
204
301
  <name>url</name>
205
- <type name="str" typedoc="string">str</type>
302
+ <type name="str" typedoc="string"/>
206
303
  </arg>
207
304
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
208
305
  <name>method</name>
209
- <type name="str" typedoc="string">str</type>
306
+ <type name="str" typedoc="string"/>
210
307
  </arg>
211
308
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="status_code: int">
212
309
  <name>status_code</name>
213
- <type name="int" typedoc="integer">int</type>
310
+ <type name="int" typedoc="integer"/>
214
311
  </arg>
215
312
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="request_data: RequestData">
216
313
  <name>request_data</name>
217
- <type name="RequestData">RequestData</type>
314
+ <type name="RequestData"/>
218
315
  </arg>
219
316
  </arguments>
317
+ <returntype name="Dict" typedoc="dictionary">
318
+ <type name="str" typedoc="string"/>
319
+ <type name="Any" typedoc="Any"/>
320
+ </returntype>
220
321
  <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;
221
322
  &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>
222
323
  <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>
@@ -225,13 +326,23 @@
225
326
  <arguments repr="status_code: int, request_data: RequestData">
226
327
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="status_code: int">
227
328
  <name>status_code</name>
228
- <type name="int" typedoc="integer">int</type>
329
+ <type name="int" typedoc="integer"/>
229
330
  </arg>
230
331
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="request_data: RequestData">
231
332
  <name>request_data</name>
232
- <type name="RequestData">RequestData</type>
333
+ <type name="RequestData"/>
233
334
  </arg>
234
335
  </arguments>
336
+ <returntype name="Tuple" typedoc="tuple">
337
+ <type name="Dict" typedoc="dictionary">
338
+ <type name="str" typedoc="string"/>
339
+ <type name="Any" typedoc="Any"/>
340
+ </type>
341
+ <type name="Dict" typedoc="dictionary">
342
+ <type name="str" typedoc="string"/>
343
+ <type name="str" typedoc="string"/>
344
+ </type>
345
+ </returntype>
235
346
  <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>
236
347
  <shortdoc>Returns a version of `params, headers` as present on `request_data` that has been modified to cause the provided `status_code`.</shortdoc>
237
348
  </kw>
@@ -239,9 +350,13 @@
239
350
  <arguments repr="valid_url: str">
240
351
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="valid_url: str">
241
352
  <name>valid_url</name>
242
- <type name="str" typedoc="string">str</type>
353
+ <type name="str" typedoc="string"/>
243
354
  </arg>
244
355
  </arguments>
356
+ <returntype name="Union" union="true">
357
+ <type name="str" typedoc="string"/>
358
+ <type name="None" typedoc="None"/>
359
+ </returntype>
245
360
  <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.&lt;/p&gt;
246
361
  &lt;p&gt;Raises ValueError if the valid_url cannot be invalidated.&lt;/p&gt;</doc>
247
362
  <shortdoc>Return an url with all the path parameters in the `valid_url` replaced by a random UUID.</shortdoc>
@@ -250,18 +365,33 @@
250
365
  <arguments repr="schema: Dict[str, Any], dto_class: Dto | Type[Dto], operation_id: str = ">
251
366
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="schema: Dict[str, Any]">
252
367
  <name>schema</name>
253
- <type name="Dict" typedoc="dictionary">Dict[str, Any]<type name="str" typedoc="string">str</type><type name="Any" typedoc="Any">Any</type></type>
368
+ <type name="Dict" typedoc="dictionary">
369
+ <type name="str" typedoc="string"/>
370
+ <type name="Any" typedoc="Any"/>
371
+ </type>
254
372
  </arg>
255
373
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="dto_class: Dto | Type[Dto]">
256
374
  <name>dto_class</name>
257
- <type name="Union" union="true">Dto | Type[Dto]<type name="Dto">Dto</type><type name="Type">Type[Dto]<type name="Dto">Dto</type></type></type>
375
+ <type name="Union" union="true">
376
+ <type name="Dto"/>
377
+ <type name="Type">
378
+ <type name="Dto"/>
379
+ </type>
380
+ </type>
258
381
  </arg>
259
382
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="operation_id: str = ">
260
383
  <name>operation_id</name>
261
- <type name="str" typedoc="string">str</type>
384
+ <type name="str" typedoc="string"/>
262
385
  <default/>
263
386
  </arg>
264
387
  </arguments>
388
+ <returntype name="Union" union="true">
389
+ <type name="Dict" typedoc="dictionary">
390
+ <type name="str" typedoc="string"/>
391
+ <type name="Any" typedoc="Any"/>
392
+ </type>
393
+ <type name="None" typedoc="None"/>
394
+ </returntype>
265
395
  <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>
266
396
  <shortdoc>Generate a valid (json-compatible) dict for all the `dto_class` properties.</shortdoc>
267
397
  </kw>
@@ -269,21 +399,25 @@
269
399
  <arguments repr="url: str, method: str, dto: Dto, conflict_status_code: int">
270
400
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
271
401
  <name>url</name>
272
- <type name="str" typedoc="string">str</type>
402
+ <type name="str" typedoc="string"/>
273
403
  </arg>
274
404
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
275
405
  <name>method</name>
276
- <type name="str" typedoc="string">str</type>
406
+ <type name="str" typedoc="string"/>
277
407
  </arg>
278
408
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="dto: Dto">
279
409
  <name>dto</name>
280
- <type name="Dto">Dto</type>
410
+ <type name="Dto"/>
281
411
  </arg>
282
412
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="conflict_status_code: int">
283
413
  <name>conflict_status_code</name>
284
- <type name="int" typedoc="integer">int</type>
414
+ <type name="int" typedoc="integer"/>
285
415
  </arg>
286
416
  </arguments>
417
+ <returntype name="Dict" typedoc="dictionary">
418
+ <type name="str" typedoc="string"/>
419
+ <type name="Any" typedoc="Any"/>
420
+ </returntype>
287
421
  <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>
288
422
  <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>
289
423
  </kw>
@@ -291,9 +425,10 @@
291
425
  <arguments repr="url: str">
292
426
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
293
427
  <name>url</name>
294
- <type name="str" typedoc="string">str</type>
428
+ <type name="str" typedoc="string"/>
295
429
  </arg>
296
430
  </arguments>
431
+ <returntype name="str" typedoc="string"/>
297
432
  <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>
298
433
  <shortdoc>Return the endpoint as found in the `paths` section based on the given `url`.</shortdoc>
299
434
  </kw>
@@ -301,13 +436,14 @@
301
436
  <arguments repr="endpoint: str, method: str">
302
437
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
303
438
  <name>endpoint</name>
304
- <type name="str" typedoc="string">str</type>
439
+ <type name="str" typedoc="string"/>
305
440
  </arg>
306
441
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
307
442
  <name>method</name>
308
- <type name="str" typedoc="string">str</type>
443
+ <type name="str" typedoc="string"/>
309
444
  </arg>
310
445
  </arguments>
446
+ <returntype name="RequestData"/>
311
447
  <doc>&lt;p&gt;Return an object with valid request data for body, headers and query params.&lt;/p&gt;</doc>
312
448
  <shortdoc>Return an object with valid request data for body, headers and query params.</shortdoc>
313
449
  </kw>
@@ -315,13 +451,18 @@
315
451
  <arguments repr="endpoint: str, method: str">
316
452
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
317
453
  <name>endpoint</name>
318
- <type name="str" typedoc="string">str</type>
454
+ <type name="str" typedoc="string"/>
319
455
  </arg>
320
456
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
321
457
  <name>method</name>
322
- <type name="str" typedoc="string">str</type>
458
+ <type name="str" typedoc="string"/>
323
459
  </arg>
324
460
  </arguments>
461
+ <returntype name="Union" union="true">
462
+ <type name="str" typedoc="string"/>
463
+ <type name="int" typedoc="integer"/>
464
+ <type name="float" typedoc="float"/>
465
+ </returntype>
325
466
  <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;
326
467
  &lt;p&gt;To prevent resource conflicts with other test cases, a new resource is created (POST) if possible.&lt;/p&gt;</doc>
327
468
  <shortdoc>Support keyword that returns the `id` for an existing resource at `endpoint`.</shortdoc>
@@ -330,13 +471,14 @@
330
471
  <arguments repr="endpoint: str, method: str">
331
472
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
332
473
  <name>endpoint</name>
333
- <type name="str" typedoc="string">str</type>
474
+ <type name="str" typedoc="string"/>
334
475
  </arg>
335
476
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
336
477
  <name>method</name>
337
- <type name="str" typedoc="string">str</type>
478
+ <type name="str" typedoc="string"/>
338
479
  </arg>
339
480
  </arguments>
481
+ <returntype name="str" typedoc="string"/>
340
482
  <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;
341
483
  &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;
342
484
  &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>
@@ -346,19 +488,25 @@
346
488
  <arguments repr="path: str, status_code: int, request_values: RequestValues, original_data: Dict[str, Any] | None = None">
347
489
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
348
490
  <name>path</name>
349
- <type name="str" typedoc="string">str</type>
491
+ <type name="str" typedoc="string"/>
350
492
  </arg>
351
493
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="status_code: int">
352
494
  <name>status_code</name>
353
- <type name="int" typedoc="integer">int</type>
495
+ <type name="int" typedoc="integer"/>
354
496
  </arg>
355
497
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="request_values: RequestValues">
356
498
  <name>request_values</name>
357
- <type name="RequestValues">RequestValues</type>
499
+ <type name="RequestValues"/>
358
500
  </arg>
359
501
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="original_data: Dict[str, Any] | None = None">
360
502
  <name>original_data</name>
361
- <type name="Union" union="true">Dict[str, Any] | None<type name="Dict" typedoc="dictionary">Dict[str, Any]<type name="str" typedoc="string">str</type><type name="Any" typedoc="Any">Any</type></type><type name="None" typedoc="None">None</type></type>
503
+ <type name="Union" union="true">
504
+ <type name="Dict" typedoc="dictionary">
505
+ <type name="str" typedoc="string"/>
506
+ <type name="Any" typedoc="Any"/>
507
+ </type>
508
+ <type name="None" typedoc="None"/>
509
+ </type>
362
510
  <default>None</default>
363
511
  </arg>
364
512
  </arguments>
@@ -369,7 +517,7 @@
369
517
  <arguments repr="origin: str">
370
518
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="origin: str">
371
519
  <name>origin</name>
372
- <type name="str" typedoc="string">str</type>
520
+ <type name="str" typedoc="string"/>
373
521
  </arg>
374
522
  </arguments>
375
523
  <doc>&lt;p&gt;Update the &lt;span class="name"&gt;origin&lt;/span&gt; after the library is imported.&lt;/p&gt;
@@ -381,11 +529,17 @@
381
529
  <arguments repr="resource: Dict[str, Any], schema: Dict[str, Any]">
382
530
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="resource: Dict[str, Any]">
383
531
  <name>resource</name>
384
- <type name="Dict" typedoc="dictionary">Dict[str, Any]<type name="str" typedoc="string">str</type><type name="Any" typedoc="Any">Any</type></type>
532
+ <type name="Dict" typedoc="dictionary">
533
+ <type name="str" typedoc="string"/>
534
+ <type name="Any" typedoc="Any"/>
535
+ </type>
385
536
  </arg>
386
537
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="schema: Dict[str, Any]">
387
538
  <name>schema</name>
388
- <type name="Dict" typedoc="dictionary">Dict[str, Any]<type name="str" typedoc="string">str</type><type name="Any" typedoc="Any">Any</type></type>
539
+ <type name="Dict" typedoc="dictionary">
540
+ <type name="str" typedoc="string"/>
541
+ <type name="Any" typedoc="Any"/>
542
+ </type>
389
543
  </arg>
390
544
  </arguments>
391
545
  <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>
@@ -395,15 +549,21 @@
395
549
  <arguments repr="path: str, response: Response, original_data: Dict[str, Any] | None = None">
396
550
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
397
551
  <name>path</name>
398
- <type name="str" typedoc="string">str</type>
552
+ <type name="str" typedoc="string"/>
399
553
  </arg>
400
554
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="response: Response">
401
555
  <name>response</name>
402
- <type name="Response">Response</type>
556
+ <type name="Response"/>
403
557
  </arg>
404
558
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="original_data: Dict[str, Any] | None = None">
405
559
  <name>original_data</name>
406
- <type name="Union" union="true">Dict[str, Any] | None<type name="Dict" typedoc="dictionary">Dict[str, Any]<type name="str" typedoc="string">str</type><type name="Any" typedoc="Any">Any</type></type><type name="None" typedoc="None">None</type></type>
560
+ <type name="Union" union="true">
561
+ <type name="Dict" typedoc="dictionary">
562
+ <type name="str" typedoc="string"/>
563
+ <type name="Any" typedoc="Any"/>
564
+ </type>
565
+ <type name="None" typedoc="None"/>
566
+ </type>
407
567
  <default>None</default>
408
568
  </arg>
409
569
  </arguments>
@@ -422,11 +582,17 @@
422
582
  <arguments repr="response: Response, original_data: Dict[str, Any] | None = None">
423
583
  <arg kind="POSITIONAL_OR_NAMED" required="true" repr="response: Response">
424
584
  <name>response</name>
425
- <type name="Response">Response</type>
585
+ <type name="Response"/>
426
586
  </arg>
427
587
  <arg kind="POSITIONAL_OR_NAMED" required="false" repr="original_data: Dict[str, Any] | None = None">
428
588
  <name>original_data</name>
429
- <type name="Union" union="true">Dict[str, Any] | None<type name="Dict" typedoc="dictionary">Dict[str, Any]<type name="str" typedoc="string">str</type><type name="Any" typedoc="Any">Any</type></type><type name="None" typedoc="None">None</type></type>
589
+ <type name="Union" union="true">
590
+ <type name="Dict" typedoc="dictionary">
591
+ <type name="str" typedoc="string"/>
592
+ <type name="Any" typedoc="Any"/>
593
+ </type>
594
+ <type name="None" typedoc="None"/>
595
+ </type>
430
596
  <default>None</default>
431
597
  </arg>
432
598
  </arguments>
@@ -434,8 +600,6 @@
434
600
  <shortdoc>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.</shortdoc>
435
601
  </kw>
436
602
  </keywords>
437
- <datatypes>
438
- </datatypes>
439
603
  <typedocs>
440
604
  <type name="Any" type="Standard">
441
605
  <doc>&lt;p&gt;Any value is accepted. No conversion is done.&lt;/p&gt;</doc>
@@ -445,7 +609,10 @@
445
609
  <usages>
446
610
  <usage>__init__</usage>
447
611
  <usage>Authorized Request</usage>
612
+ <usage>Get Invalid Json Data</usage>
613
+ <usage>Get Invalidated Parameters</usage>
448
614
  <usage>Get Json Data For Dto Class</usage>
615
+ <usage>Get Json Data With Conflict</usage>
449
616
  <usage>Perform Validated Request</usage>
450
617
  <usage>Validate Resource Properties</usage>
451
618
  <usage>Validate Response</usage>
@@ -477,7 +644,10 @@
477
644
  <usages>
478
645
  <usage>__init__</usage>
479
646
  <usage>Authorized Request</usage>
647
+ <usage>Get Invalid Json Data</usage>
648
+ <usage>Get Invalidated Parameters</usage>
480
649
  <usage>Get Json Data For Dto Class</usage>
650
+ <usage>Get Json Data With Conflict</usage>
481
651
  <usage>Perform Validated Request</usage>
482
652
  <usage>Validate Resource Properties</usage>
483
653
  <usage>Validate Response</usage>
@@ -494,6 +664,7 @@
494
664
  </accepts>
495
665
  <usages>
496
666
  <usage>Authorized Request</usage>
667
+ <usage>Get Valid Id For Endpoint</usage>
497
668
  </usages>
498
669
  </type>
499
670
  <type name="integer" type="Standard">
@@ -511,6 +682,7 @@
511
682
  <usage>Get Invalid Json Data</usage>
512
683
  <usage>Get Invalidated Parameters</usage>
513
684
  <usage>Get Json Data With Conflict</usage>
685
+ <usage>Get Valid Id For Endpoint</usage>
514
686
  <usage>Perform Validated Request</usage>
515
687
  </usages>
516
688
  </type>
@@ -525,6 +697,7 @@
525
697
  <usages>
526
698
  <usage>__init__</usage>
527
699
  <usage>Authorized Request</usage>
700
+ <usage>Get Ids From Url</usage>
528
701
  </usages>
529
702
  </type>
530
703
  <type name="None" type="Standard">
@@ -535,6 +708,8 @@
535
708
  <usages>
536
709
  <usage>__init__</usage>
537
710
  <usage>Authorized Request</usage>
711
+ <usage>Get Invalidated Url</usage>
712
+ <usage>Get Json Data For Dto Class</usage>
538
713
  <usage>Perform Validated Request</usage>
539
714
  <usage>Validate Response</usage>
540
715
  <usage>Validate Send Response</usage>
@@ -562,6 +737,7 @@
562
737
  <usage>Ensure In Use</usage>
563
738
  <usage>Get Ids From Url</usage>
564
739
  <usage>Get Invalid Json Data</usage>
740
+ <usage>Get Invalidated Parameters</usage>
565
741
  <usage>Get Invalidated Url</usage>
566
742
  <usage>Get Json Data For Dto Class</usage>
567
743
  <usage>Get Json Data With Conflict</usage>
@@ -586,6 +762,7 @@
586
762
  </accepts>
587
763
  <usages>
588
764
  <usage>__init__</usage>
765
+ <usage>Get Invalidated Parameters</usage>
589
766
  </usages>
590
767
  </type>
591
768
  </typedocs>
OpenApiLibCore/openapi_libcore.py CHANGED
File without changes
{robotframework_openapitools-0.2.2.dist-info → robotframework_openapitools-0.2.3.dist-info}/METADATA RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: robotframework-openapitools
3
- Version: 0.2.2
3
+ Version: 0.2.3
4
4
  Summary: A set of Robot Framework libraries to test APIs for which the OAS is available.
5
5
  Home-page: https://github.com/MarketSquare/robotframework-openapitools
6
6
  License: Apache-2.0
{robotframework_openapitools-0.2.2.dist-info → robotframework_openapitools-0.2.3.dist-info}/RECORD RENAMED
@@ -1,14 +1,14 @@
1
1
  OpenApiDriver/__init__.py,sha256=34h5RkB8nBNRKPId4r_B_xzcgXJYD3m2QYwIaPfpv80,1331
2
2
  OpenApiDriver/openapi_executors.py,sha256=7zjvMzkKY-IknTWZABZZoMNguMqXVn3gNiiljDQ9VyQ,12260
3
3
  OpenApiDriver/openapi_reader.py,sha256=4kSM-hFd54ws-jq88inbienkaoC5sSDwfRuxLrHP7aA,4652
4
- OpenApiDriver/openapidriver.libspec,sha256=JuR4-Feq6xy3WQZn0xe8U9jA0rVnnvfvLN-3X6YwDjY,28322
4
+ OpenApiDriver/openapidriver.libspec,sha256=olRvV7rb60qyB9LFbcVUc0Sn0mBTS8ja3bcfuf8soYI,27059
5
5
  OpenApiDriver/openapidriver.py,sha256=QRFcF1q9x88rqsD7XzBN25wPYqTbZldK4rSvpEdhQHo,15214
6
6
  OpenApiDriver/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
7
7
  OpenApiLibCore/__init__.py,sha256=CGZRj3Vh4TZ76LOLWJOrBFr27QYWVXsO1imLqH-aP9E,1604
8
8
  OpenApiLibCore/dto_base.py,sha256=qAPSLnrs1n_sbfe1z-3EPV31Q7dMe0Nno2XRFmrYl9A,11792
9
9
  OpenApiLibCore/dto_utils.py,sha256=maYX9QqPaJtiEo8vIFQLsT2FOT-LUGVnNcVaca4zCDk,2903
10
10
  OpenApiLibCore/oas_cache.py,sha256=Qg_Is5pAJZjZu5VmwEEarQs8teKrh3Y2psCcpDLU5Y4,379
11
- OpenApiLibCore/openapi_libcore.libspec,sha256=qgCF2aJGNWUgSX6-xjHQ2-DvknFGcA-1CnvU3VHCRzA,39801
11
+ OpenApiLibCore/openapi_libcore.libspec,sha256=NuArV1fyBCQCbRdoHyFv81Ah1BppVCE2nS6L05cobqo,39195
12
12
  OpenApiLibCore/openapi_libcore.py,sha256=BVBaeqv_ZgPw5332BmNeTjONdpL73dXPcf8w1bWtvBA,86685
13
13
  OpenApiLibCore/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
14
14
  OpenApiLibCore/value_utils.py,sha256=wO5ssYTuk4YWWMJb0kl5n20X2r0NG55FXvgLqQd8qvw,18145
@@ -35,7 +35,7 @@ roboswag/validate/__init__.py,sha256=stpgQmvZvqlqPBjZ3Vxhd3wbX_Nb85jyIbj44_EhK_w
35
35
  roboswag/validate/core.py,sha256=CfUEhkXPFAzIppRSiGyh62j4BYW4vkjIXWEzRcJFD6o,84
36
36
  roboswag/validate/schema.py,sha256=jyD44GcYU_JQLw5hb1wK-DwxOsbJ-FstoNHwIVVMqoo,711
37
37
  roboswag/validate/text_response.py,sha256=P7WEC6ot1OG3YDEXRtmOwIFwki8jgq8fMb-L77X4vIo,527
38
- robotframework_openapitools-0.2.2.dist-info/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
39
- robotframework_openapitools-0.2.2.dist-info/METADATA,sha256=9b-sj3qOnu_xXjxDj5Ad-9Vp5RIIBvd-fav5IVCqk6I,1610
40
- robotframework_openapitools-0.2.2.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
41
- robotframework_openapitools-0.2.2.dist-info/RECORD,,
38
+ robotframework_openapitools-0.2.3.dist-info/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
39
+ robotframework_openapitools-0.2.3.dist-info/METADATA,sha256=3IFT878_SbvVMz0mQ0hV8ETJOlOKg9Qxxrfg-dBDALo,1610
40
+ robotframework_openapitools-0.2.3.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
41
+ robotframework_openapitools-0.2.3.dist-info/RECORD,,