Skip to content

Commit 7e2256c

Browse files
authored
Merge 8a9e60e into a7d3f00
2 parents a7d3f00 + 8a9e60e commit 7e2256c

File tree

95 files changed

+20204
-16547
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+20204
-16547
lines changed

.github/workflows/deploy-to-dev.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ jobs:
2525
fetch-depth: 0
2626
- uses: actions/setup-node@v1
2727
with:
28-
node-version: 16.x
28+
node-version: 18.x
2929
- name: Install Python
3030
uses: actions/setup-python@v2
3131
with:

.github/workflows/deploy-to-production.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
fetch-depth: 0
2727
- uses: actions/setup-node@v3
2828
with:
29-
node-version: 16.x
29+
node-version: 18.x
3030

3131
- uses: actions/cache@v2
3232
id: cache-npm-packages
@@ -62,7 +62,7 @@ jobs:
6262
fetch-depth: 0
6363
- uses: actions/setup-node@v1
6464
with:
65-
node-version: 16.x
65+
node-version: 18.x
6666
- name: Install Python
6767
uses: actions/setup-python@v2
6868
with:
@@ -110,7 +110,7 @@ jobs:
110110
fetch-depth: 0
111111
- uses: actions/setup-node@v1
112112
with:
113-
node-version: 16.x
113+
node-version: 18.x
114114
- name: Install Python
115115
uses: actions/setup-python@v2
116116
with:

.github/workflows/link-checker.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ jobs:
2121
test:
2222
runs-on: ubuntu-latest
2323
steps:
24-
- uses: actions/checkout@v2
24+
- uses: actions/checkout@v4
2525
with:
2626
fetch-depth: 0
27-
- uses: actions/setup-node@v1
27+
- uses: actions/setup-node@v4
2828
with:
29-
node-version: 16.x
30-
- uses: actions/setup-python@v2
29+
node-version: 18.x
30+
- uses: actions/setup-python@v5
3131
with:
32-
python-version: 3.7
32+
python-version: '3.10'
3333
- name: Build and Run Docusaurus Site
3434
working-directory: ./
3535
run: |

docs/api-testing.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,11 @@ Use the API Testing platform to generate contract tests from an OpenAPI specific
3737
<p>
3838
Create functional tests from multiple locations:
3939
<ul>
40-
<li>
41-
<a href="/api-testing/quickstart">HTTP client</a></li>
42-
<li>
43-
<a href="/api-testing/import-postman-collection">Postman collection (in the HTTP client)</a></li>
44-
<li>
45-
<a href="/api-testing/build-from-spec">OpenAPI spec file</a>
46-
</li>
47-
<li>
48-
<a href="/api-testing/import-har-files/">Import from HAR file (including HAR files from RDC and VDC)</a>
49-
</li>
50-
<li>
51-
<a href="/api-testing/composer">Test composer</a>
52-
</li>
40+
<li><a href="/api-testing/quickstart">HTTP client</a></li>
41+
<li><a href="/api-testing/import-postman-collection">Postman collection (in the HTTP client)</a></li>
42+
<li><a href="/api-testing/build-from-spec">OpenAPI spec file</a></li>
43+
<li><a href="/api-testing/import-har-files/">Import from HAR file (including HAR files from RDC and VDC)</a></li>
44+
<li><a href="/api-testing/composer">Test composer</a></li>
5345
</ul>
5446
</p>
5547
</div>

docs/api-testing/composer/assertion-components.md

Lines changed: 40 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ Assertions are a type of component that you can add to a test using the Composer
2222

2323
Allows you to compare two payloads in terms of text, structure or values.
2424

25-
<details><summary><strong>Parameters</strong></summary>
25+
<details>
26+
<summary><strong>Parameters</strong></summary>
2627

2728
<table id="table-api">
2829
<tbody>
@@ -53,7 +54,8 @@ See also [Common Fields](#assertion-common-fields)
5354
<img src={useBaseUrl('img/api-testing/compares.webp')} alt="Assertion Compares Pic"/>
5455

5556
</details>
56-
<details><summary><strong>Code View Examples</strong></summary>
57+
<details>
58+
<summary><strong>Code View Examples</strong></summary>
5759

5860
```yaml
5961
- id: assert-compares
@@ -85,7 +87,8 @@ See also [Common Fields](#assertion-common-fields)
8587
8688
This assertion is used to check if the element described by the expression contains a specific substring. For example, to test the word _Uber_ is in Uber's product names (_UberX, UberBlack, UberPool_).
8789
88-
<details><summary><strong>Parameters</strong></summary>
90+
<details>
91+
<summary><strong>Parameters</strong></summary>
8992
9093
<table id="table-api">
9194
<tbody>
@@ -110,7 +113,8 @@ This assertion is used to check if the element described by the expression conta
110113
See also [Common Fields](#assertion-common-fields)
111114
112115
</details>
113-
<details><summary><strong>Code View Examples</strong></summary>
116+
<details>
117+
<summary><strong>Code View Examples</strong></summary>
114118
115119
```yaml
116120
- id: assert-contains
@@ -130,7 +134,8 @@ See also [Common Fields](#assertion-common-fields)
130134
131135
This assertion is used to check if the element value described by the expression is equal to a specific value. A direct one-to-one comparison.
132136
133-
<details><summary><strong>Parameters</strong></summary>
137+
<details>
138+
<summary><strong>Parameters</strong></summary>
134139
135140
<table id="table-api">
136141
<tbody>
@@ -155,7 +160,8 @@ This assertion is used to check if the element value described by the expression
155160
See also [Common Fields](#assertion-common-fields)
156161
157162
</details>
158-
<details><summary><strong>Code View Examples</strong></summary>
163+
<details>
164+
<summary><strong>Code View Examples</strong></summary>
159165
160166
```yaml
161167
- id: assert-equals
@@ -175,7 +181,8 @@ See also [Common Fields](#assertion-common-fields)
175181
176182
This assertion is used to check if the element described by the expression exists. The presence of the element, even empty, is enough to consider it a valid assertion.
177183
178-
<details><summary><strong>Parameters</strong></summary>
184+
<details>
185+
<summary><strong>Parameters</strong></summary>
179186
180187
<table id="table-api">
181188
<tbody>
@@ -192,7 +199,8 @@ This assertion is used to check if the element described by the expression exist
192199
See also [Common Fields](#assertion-common-fields)
193200
194201
</details>
195-
<details><summary><strong>Code View Examples</strong></summary>
202+
<details>
203+
<summary><strong>Code View Examples</strong></summary>
196204
197205
```yaml
198206
- id: assert-exists
@@ -205,7 +213,8 @@ See also [Common Fields](#assertion-common-fields)
205213
206214
This assertion is used to check if the element value described by the expression is greater than a proposed value. The values can be compared as a _string_ or _number_.
207215
208-
<details><summary><strong>Parameters</strong></summary>
216+
<details>
217+
<summary><strong>Parameters</strong></summary>
209218
210219
<table id="table-api">
211220
<tbody>
@@ -226,7 +235,8 @@ This assertion is used to check if the element value described by the expression
226235
See also [Common Fields](#assertion-common-fields)
227236
228237
</details>
229-
<details><summary><strong>Code View Examples</strong></summary>
238+
<details>
239+
<summary><strong>Code View Examples</strong></summary>
230240
231241
```yaml
232242
- id: assert-greater
@@ -240,7 +250,8 @@ See also [Common Fields](#assertion-common-fields)
240250
241251
This assertion is used to check if the element described by the expression matches at least one item from a given list. For example, the category of a product is one of the approved categories such as men, women, or children.
242252
243-
<details><summary><strong>Parameters</strong></summary>
253+
<details>
254+
<summary><strong>Parameters</strong></summary>
244255
245256
<table id="table-api">
246257
<tbody>
@@ -261,7 +272,8 @@ This assertion is used to check if the element described by the expression match
261272
See also [Common Fields](#assertion-common-fields).
262273
263274
</details>
264-
<details><summary><strong>Code View Examples</strong></summary>
275+
<details>
276+
<summary><strong>Code View Examples</strong></summary>
265277
266278
```yaml
267279
- id: assert-in
@@ -286,7 +298,8 @@ See also [Common Fields](#assertion-common-fields).
286298
287299
This assertion is used to check if the value of the element defined by the expression belongs to a specific type. This is one of the more commonly used assertions because it can be used to verify various things such as whole numbers, email addresses, phone numbers, URLs, and so forth.
288300
289-
<details><summary><strong>Parameters</strong></summary>
301+
<details>
302+
<summary><strong>Parameters</strong></summary>
290303
291304
<table id="table-api">
292305
<tbody>
@@ -307,7 +320,8 @@ This assertion is used to check if the value of the element defined by the expre
307320
See also [Common Fields](#assertion-common-fields)
308321
309322
</details>
310-
<details><summary><strong>Code View Examples</strong></summary>
323+
<details>
324+
<summary><strong>Code View Examples</strong></summary>
311325
312326
```yaml
313327
- id: assert-is
@@ -321,7 +335,8 @@ See also [Common Fields](#assertion-common-fields)
321335
322336
This assertion is used to check if the element value described by the expression is less than a proposed value. The values can be compared as a _string_ or _number_.
323337
324-
<details><summary><strong>Parameters</strong></summary>
338+
<details>
339+
<summary><strong>Parameters</strong></summary>
325340
326341
<table id="table-api">
327342
<tbody>
@@ -342,7 +357,8 @@ This assertion is used to check if the element value described by the expression
342357
See also [Common Fields](#assertion-common-fields)
343358
344359
</details>
345-
<details><summary><strong>Code View Examples</strong></summary>
360+
<details>
361+
<summary><strong>Code View Examples</strong></summary>
346362
347363
```yaml
348364
- id: assert-less
@@ -356,7 +372,8 @@ See also [Common Fields](#assertion-common-fields)
356372
357373
This assertion is used to check if the element value described by the expression matches a knowledge base of some kind (e.g, U.S. state or zip code). This also gives you the ability to write your own regex (regular expression).
358374
359-
<details><summary><strong>Parameters</strong></summary>
375+
<details>
376+
<summary><strong>Parameters</strong></summary>
360377
361378
<table id="table-api">
362379
<tbody>
@@ -381,7 +398,8 @@ This assertion is used to check if the element value described by the expression
381398
See also [Common Fields](#assertion-common-fields)
382399
383400
</details>
384-
<details><summary><strong>Code View Examples</strong></summary>
401+
<details>
402+
<summary><strong>Code View Examples</strong></summary>
385403
386404
```yaml
387405
- id: assert-matches
@@ -395,7 +413,8 @@ See also [Common Fields](#assertion-common-fields)
395413
396414
This assertion is used to validate a JSON schema, based on the provided schema definition.
397415
398-
<details><summary><strong>Parameters</strong></summary>
416+
<details>
417+
<summary><strong>Parameters</strong></summary>
399418
400419
<table id="table-api">
401420
<tbody>
@@ -416,7 +435,8 @@ This assertion is used to validate a JSON schema, based on the provided schema d
416435
See also [Comment](#comment)
417436
418437
</details>
419-
<details><summary><strong>Code View Examples</strong></summary>
438+
<details>
439+
<summary><strong>Code View Examples</strong></summary>
420440
421441
```yaml
422442
- id: set

0 commit comments

Comments
 (0)