robotframework-openapitools 0.2.2__py3-none-any.whl → 0.3.0__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.
- OpenApiDriver/openapi_executors.py +5 -5
- OpenApiDriver/openapidriver.libspec +103 -50
- OpenApiDriver/openapidriver.py +1 -1
- OpenApiLibCore/openapi_libcore.libspec +372 -86
- OpenApiLibCore/openapi_libcore.py +100 -5
- {robotframework_openapitools-0.2.2.dist-info → robotframework_openapitools-0.3.0.dist-info}/METADATA +1 -1
- {robotframework_openapitools-0.2.2.dist-info → robotframework_openapitools-0.3.0.dist-info}/RECORD +9 -9
- {robotframework_openapitools-0.2.2.dist-info → robotframework_openapitools-0.3.0.dist-info}/LICENSE +0 -0
- {robotframework_openapitools-0.2.2.dist-info → robotframework_openapitools-0.3.0.dist-info}/WHEEL +0 -0
|
@@ -1,100 +1,157 @@
|
|
|
1
1
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
2
|
-
<keywordspec name="OpenApiLibCore" type="LIBRARY" format="HTML" scope="SUITE" generated="2024-
|
|
3
|
-
<version>0.
|
|
2
|
+
<keywordspec name="OpenApiLibCore" type="LIBRARY" format="HTML" scope="SUITE" generated="2024-08-09T12:54:30+00:00" specversion="6" source="/workspaces/robotframework-openapitools/src/OpenApiLibCore/openapi_libcore.py" lineno="431">
|
|
3
|
+
<version>0.3.0</version>
|
|
4
4
|
<doc><p>Main class providing the keywords and core logic to interact with an OpenAPI server.</p>
|
|
5
5
|
<p>Visit the <a href="https://github.com/MarketSquare/robotframework-openapi-libcore">library page</a> for an introduction.</p></doc>
|
|
6
6
|
<tags>
|
|
7
7
|
</tags>
|
|
8
8
|
<inits>
|
|
9
|
-
<init name="__init__" lineno="
|
|
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">
|
|
9
|
+
<init name="__init__" lineno="439">
|
|
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">
|
|
11
11
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="source: str">
|
|
12
12
|
<name>source</name>
|
|
13
|
-
<type name="str" typedoc="string"
|
|
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"
|
|
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"
|
|
22
|
+
<type name="str" typedoc="string"/>
|
|
23
23
|
<default/>
|
|
24
24
|
</arg>
|
|
25
|
+
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="response_validation: ValidationLevel = WARN">
|
|
26
|
+
<name>response_validation</name>
|
|
27
|
+
<type name="ValidationLevel" typedoc="ValidationLevel"/>
|
|
28
|
+
<default>WARN</default>
|
|
29
|
+
</arg>
|
|
30
|
+
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="disable_server_validation: bool = True">
|
|
31
|
+
<name>disable_server_validation</name>
|
|
32
|
+
<type name="bool" typedoc="boolean"/>
|
|
33
|
+
<default>True</default>
|
|
34
|
+
</arg>
|
|
25
35
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="mappings_path: str | Path = ">
|
|
26
36
|
<name>mappings_path</name>
|
|
27
|
-
<type name="Union" union="true">
|
|
37
|
+
<type name="Union" union="true">
|
|
38
|
+
<type name="str" typedoc="string"/>
|
|
39
|
+
<type name="Path" typedoc="Path"/>
|
|
40
|
+
</type>
|
|
28
41
|
<default/>
|
|
29
42
|
</arg>
|
|
30
43
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="invalid_property_default_response: int = 422">
|
|
31
44
|
<name>invalid_property_default_response</name>
|
|
32
|
-
<type name="int" typedoc="integer"
|
|
45
|
+
<type name="int" typedoc="integer"/>
|
|
33
46
|
<default>422</default>
|
|
34
47
|
</arg>
|
|
35
48
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="default_id_property_name: str = id">
|
|
36
49
|
<name>default_id_property_name</name>
|
|
37
|
-
<type name="str" typedoc="string"
|
|
50
|
+
<type name="str" typedoc="string"/>
|
|
38
51
|
<default>id</default>
|
|
39
52
|
</arg>
|
|
40
53
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="faker_locale: str | List[str] | None = None">
|
|
41
54
|
<name>faker_locale</name>
|
|
42
|
-
<type name="Union" union="true">
|
|
55
|
+
<type name="Union" union="true">
|
|
56
|
+
<type name="str" typedoc="string"/>
|
|
57
|
+
<type name="List" typedoc="list">
|
|
58
|
+
<type name="str" typedoc="string"/>
|
|
59
|
+
</type>
|
|
60
|
+
<type name="None" typedoc="None"/>
|
|
61
|
+
</type>
|
|
43
62
|
<default>None</default>
|
|
44
63
|
</arg>
|
|
64
|
+
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="require_body_for_invalid_url: bool = False">
|
|
65
|
+
<name>require_body_for_invalid_url</name>
|
|
66
|
+
<type name="bool" typedoc="boolean"/>
|
|
67
|
+
<default>False</default>
|
|
68
|
+
</arg>
|
|
45
69
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="recursion_limit: int = 1">
|
|
46
70
|
<name>recursion_limit</name>
|
|
47
|
-
<type name="int" typedoc="integer"
|
|
71
|
+
<type name="int" typedoc="integer"/>
|
|
48
72
|
<default>1</default>
|
|
49
73
|
</arg>
|
|
50
74
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="recursion_default: Any = {}">
|
|
51
75
|
<name>recursion_default</name>
|
|
52
|
-
<type name="Any" typedoc="Any"
|
|
76
|
+
<type name="Any" typedoc="Any"/>
|
|
53
77
|
<default>{}</default>
|
|
54
78
|
</arg>
|
|
55
79
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="username: str = ">
|
|
56
80
|
<name>username</name>
|
|
57
|
-
<type name="str" typedoc="string"
|
|
81
|
+
<type name="str" typedoc="string"/>
|
|
58
82
|
<default/>
|
|
59
83
|
</arg>
|
|
60
84
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="password: str = ">
|
|
61
85
|
<name>password</name>
|
|
62
|
-
<type name="str" typedoc="string"
|
|
86
|
+
<type name="str" typedoc="string"/>
|
|
63
87
|
<default/>
|
|
64
88
|
</arg>
|
|
65
89
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="security_token: str = ">
|
|
66
90
|
<name>security_token</name>
|
|
67
|
-
<type name="str" typedoc="string"
|
|
91
|
+
<type name="str" typedoc="string"/>
|
|
68
92
|
<default/>
|
|
69
93
|
</arg>
|
|
70
94
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="auth: AuthBase | None = None">
|
|
71
95
|
<name>auth</name>
|
|
72
|
-
<type name="Union" union="true">
|
|
96
|
+
<type name="Union" union="true">
|
|
97
|
+
<type name="AuthBase"/>
|
|
98
|
+
<type name="None" typedoc="None"/>
|
|
99
|
+
</type>
|
|
73
100
|
<default>None</default>
|
|
74
101
|
</arg>
|
|
75
102
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="cert: str | Tuple[str, str] | None = None">
|
|
76
103
|
<name>cert</name>
|
|
77
|
-
<type name="Union" union="true">
|
|
104
|
+
<type name="Union" union="true">
|
|
105
|
+
<type name="str" typedoc="string"/>
|
|
106
|
+
<type name="Tuple" typedoc="tuple">
|
|
107
|
+
<type name="str" typedoc="string"/>
|
|
108
|
+
<type name="str" typedoc="string"/>
|
|
109
|
+
</type>
|
|
110
|
+
<type name="None" typedoc="None"/>
|
|
111
|
+
</type>
|
|
78
112
|
<default>None</default>
|
|
79
113
|
</arg>
|
|
80
114
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="verify_tls: bool | str | None = True">
|
|
81
115
|
<name>verify_tls</name>
|
|
82
|
-
<type name="Union" union="true">
|
|
116
|
+
<type name="Union" union="true">
|
|
117
|
+
<type name="bool" typedoc="boolean"/>
|
|
118
|
+
<type name="str" typedoc="string"/>
|
|
119
|
+
<type name="None" typedoc="None"/>
|
|
120
|
+
</type>
|
|
83
121
|
<default>True</default>
|
|
84
122
|
</arg>
|
|
85
123
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="extra_headers: Dict[str, str] | None = None">
|
|
86
124
|
<name>extra_headers</name>
|
|
87
|
-
<type name="Union" union="true">
|
|
125
|
+
<type name="Union" union="true">
|
|
126
|
+
<type name="Dict" typedoc="dictionary">
|
|
127
|
+
<type name="str" typedoc="string"/>
|
|
128
|
+
<type name="str" typedoc="string"/>
|
|
129
|
+
</type>
|
|
130
|
+
<type name="None" typedoc="None"/>
|
|
131
|
+
</type>
|
|
88
132
|
<default>None</default>
|
|
89
133
|
</arg>
|
|
90
134
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="cookies: Dict[str, str] | RequestsCookieJar | None = None">
|
|
91
135
|
<name>cookies</name>
|
|
92
|
-
<type name="Union" union="true">
|
|
136
|
+
<type name="Union" union="true">
|
|
137
|
+
<type name="Dict" typedoc="dictionary">
|
|
138
|
+
<type name="str" typedoc="string"/>
|
|
139
|
+
<type name="str" typedoc="string"/>
|
|
140
|
+
</type>
|
|
141
|
+
<type name="RequestsCookieJar" typedoc="dictionary"/>
|
|
142
|
+
<type name="None" typedoc="None"/>
|
|
143
|
+
</type>
|
|
93
144
|
<default>None</default>
|
|
94
145
|
</arg>
|
|
95
146
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="proxies: Dict[str, str] | None = None">
|
|
96
147
|
<name>proxies</name>
|
|
97
|
-
<type name="Union" union="true">
|
|
148
|
+
<type name="Union" union="true">
|
|
149
|
+
<type name="Dict" typedoc="dictionary">
|
|
150
|
+
<type name="str" typedoc="string"/>
|
|
151
|
+
<type name="str" typedoc="string"/>
|
|
152
|
+
</type>
|
|
153
|
+
<type name="None" typedoc="None"/>
|
|
154
|
+
</type>
|
|
98
155
|
<default>None</default>
|
|
99
156
|
</arg>
|
|
100
157
|
</arguments>
|
|
@@ -105,6 +162,17 @@
|
|
|
105
162
|
<p>The server (and port) of the target server. E.g. <code>https://localhost:8000</code></p>
|
|
106
163
|
<h4>base_path</h4>
|
|
107
164
|
<p>The routing between <code>origin</code> and the endpoints as found in the <code>paths</code> section in the openapi document. E.g. <code>/petshop/v2</code>.</p>
|
|
165
|
+
<h3>Test case execution</h3>
|
|
166
|
+
<h4>response_validation</h4>
|
|
167
|
+
<p>By default, a <code>WARN</code> 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:</p>
|
|
168
|
+
<ul>
|
|
169
|
+
<li><code>DISABLED</code>: All Response validation errors will be ignored</li>
|
|
170
|
+
<li><code>INFO</code>: Any Response validation erros will be logged at <code>INFO</code> level</li>
|
|
171
|
+
<li><code>WARN</code>: Any Response validation erros will be logged at <code>WARN</code> level</li>
|
|
172
|
+
<li><code>STRICT</code>: The Test Case will fail on any Response validation errors</li>
|
|
173
|
+
</ul>
|
|
174
|
+
<h4>disable_server_validation</h4>
|
|
175
|
+
<p>If enabled by setting this parameter to <code>True</code>, the Response validation will also include possible errors for Requests made to a server address that is not defined in the list of servers in the openapi document. This generally means that if there is a mismatch, every Test Case will raise this error. Note that <code>localhost</code> and <code>127.0.0.1</code> are not considered the same by Response validation.</p>
|
|
108
176
|
<h3>API-specific configurations</h3>
|
|
109
177
|
<h4>mappings_path</h4>
|
|
110
178
|
<p>See <a href="https://marketsquare.github.io/robotframework-openapi-libcore/advanced_use.html">this page</a> for an in-depth explanation.</p>
|
|
@@ -115,6 +183,8 @@
|
|
|
115
183
|
<p>If different property names are used for the unique identifier for different types of resources, an <code>ID_MAPPING</code> can be implemented using the <code>mappings_path</code>.</p>
|
|
116
184
|
<h4>faker_locale</h4>
|
|
117
185
|
<p>A locale string or list of locale strings to pass to the Faker library to be used in generation of string data for supported format types.</p>
|
|
186
|
+
<h4>require_body_for_invalid_url</h4>
|
|
187
|
+
<p>When a request is made against an invalid url, this usually is because of a "404" request; a request for a resource that does not exist. Depending on API implementation, when a request with a missing or invalid request body is made on a non-existent resource, either a 404 or a 422 or 400 Response is normally returned. If the API being tested processes the request body before checking if the requested resource exists, set this parameter to True.</p>
|
|
118
188
|
<h3>Parsing parameters</h3>
|
|
119
189
|
<h4>recursion_limit</h4>
|
|
120
190
|
<p>The recursion depth to which to fully parse recursive references before the <span class="name">recursion_default</span> is used to end the recursion.</p>
|
|
@@ -144,266 +214,446 @@
|
|
|
144
214
|
</init>
|
|
145
215
|
</inits>
|
|
146
216
|
<keywords>
|
|
147
|
-
<kw name="Authorized Request" lineno="
|
|
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,
|
|
217
|
+
<kw name="Authorized Request" lineno="1683">
|
|
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">
|
|
149
219
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
|
|
150
220
|
<name>url</name>
|
|
151
|
-
<type name="str" typedoc="string"
|
|
221
|
+
<type name="str" typedoc="string"/>
|
|
152
222
|
</arg>
|
|
153
223
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
|
|
154
224
|
<name>method</name>
|
|
155
|
-
<type name="str" typedoc="string"
|
|
225
|
+
<type name="str" typedoc="string"/>
|
|
156
226
|
</arg>
|
|
157
227
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="params: Dict[str, Any] | None = None">
|
|
158
228
|
<name>params</name>
|
|
159
|
-
<type name="Union" union="true">
|
|
229
|
+
<type name="Union" union="true">
|
|
230
|
+
<type name="Dict" typedoc="dictionary">
|
|
231
|
+
<type name="str" typedoc="string"/>
|
|
232
|
+
<type name="Any" typedoc="Any"/>
|
|
233
|
+
</type>
|
|
234
|
+
<type name="None" typedoc="None"/>
|
|
235
|
+
</type>
|
|
160
236
|
<default>None</default>
|
|
161
237
|
</arg>
|
|
162
238
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="headers: Dict[str, str] | None = None">
|
|
163
239
|
<name>headers</name>
|
|
164
|
-
<type name="Union" union="true">
|
|
240
|
+
<type name="Union" union="true">
|
|
241
|
+
<type name="Dict" typedoc="dictionary">
|
|
242
|
+
<type name="str" typedoc="string"/>
|
|
243
|
+
<type name="str" typedoc="string"/>
|
|
244
|
+
</type>
|
|
245
|
+
<type name="None" typedoc="None"/>
|
|
246
|
+
</type>
|
|
165
247
|
<default>None</default>
|
|
166
248
|
</arg>
|
|
167
|
-
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="json_data: Dict[str, Dict[str,
|
|
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">
|
|
168
250
|
<name>json_data</name>
|
|
169
|
-
<type name="Union" union="true">
|
|
251
|
+
<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">
|
|
256
|
+
<type name="str" typedoc="string"/>
|
|
257
|
+
<type name="JSON"/>
|
|
258
|
+
</type>
|
|
259
|
+
<type name="List" typedoc="list">
|
|
260
|
+
<type name="JSON"/>
|
|
261
|
+
</type>
|
|
262
|
+
<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"/>
|
|
286
|
+
<type name="int" typedoc="integer"/>
|
|
287
|
+
<type name="float" typedoc="float"/>
|
|
288
|
+
<type name="bool" typedoc="boolean"/>
|
|
289
|
+
<type name="None" typedoc="None"/>
|
|
290
|
+
</type>
|
|
291
|
+
<default>None</default>
|
|
292
|
+
</arg>
|
|
293
|
+
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="data: Any = None">
|
|
294
|
+
<name>data</name>
|
|
295
|
+
<type name="Any" typedoc="Any"/>
|
|
296
|
+
<default>None</default>
|
|
297
|
+
</arg>
|
|
298
|
+
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="files: Any = None">
|
|
299
|
+
<name>files</name>
|
|
300
|
+
<type name="Any" typedoc="Any"/>
|
|
170
301
|
<default>None</default>
|
|
171
302
|
</arg>
|
|
172
303
|
</arguments>
|
|
304
|
+
<returntype name="Response"/>
|
|
173
305
|
<doc><p>Perform a request using the security token or authentication set in the library.</p>
|
|
306
|
+
<p><span class="name">json_data</span>, <span class="name">data</span> and <span class="name">files</span> are passed to <span class="name">requests.request</span>s <span class="name">json</span>, <span class="name">data</span> and <span class="name">files</span> parameters unaltered. See the requests documentation for details: <a href="https://requests.readthedocs.io/en/latest/api/#requests.request">https://requests.readthedocs.io/en/latest/api/#requests.request</a></p>
|
|
174
307
|
<p>&gt; Note: provided username / password or auth objects take precedence over token based security</p></doc>
|
|
175
308
|
<shortdoc>Perform a request using the security token or authentication set in the library.</shortdoc>
|
|
176
309
|
</kw>
|
|
177
|
-
<kw name="Ensure In Use" lineno="
|
|
310
|
+
<kw name="Ensure In Use" lineno="1587">
|
|
178
311
|
<arguments repr="url: str, resource_relation: IdReference">
|
|
179
312
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
|
|
180
313
|
<name>url</name>
|
|
181
|
-
<type name="str" typedoc="string"
|
|
314
|
+
<type name="str" typedoc="string"/>
|
|
182
315
|
</arg>
|
|
183
316
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="resource_relation: IdReference">
|
|
184
317
|
<name>resource_relation</name>
|
|
185
|
-
<type name="IdReference"
|
|
318
|
+
<type name="IdReference"/>
|
|
186
319
|
</arg>
|
|
187
320
|
</arguments>
|
|
188
321
|
<doc><p>Ensure that the (right-most) <span class="name">id</span> of the resource referenced by the <span class="name">url</span> is used by the resource defined by the <span class="name">resource_relation</span>.</p></doc>
|
|
189
322
|
<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>
|
|
190
323
|
</kw>
|
|
191
|
-
<kw name="Get Ids From Url" lineno="
|
|
324
|
+
<kw name="Get Ids From Url" lineno="958">
|
|
192
325
|
<arguments repr="url: str">
|
|
193
326
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
|
|
194
327
|
<name>url</name>
|
|
195
|
-
<type name="str" typedoc="string"
|
|
328
|
+
<type name="str" typedoc="string"/>
|
|
196
329
|
</arg>
|
|
197
330
|
</arguments>
|
|
331
|
+
<returntype name="List" typedoc="list">
|
|
332
|
+
<type name="str" typedoc="string"/>
|
|
333
|
+
</returntype>
|
|
198
334
|
<doc><p>Perform a GET request on the <span class="name">url</span> and return the list of resource <span class="name">ids</span> from the response.</p></doc>
|
|
199
335
|
<shortdoc>Perform a GET request on the `url` and return the list of resource `ids` from the response.</shortdoc>
|
|
200
336
|
</kw>
|
|
201
|
-
<kw name="Get Invalid Json Data" lineno="
|
|
337
|
+
<kw name="Get Invalid Json Data" lineno="1364">
|
|
202
338
|
<arguments repr="url: str, method: str, status_code: int, request_data: RequestData">
|
|
203
339
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
|
|
204
340
|
<name>url</name>
|
|
205
|
-
<type name="str" typedoc="string"
|
|
341
|
+
<type name="str" typedoc="string"/>
|
|
206
342
|
</arg>
|
|
207
343
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
|
|
208
344
|
<name>method</name>
|
|
209
|
-
<type name="str" typedoc="string"
|
|
345
|
+
<type name="str" typedoc="string"/>
|
|
210
346
|
</arg>
|
|
211
347
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="status_code: int">
|
|
212
348
|
<name>status_code</name>
|
|
213
|
-
<type name="int" typedoc="integer"
|
|
349
|
+
<type name="int" typedoc="integer"/>
|
|
214
350
|
</arg>
|
|
215
351
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="request_data: RequestData">
|
|
216
352
|
<name>request_data</name>
|
|
217
|
-
<type name="RequestData"
|
|
353
|
+
<type name="RequestData"/>
|
|
218
354
|
</arg>
|
|
219
355
|
</arguments>
|
|
356
|
+
<returntype name="Dict" typedoc="dictionary">
|
|
357
|
+
<type name="str" typedoc="string"/>
|
|
358
|
+
<type name="Any" typedoc="Any"/>
|
|
359
|
+
</returntype>
|
|
220
360
|
<doc><p>Return <span class="name">json_data</span> based on the <span class="name">dto</span> on the <span class="name">request_data</span> that will cause the provided <span class="name">status_code</span> for the <span class="name">method</span> operation on the <span class="name">url</span>.</p>
|
|
221
361
|
<p>&gt; Note: applicable UniquePropertyValueConstraint and IdReference Relations are considered before changes to <span class="name">json_data</span> are made.</p></doc>
|
|
222
362
|
<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>
|
|
223
363
|
</kw>
|
|
224
|
-
<kw name="Get Invalidated Parameters" lineno="
|
|
364
|
+
<kw name="Get Invalidated Parameters" lineno="1412">
|
|
225
365
|
<arguments repr="status_code: int, request_data: RequestData">
|
|
226
366
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="status_code: int">
|
|
227
367
|
<name>status_code</name>
|
|
228
|
-
<type name="int" typedoc="integer"
|
|
368
|
+
<type name="int" typedoc="integer"/>
|
|
229
369
|
</arg>
|
|
230
370
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="request_data: RequestData">
|
|
231
371
|
<name>request_data</name>
|
|
232
|
-
<type name="RequestData"
|
|
372
|
+
<type name="RequestData"/>
|
|
233
373
|
</arg>
|
|
234
374
|
</arguments>
|
|
375
|
+
<returntype name="Tuple" typedoc="tuple">
|
|
376
|
+
<type name="Dict" typedoc="dictionary">
|
|
377
|
+
<type name="str" typedoc="string"/>
|
|
378
|
+
<type name="Any" typedoc="Any"/>
|
|
379
|
+
</type>
|
|
380
|
+
<type name="Dict" typedoc="dictionary">
|
|
381
|
+
<type name="str" typedoc="string"/>
|
|
382
|
+
<type name="str" typedoc="string"/>
|
|
383
|
+
</type>
|
|
384
|
+
</returntype>
|
|
235
385
|
<doc><p>Returns a version of <span class="name">params, headers</span> as present on <span class="name">request_data</span> that has been modified to cause the provided <span class="name">status_code</span>.</p></doc>
|
|
236
386
|
<shortdoc>Returns a version of `params, headers` as present on `request_data` that has been modified to cause the provided `status_code`.</shortdoc>
|
|
237
387
|
</kw>
|
|
238
|
-
<kw name="Get Invalidated Url" lineno="
|
|
388
|
+
<kw name="Get Invalidated Url" lineno="1330">
|
|
239
389
|
<arguments repr="valid_url: str">
|
|
240
390
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="valid_url: str">
|
|
241
391
|
<name>valid_url</name>
|
|
242
|
-
<type name="str" typedoc="string"
|
|
392
|
+
<type name="str" typedoc="string"/>
|
|
243
393
|
</arg>
|
|
244
394
|
</arguments>
|
|
395
|
+
<returntype name="Union" union="true">
|
|
396
|
+
<type name="str" typedoc="string"/>
|
|
397
|
+
<type name="None" typedoc="None"/>
|
|
398
|
+
</returntype>
|
|
245
399
|
<doc><p>Return an url with all the path parameters in the <span class="name">valid_url</span> replaced by a random UUID.</p>
|
|
246
400
|
<p>Raises ValueError if the valid_url cannot be invalidated.</p></doc>
|
|
247
401
|
<shortdoc>Return an url with all the path parameters in the `valid_url` replaced by a random UUID.</shortdoc>
|
|
248
402
|
</kw>
|
|
249
|
-
<kw name="Get Json Data For Dto Class" lineno="
|
|
403
|
+
<kw name="Get Json Data For Dto Class" lineno="1206">
|
|
250
404
|
<arguments repr="schema: Dict[str, Any], dto_class: Dto | Type[Dto], operation_id: str = ">
|
|
251
405
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="schema: Dict[str, Any]">
|
|
252
406
|
<name>schema</name>
|
|
253
|
-
<type name="Dict" typedoc="dictionary">
|
|
407
|
+
<type name="Dict" typedoc="dictionary">
|
|
408
|
+
<type name="str" typedoc="string"/>
|
|
409
|
+
<type name="Any" typedoc="Any"/>
|
|
410
|
+
</type>
|
|
254
411
|
</arg>
|
|
255
412
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="dto_class: Dto | Type[Dto]">
|
|
256
413
|
<name>dto_class</name>
|
|
257
|
-
<type name="Union" union="true">
|
|
414
|
+
<type name="Union" union="true">
|
|
415
|
+
<type name="Dto"/>
|
|
416
|
+
<type name="Type">
|
|
417
|
+
<type name="Dto"/>
|
|
418
|
+
</type>
|
|
419
|
+
</type>
|
|
258
420
|
</arg>
|
|
259
421
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="operation_id: str = ">
|
|
260
422
|
<name>operation_id</name>
|
|
261
|
-
<type name="str" typedoc="string"
|
|
423
|
+
<type name="str" typedoc="string"/>
|
|
262
424
|
<default/>
|
|
263
425
|
</arg>
|
|
264
426
|
</arguments>
|
|
427
|
+
<returntype name="Union" union="true">
|
|
428
|
+
<type name="Dict" typedoc="dictionary">
|
|
429
|
+
<type name="str" typedoc="string"/>
|
|
430
|
+
<type name="Any" typedoc="Any"/>
|
|
431
|
+
</type>
|
|
432
|
+
<type name="None" typedoc="None"/>
|
|
433
|
+
</returntype>
|
|
265
434
|
<doc><p>Generate a valid (json-compatible) dict for all the <span class="name">dto_class</span> properties.</p></doc>
|
|
266
435
|
<shortdoc>Generate a valid (json-compatible) dict for all the `dto_class` properties.</shortdoc>
|
|
267
436
|
</kw>
|
|
268
|
-
<kw name="Get Json Data With Conflict" lineno="
|
|
437
|
+
<kw name="Get Json Data With Conflict" lineno="1631">
|
|
269
438
|
<arguments repr="url: str, method: str, dto: Dto, conflict_status_code: int">
|
|
270
439
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
|
|
271
440
|
<name>url</name>
|
|
272
|
-
<type name="str" typedoc="string"
|
|
441
|
+
<type name="str" typedoc="string"/>
|
|
273
442
|
</arg>
|
|
274
443
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
|
|
275
444
|
<name>method</name>
|
|
276
|
-
<type name="str" typedoc="string"
|
|
445
|
+
<type name="str" typedoc="string"/>
|
|
277
446
|
</arg>
|
|
278
447
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="dto: Dto">
|
|
279
448
|
<name>dto</name>
|
|
280
|
-
<type name="Dto"
|
|
449
|
+
<type name="Dto"/>
|
|
281
450
|
</arg>
|
|
282
451
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="conflict_status_code: int">
|
|
283
452
|
<name>conflict_status_code</name>
|
|
284
|
-
<type name="int" typedoc="integer"
|
|
453
|
+
<type name="int" typedoc="integer"/>
|
|
285
454
|
</arg>
|
|
286
455
|
</arguments>
|
|
456
|
+
<returntype name="Dict" typedoc="dictionary">
|
|
457
|
+
<type name="str" typedoc="string"/>
|
|
458
|
+
<type name="Any" typedoc="Any"/>
|
|
459
|
+
</returntype>
|
|
287
460
|
<doc><p>Return <span class="name">json_data</span> based on the <span class="name">UniquePropertyValueConstraint</span> that must be returned by the <span class="name">get_relations</span> implementation on the <span class="name">dto</span> for the given <span class="name">conflict_status_code</span>.</p></doc>
|
|
288
461
|
<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
462
|
</kw>
|
|
290
|
-
<kw name="Get Parameterized Endpoint From Url" lineno="
|
|
463
|
+
<kw name="Get Parameterized Endpoint From Url" lineno="1352">
|
|
291
464
|
<arguments repr="url: str">
|
|
292
465
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="url: str">
|
|
293
466
|
<name>url</name>
|
|
294
|
-
<type name="str" typedoc="string"
|
|
467
|
+
<type name="str" typedoc="string"/>
|
|
295
468
|
</arg>
|
|
296
469
|
</arguments>
|
|
470
|
+
<returntype name="str" typedoc="string"/>
|
|
297
471
|
<doc><p>Return the endpoint as found in the <span class="name">paths</span> section based on the given <span class="name">url</span>.</p></doc>
|
|
298
472
|
<shortdoc>Return the endpoint as found in the `paths` section based on the given `url`.</shortdoc>
|
|
299
473
|
</kw>
|
|
300
|
-
<kw name="Get Request Data" lineno="
|
|
474
|
+
<kw name="Get Request Data" lineno="998">
|
|
301
475
|
<arguments repr="endpoint: str, method: str">
|
|
302
476
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
|
|
303
477
|
<name>endpoint</name>
|
|
304
|
-
<type name="str" typedoc="string"
|
|
478
|
+
<type name="str" typedoc="string"/>
|
|
305
479
|
</arg>
|
|
306
480
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
|
|
307
481
|
<name>method</name>
|
|
308
|
-
<type name="str" typedoc="string"
|
|
482
|
+
<type name="str" typedoc="string"/>
|
|
309
483
|
</arg>
|
|
310
484
|
</arguments>
|
|
485
|
+
<returntype name="RequestData"/>
|
|
311
486
|
<doc><p>Return an object with valid request data for body, headers and query params.</p></doc>
|
|
312
487
|
<shortdoc>Return an object with valid request data for body, headers and query params.</shortdoc>
|
|
313
488
|
</kw>
|
|
314
|
-
<kw name="Get Valid Id For Endpoint" lineno="
|
|
489
|
+
<kw name="Get Valid Id For Endpoint" lineno="862">
|
|
315
490
|
<arguments repr="endpoint: str, method: str">
|
|
316
491
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
|
|
317
492
|
<name>endpoint</name>
|
|
318
|
-
<type name="str" typedoc="string"
|
|
493
|
+
<type name="str" typedoc="string"/>
|
|
319
494
|
</arg>
|
|
320
495
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
|
|
321
496
|
<name>method</name>
|
|
322
|
-
<type name="str" typedoc="string"
|
|
497
|
+
<type name="str" typedoc="string"/>
|
|
323
498
|
</arg>
|
|
324
499
|
</arguments>
|
|
500
|
+
<returntype name="Union" union="true">
|
|
501
|
+
<type name="str" typedoc="string"/>
|
|
502
|
+
<type name="int" typedoc="integer"/>
|
|
503
|
+
<type name="float" typedoc="float"/>
|
|
504
|
+
</returntype>
|
|
325
505
|
<doc><p>Support keyword that returns the <span class="name">id</span> for an existing resource at <span class="name">endpoint</span>.</p>
|
|
326
506
|
<p>To prevent resource conflicts with other test cases, a new resource is created (POST) if possible.</p></doc>
|
|
327
507
|
<shortdoc>Support keyword that returns the `id` for an existing resource at `endpoint`.</shortdoc>
|
|
328
508
|
</kw>
|
|
329
|
-
<kw name="Get Valid Url" lineno="
|
|
509
|
+
<kw name="Get Valid Url" lineno="822">
|
|
330
510
|
<arguments repr="endpoint: str, method: str">
|
|
331
511
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="endpoint: str">
|
|
332
512
|
<name>endpoint</name>
|
|
333
|
-
<type name="str" typedoc="string"
|
|
513
|
+
<type name="str" typedoc="string"/>
|
|
334
514
|
</arg>
|
|
335
515
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="method: str">
|
|
336
516
|
<name>method</name>
|
|
337
|
-
<type name="str" typedoc="string"
|
|
517
|
+
<type name="str" typedoc="string"/>
|
|
338
518
|
</arg>
|
|
339
519
|
</arguments>
|
|
520
|
+
<returntype name="str" typedoc="string"/>
|
|
340
521
|
<doc><p>This keyword returns a valid url for the given <span class="name">endpoint</span> and <span class="name">method</span>.</p>
|
|
341
522
|
<p>If the <span class="name">endpoint</span> contains path parameters the Get Valid Id For Endpoint keyword will be executed to retrieve valid ids for the path parameters.</p>
|
|
342
523
|
<p>&gt; Note: if valid ids cannot be retrieved within the scope of the API, the <span class="name">PathPropertiesConstraint</span> Relation can be used. More information can be found <a href="https://marketsquare.github.io/robotframework-openapi-libcore/advanced_use.html">here</a>.</p></doc>
|
|
343
524
|
<shortdoc>This keyword returns a valid url for the given `endpoint` and `method`.</shortdoc>
|
|
344
525
|
</kw>
|
|
345
|
-
<kw name="Perform Validated Request" lineno="
|
|
526
|
+
<kw name="Perform Validated Request" lineno="1730">
|
|
346
527
|
<arguments repr="path: str, status_code: int, request_values: RequestValues, original_data: Dict[str, Any] | None = None">
|
|
347
528
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
|
|
348
529
|
<name>path</name>
|
|
349
|
-
<type name="str" typedoc="string"
|
|
530
|
+
<type name="str" typedoc="string"/>
|
|
350
531
|
</arg>
|
|
351
532
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="status_code: int">
|
|
352
533
|
<name>status_code</name>
|
|
353
|
-
<type name="int" typedoc="integer"
|
|
534
|
+
<type name="int" typedoc="integer"/>
|
|
354
535
|
</arg>
|
|
355
536
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="request_values: RequestValues">
|
|
356
537
|
<name>request_values</name>
|
|
357
|
-
<type name="RequestValues"
|
|
538
|
+
<type name="RequestValues"/>
|
|
358
539
|
</arg>
|
|
359
540
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="original_data: Dict[str, Any] | None = None">
|
|
360
541
|
<name>original_data</name>
|
|
361
|
-
<type name="Union" union="true">
|
|
542
|
+
<type name="Union" union="true">
|
|
543
|
+
<type name="Dict" typedoc="dictionary">
|
|
544
|
+
<type name="str" typedoc="string"/>
|
|
545
|
+
<type name="Any" typedoc="Any"/>
|
|
546
|
+
</type>
|
|
547
|
+
<type name="None" typedoc="None"/>
|
|
548
|
+
</type>
|
|
362
549
|
<default>None</default>
|
|
363
550
|
</arg>
|
|
364
551
|
</arguments>
|
|
365
552
|
<doc><p>This keyword first calls the Authorized Request keyword, then the Validate Response keyword and finally validates, for <span class="name">DELETE</span> operations, whether the target resource was indeed deleted (OK response) or not (error responses).</p></doc>
|
|
366
553
|
<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>
|
|
367
554
|
</kw>
|
|
368
|
-
<kw name="Set
|
|
555
|
+
<kw name="Set Auth" lineno="677">
|
|
556
|
+
<arguments repr="auth: AuthBase">
|
|
557
|
+
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="auth: AuthBase">
|
|
558
|
+
<name>auth</name>
|
|
559
|
+
<type name="AuthBase"/>
|
|
560
|
+
</arg>
|
|
561
|
+
</arguments>
|
|
562
|
+
<doc><p>Set the <span class="name">auth</span> used for authentication after the library is imported.</p>
|
|
563
|
+
<p>After calling this keyword, subsequent requests will use the provided <span class="name">auth</span> instance.</p></doc>
|
|
564
|
+
<shortdoc>Set the `auth` used for authentication after the library is imported.</shortdoc>
|
|
565
|
+
</kw>
|
|
566
|
+
<kw name="Set Basic Auth" lineno="665">
|
|
567
|
+
<arguments repr="username: str, password: str">
|
|
568
|
+
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="username: str">
|
|
569
|
+
<name>username</name>
|
|
570
|
+
<type name="str" typedoc="string"/>
|
|
571
|
+
</arg>
|
|
572
|
+
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="password: str">
|
|
573
|
+
<name>password</name>
|
|
574
|
+
<type name="str" typedoc="string"/>
|
|
575
|
+
</arg>
|
|
576
|
+
</arguments>
|
|
577
|
+
<doc><p>Set the <span class="name">username</span> and <span class="name">password</span> used for basic authentication after the library is imported.</p>
|
|
578
|
+
<p>After calling this keyword, subsequent requests will use the provided credentials.</p></doc>
|
|
579
|
+
<shortdoc>Set the `username` and `password` used for basic authentication after the library is imported.</shortdoc>
|
|
580
|
+
</kw>
|
|
581
|
+
<kw name="Set Extra Headers" lineno="687">
|
|
582
|
+
<arguments repr="extra_headers: Dict[str, str]">
|
|
583
|
+
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="extra_headers: Dict[str, str]">
|
|
584
|
+
<name>extra_headers</name>
|
|
585
|
+
<type name="Dict" typedoc="dictionary">
|
|
586
|
+
<type name="str" typedoc="string"/>
|
|
587
|
+
<type name="str" typedoc="string"/>
|
|
588
|
+
</type>
|
|
589
|
+
</arg>
|
|
590
|
+
</arguments>
|
|
591
|
+
<doc><p>Set the <span class="name">extra_headers</span> used in requests after the library is imported.</p>
|
|
592
|
+
<p>After calling this keyword, subsequent requests will use the provided <span class="name">extra_headers</span>.</p></doc>
|
|
593
|
+
<shortdoc>Set the `extra_headers` used in requests after the library is imported.</shortdoc>
|
|
594
|
+
</kw>
|
|
595
|
+
<kw name="Set Origin" lineno="642">
|
|
369
596
|
<arguments repr="origin: str">
|
|
370
597
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="origin: str">
|
|
371
598
|
<name>origin</name>
|
|
372
|
-
<type name="str" typedoc="string"
|
|
599
|
+
<type name="str" typedoc="string"/>
|
|
373
600
|
</arg>
|
|
374
601
|
</arguments>
|
|
375
|
-
<doc><p>
|
|
602
|
+
<doc><p>Set the <span class="name">origin</span> after the library is imported.</p>
|
|
376
603
|
<p>This can be done during the <span class="name">Suite setup</span> when using DataDriver in situations where the OpenAPI document is available on disk but the target host address is not known before the test starts.</p>
|
|
377
604
|
<p>In combination with OpenApiLibCore, the <span class="name">origin</span> can be used at any point to target another server that hosts an API that complies to the same OAS.</p></doc>
|
|
378
|
-
<shortdoc>
|
|
605
|
+
<shortdoc>Set the `origin` after the library is imported.</shortdoc>
|
|
379
606
|
</kw>
|
|
380
|
-
<kw name="
|
|
607
|
+
<kw name="Set Security Token" lineno="656">
|
|
608
|
+
<arguments repr="security_token: str">
|
|
609
|
+
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="security_token: str">
|
|
610
|
+
<name>security_token</name>
|
|
611
|
+
<type name="str" typedoc="string"/>
|
|
612
|
+
</arg>
|
|
613
|
+
</arguments>
|
|
614
|
+
<doc><p>Set the <span class="name">security_token</span> after the library is imported.</p>
|
|
615
|
+
<p>After calling this keyword, subsequent requests will use the provided token.</p></doc>
|
|
616
|
+
<shortdoc>Set the `security_token` after the library is imported.</shortdoc>
|
|
617
|
+
</kw>
|
|
618
|
+
<kw name="Validate Resource Properties" lineno="1966">
|
|
381
619
|
<arguments repr="resource: Dict[str, Any], schema: Dict[str, Any]">
|
|
382
620
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="resource: Dict[str, Any]">
|
|
383
621
|
<name>resource</name>
|
|
384
|
-
<type name="Dict" typedoc="dictionary">
|
|
622
|
+
<type name="Dict" typedoc="dictionary">
|
|
623
|
+
<type name="str" typedoc="string"/>
|
|
624
|
+
<type name="Any" typedoc="Any"/>
|
|
625
|
+
</type>
|
|
385
626
|
</arg>
|
|
386
627
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="schema: Dict[str, Any]">
|
|
387
628
|
<name>schema</name>
|
|
388
|
-
<type name="Dict" typedoc="dictionary">
|
|
629
|
+
<type name="Dict" typedoc="dictionary">
|
|
630
|
+
<type name="str" typedoc="string"/>
|
|
631
|
+
<type name="Any" typedoc="Any"/>
|
|
632
|
+
</type>
|
|
389
633
|
</arg>
|
|
390
634
|
</arguments>
|
|
391
635
|
<doc><p>Validate that the <span class="name">resource</span> does not contain any properties that are not defined in the <span class="name">schema_properties</span>.</p></doc>
|
|
392
636
|
<shortdoc>Validate that the `resource` does not contain any properties that are not defined in the `schema_properties`.</shortdoc>
|
|
393
637
|
</kw>
|
|
394
|
-
<kw name="Validate Response" lineno="
|
|
638
|
+
<kw name="Validate Response" lineno="1804">
|
|
395
639
|
<arguments repr="path: str, response: Response, original_data: Dict[str, Any] | None = None">
|
|
396
640
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="path: str">
|
|
397
641
|
<name>path</name>
|
|
398
|
-
<type name="str" typedoc="string"
|
|
642
|
+
<type name="str" typedoc="string"/>
|
|
399
643
|
</arg>
|
|
400
644
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="response: Response">
|
|
401
645
|
<name>response</name>
|
|
402
|
-
<type name="Response"
|
|
646
|
+
<type name="Response"/>
|
|
403
647
|
</arg>
|
|
404
648
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="original_data: Dict[str, Any] | None = None">
|
|
405
649
|
<name>original_data</name>
|
|
406
|
-
<type name="Union" union="true">
|
|
650
|
+
<type name="Union" union="true">
|
|
651
|
+
<type name="Dict" typedoc="dictionary">
|
|
652
|
+
<type name="str" typedoc="string"/>
|
|
653
|
+
<type name="Any" typedoc="Any"/>
|
|
654
|
+
</type>
|
|
655
|
+
<type name="None" typedoc="None"/>
|
|
656
|
+
</type>
|
|
407
657
|
<default>None</default>
|
|
408
658
|
</arg>
|
|
409
659
|
</arguments>
|
|
@@ -418,15 +668,21 @@
|
|
|
418
668
|
</ul></doc>
|
|
419
669
|
<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>
|
|
420
670
|
</kw>
|
|
421
|
-
<kw name="Validate Send Response" lineno="
|
|
671
|
+
<kw name="Validate Send Response" lineno="2084">
|
|
422
672
|
<arguments repr="response: Response, original_data: Dict[str, Any] | None = None">
|
|
423
673
|
<arg kind="POSITIONAL_OR_NAMED" required="true" repr="response: Response">
|
|
424
674
|
<name>response</name>
|
|
425
|
-
<type name="Response"
|
|
675
|
+
<type name="Response"/>
|
|
426
676
|
</arg>
|
|
427
677
|
<arg kind="POSITIONAL_OR_NAMED" required="false" repr="original_data: Dict[str, Any] | None = None">
|
|
428
678
|
<name>original_data</name>
|
|
429
|
-
<type name="Union" union="true">
|
|
679
|
+
<type name="Union" union="true">
|
|
680
|
+
<type name="Dict" typedoc="dictionary">
|
|
681
|
+
<type name="str" typedoc="string"/>
|
|
682
|
+
<type name="Any" typedoc="Any"/>
|
|
683
|
+
</type>
|
|
684
|
+
<type name="None" typedoc="None"/>
|
|
685
|
+
</type>
|
|
430
686
|
<default>None</default>
|
|
431
687
|
</arg>
|
|
432
688
|
</arguments>
|
|
@@ -434,8 +690,6 @@
|
|
|
434
690
|
<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
691
|
</kw>
|
|
436
692
|
</keywords>
|
|
437
|
-
<datatypes>
|
|
438
|
-
</datatypes>
|
|
439
693
|
<typedocs>
|
|
440
694
|
<type name="Any" type="Standard">
|
|
441
695
|
<doc><p>Any value is accepted. No conversion is done.</p></doc>
|
|
@@ -445,7 +699,10 @@
|
|
|
445
699
|
<usages>
|
|
446
700
|
<usage>__init__</usage>
|
|
447
701
|
<usage>Authorized Request</usage>
|
|
702
|
+
<usage>Get Invalid Json Data</usage>
|
|
703
|
+
<usage>Get Invalidated Parameters</usage>
|
|
448
704
|
<usage>Get Json Data For Dto Class</usage>
|
|
705
|
+
<usage>Get Json Data With Conflict</usage>
|
|
449
706
|
<usage>Perform Validated Request</usage>
|
|
450
707
|
<usage>Validate Resource Properties</usage>
|
|
451
708
|
<usage>Validate Response</usage>
|
|
@@ -477,8 +734,12 @@
|
|
|
477
734
|
<usages>
|
|
478
735
|
<usage>__init__</usage>
|
|
479
736
|
<usage>Authorized Request</usage>
|
|
737
|
+
<usage>Get Invalid Json Data</usage>
|
|
738
|
+
<usage>Get Invalidated Parameters</usage>
|
|
480
739
|
<usage>Get Json Data For Dto Class</usage>
|
|
740
|
+
<usage>Get Json Data With Conflict</usage>
|
|
481
741
|
<usage>Perform Validated Request</usage>
|
|
742
|
+
<usage>Set Extra Headers</usage>
|
|
482
743
|
<usage>Validate Resource Properties</usage>
|
|
483
744
|
<usage>Validate Response</usage>
|
|
484
745
|
<usage>Validate Send Response</usage>
|
|
@@ -494,6 +755,7 @@
|
|
|
494
755
|
</accepts>
|
|
495
756
|
<usages>
|
|
496
757
|
<usage>Authorized Request</usage>
|
|
758
|
+
<usage>Get Valid Id For Endpoint</usage>
|
|
497
759
|
</usages>
|
|
498
760
|
</type>
|
|
499
761
|
<type name="integer" type="Standard">
|
|
@@ -511,6 +773,7 @@
|
|
|
511
773
|
<usage>Get Invalid Json Data</usage>
|
|
512
774
|
<usage>Get Invalidated Parameters</usage>
|
|
513
775
|
<usage>Get Json Data With Conflict</usage>
|
|
776
|
+
<usage>Get Valid Id For Endpoint</usage>
|
|
514
777
|
<usage>Perform Validated Request</usage>
|
|
515
778
|
</usages>
|
|
516
779
|
</type>
|
|
@@ -525,6 +788,7 @@
|
|
|
525
788
|
<usages>
|
|
526
789
|
<usage>__init__</usage>
|
|
527
790
|
<usage>Authorized Request</usage>
|
|
791
|
+
<usage>Get Ids From Url</usage>
|
|
528
792
|
</usages>
|
|
529
793
|
</type>
|
|
530
794
|
<type name="None" type="Standard">
|
|
@@ -535,6 +799,8 @@
|
|
|
535
799
|
<usages>
|
|
536
800
|
<usage>__init__</usage>
|
|
537
801
|
<usage>Authorized Request</usage>
|
|
802
|
+
<usage>Get Invalidated Url</usage>
|
|
803
|
+
<usage>Get Json Data For Dto Class</usage>
|
|
538
804
|
<usage>Perform Validated Request</usage>
|
|
539
805
|
<usage>Validate Response</usage>
|
|
540
806
|
<usage>Validate Send Response</usage>
|
|
@@ -562,6 +828,7 @@
|
|
|
562
828
|
<usage>Ensure In Use</usage>
|
|
563
829
|
<usage>Get Ids From Url</usage>
|
|
564
830
|
<usage>Get Invalid Json Data</usage>
|
|
831
|
+
<usage>Get Invalidated Parameters</usage>
|
|
565
832
|
<usage>Get Invalidated Url</usage>
|
|
566
833
|
<usage>Get Json Data For Dto Class</usage>
|
|
567
834
|
<usage>Get Json Data With Conflict</usage>
|
|
@@ -570,7 +837,10 @@
|
|
|
570
837
|
<usage>Get Valid Id For Endpoint</usage>
|
|
571
838
|
<usage>Get Valid Url</usage>
|
|
572
839
|
<usage>Perform Validated Request</usage>
|
|
840
|
+
<usage>Set Basic Auth</usage>
|
|
841
|
+
<usage>Set Extra Headers</usage>
|
|
573
842
|
<usage>Set Origin</usage>
|
|
843
|
+
<usage>Set Security Token</usage>
|
|
574
844
|
<usage>Validate Resource Properties</usage>
|
|
575
845
|
<usage>Validate Response</usage>
|
|
576
846
|
<usage>Validate Send Response</usage>
|
|
@@ -586,7 +856,23 @@
|
|
|
586
856
|
</accepts>
|
|
587
857
|
<usages>
|
|
588
858
|
<usage>__init__</usage>
|
|
859
|
+
<usage>Get Invalidated Parameters</usage>
|
|
860
|
+
</usages>
|
|
861
|
+
</type>
|
|
862
|
+
<type name="ValidationLevel" type="Enum">
|
|
863
|
+
<doc><p>The available levels for the response_validation parameter.</p></doc>
|
|
864
|
+
<accepts>
|
|
865
|
+
<type>string</type>
|
|
866
|
+
</accepts>
|
|
867
|
+
<usages>
|
|
868
|
+
<usage>__init__</usage>
|
|
589
869
|
</usages>
|
|
870
|
+
<members>
|
|
871
|
+
<member name="DISABLED" value="DISABLED"/>
|
|
872
|
+
<member name="INFO" value="INFO"/>
|
|
873
|
+
<member name="WARN" value="WARN"/>
|
|
874
|
+
<member name="STRICT" value="STRICT"/>
|
|
875
|
+
</members>
|
|
590
876
|
</type>
|
|
591
877
|
</typedocs>
|
|
592
878
|
</keywordspec>
|