Skip to content

Commit

Permalink
Merge branch 'main' into patch-1
Browse files Browse the repository at this point in the history
  • Loading branch information
@alexplischke
alexplischke authored Aug 20, 2024
2 parents 48702a6 + 9694cf2 commit a64ff72
Show file tree
Hide file tree
Showing 380 changed files with 32,379 additions and 20,780 deletions.
6 changes: 5 additions & 1 deletion .github/CODEOWNERS
View file
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,12 @@
# Backtrace/Error Reporting
/docs/error-reporting/ @rick-bt @peter-shao

# Sauce Orchestrate
/docs/orchestrate/ @saucelabs/sauce-orchestrate-team
/docs/orchestrate.md @saucelabs/sauce-orchestrate-team

# Mobile apps:
/docs/mobile-apps/ kristofmuhi
/docs/mobile-apps/ @kristofmuhi

# Web apps:
/docs/web-apps/ @saucelabs/devx
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy-to-dev.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
fetch-depth: 0
- uses: actions/setup-node@v1
with:
node-version: 16.x
node-version: 18.x
- name: Install Python
uses: actions/setup-python@v2
with:
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/deploy-to-production.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
fetch-depth: 0
- uses: actions/setup-node@v3
with:
node-version: 16.x
node-version: 18.x

- uses: actions/cache@v2
id: cache-npm-packages
Expand Down Expand Up @@ -62,7 +62,7 @@ jobs:
fetch-depth: 0
- uses: actions/setup-node@v1
with:
node-version: 16.x
node-version: 18.x
- name: Install Python
uses: actions/setup-python@v2
with:
Expand Down Expand Up @@ -110,7 +110,7 @@ jobs:
fetch-depth: 0
- uses: actions/setup-node@v1
with:
node-version: 16.x
node-version: 18.x
- name: Install Python
uses: actions/setup-python@v2
with:
Expand Down
10 changes: 5 additions & 5 deletions .github/workflows/link-checker.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v1
- uses: actions/setup-node@v4
with:
node-version: 16.x
- uses: actions/setup-python@v2
node-version: 18.x
- uses: actions/setup-python@v5
with:
python-version: 3.7
python-version: '3.10'
- name: Build and Run Docusaurus Site
working-directory: ./
run: |
Expand Down
18 changes: 5 additions & 13 deletions docs/api-testing.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,19 +37,11 @@ Use the API Testing platform to generate contract tests from an OpenAPI specific
<p>
Create functional tests from multiple locations:
<ul>
<li>
<a href="/api-testing/quickstart">HTTP client</a></li>
<li>
<a href="/api-testing/import-postman-collection">Postman collection (in the HTTP client)</a></li>
<li>
<a href="/api-testing/build-from-spec">OpenAPI spec file</a>
</li>
<li>
<a href="/api-testing/import-har-files/">Import from HAR file (including HAR files from RDC and VDC)</a>
</li>
<li>
<a href="/api-testing/composer">Test composer</a>
</li>
<li><a href="/api-testing/quickstart">HTTP client</a></li>
<li><a href="/api-testing/import-postman-collection">Postman collection (in the HTTP client)</a></li>
<li><a href="/api-testing/build-from-spec">OpenAPI spec file</a></li>
<li><a href="/api-testing/import-har-files/">Import from HAR file (including HAR files from RDC and VDC)</a></li>
<li><a href="/api-testing/composer">Test composer</a></li>
</ul>
</p>
</div>
Expand Down
60 changes: 40 additions & 20 deletions docs/api-testing/composer/assertion-components.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ Assertions are a type of component that you can add to a test using the Composer

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

<details><summary><strong>Parameters</strong></summary>
<details>
<summary><strong>Parameters</strong></summary>

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

</details>
<details><summary><strong>Code View Examples</strong></summary>
<details>
<summary><strong>Code View Examples</strong></summary>

```yaml
- id: assert-compares
Expand Down Expand Up @@ -85,7 +87,8 @@ See also [Common Fields](#assertion-common-fields)
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_).
<details><summary><strong>Parameters</strong></summary>
<details>
<summary><strong>Parameters</strong></summary>
<table id="table-api">
<tbody>
Expand All @@ -110,7 +113,8 @@ This assertion is used to check if the element described by the expression conta
See also [Common Fields](#assertion-common-fields)
</details>
<details><summary><strong>Code View Examples</strong></summary>
<details>
<summary><strong>Code View Examples</strong></summary>
```yaml
- id: assert-contains
Expand All @@ -130,7 +134,8 @@ See also [Common Fields](#assertion-common-fields)
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.
<details><summary><strong>Parameters</strong></summary>
<details>
<summary><strong>Parameters</strong></summary>
<table id="table-api">
<tbody>
Expand All @@ -155,7 +160,8 @@ This assertion is used to check if the element value described by the expression
See also [Common Fields](#assertion-common-fields)
</details>
<details><summary><strong>Code View Examples</strong></summary>
<details>
<summary><strong>Code View Examples</strong></summary>
```yaml
- id: assert-equals
Expand All @@ -175,7 +181,8 @@ See also [Common Fields](#assertion-common-fields)
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.
<details><summary><strong>Parameters</strong></summary>
<details>
<summary><strong>Parameters</strong></summary>
<table id="table-api">
<tbody>
Expand All @@ -192,7 +199,8 @@ This assertion is used to check if the element described by the expression exist
See also [Common Fields](#assertion-common-fields)
</details>
<details><summary><strong>Code View Examples</strong></summary>
<details>
<summary><strong>Code View Examples</strong></summary>
```yaml
- id: assert-exists
Expand All @@ -205,7 +213,8 @@ See also [Common Fields](#assertion-common-fields)
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_.
<details><summary><strong>Parameters</strong></summary>
<details>
<summary><strong>Parameters</strong></summary>
<table id="table-api">
<tbody>
Expand All @@ -226,7 +235,8 @@ This assertion is used to check if the element value described by the expression
See also [Common Fields](#assertion-common-fields)
</details>
<details><summary><strong>Code View Examples</strong></summary>
<details>
<summary><strong>Code View Examples</strong></summary>
```yaml
- id: assert-greater
Expand All @@ -240,7 +250,8 @@ See also [Common Fields](#assertion-common-fields)
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.
<details><summary><strong>Parameters</strong></summary>
<details>
<summary><strong>Parameters</strong></summary>
<table id="table-api">
<tbody>
Expand All @@ -261,7 +272,8 @@ This assertion is used to check if the element described by the expression match
See also [Common Fields](#assertion-common-fields).
</details>
<details><summary><strong>Code View Examples</strong></summary>
<details>
<summary><strong>Code View Examples</strong></summary>
```yaml
- id: assert-in
Expand All @@ -286,7 +298,8 @@ See also [Common Fields](#assertion-common-fields).
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.
<details><summary><strong>Parameters</strong></summary>
<details>
<summary><strong>Parameters</strong></summary>
<table id="table-api">
<tbody>
Expand All @@ -307,7 +320,8 @@ This assertion is used to check if the value of the element defined by the expre
See also [Common Fields](#assertion-common-fields)
</details>
<details><summary><strong>Code View Examples</strong></summary>
<details>
<summary><strong>Code View Examples</strong></summary>
```yaml
- id: assert-is
Expand All @@ -321,7 +335,8 @@ See also [Common Fields](#assertion-common-fields)
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_.
<details><summary><strong>Parameters</strong></summary>
<details>
<summary><strong>Parameters</strong></summary>
<table id="table-api">
<tbody>
Expand All @@ -342,7 +357,8 @@ This assertion is used to check if the element value described by the expression
See also [Common Fields](#assertion-common-fields)
</details>
<details><summary><strong>Code View Examples</strong></summary>
<details>
<summary><strong>Code View Examples</strong></summary>
```yaml
- id: assert-less
Expand All @@ -356,7 +372,8 @@ See also [Common Fields](#assertion-common-fields)
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).
<details><summary><strong>Parameters</strong></summary>
<details>
<summary><strong>Parameters</strong></summary>
<table id="table-api">
<tbody>
Expand All @@ -381,7 +398,8 @@ This assertion is used to check if the element value described by the expression
See also [Common Fields](#assertion-common-fields)
</details>
<details><summary><strong>Code View Examples</strong></summary>
<details>
<summary><strong>Code View Examples</strong></summary>
```yaml
- id: assert-matches
Expand All @@ -395,7 +413,8 @@ See also [Common Fields](#assertion-common-fields)
This assertion is used to validate a JSON schema, based on the provided schema definition.
<details><summary><strong>Parameters</strong></summary>
<details>
<summary><strong>Parameters</strong></summary>
<table id="table-api">
<tbody>
Expand All @@ -416,7 +435,8 @@ This assertion is used to validate a JSON schema, based on the provided schema d
See also [Comment](#comment)
</details>
<details><summary><strong>Code View Examples</strong></summary>
<details>
<summary><strong>Code View Examples</strong></summary>
```yaml
- id: set
Expand Down
Loading

0 comments on commit a64ff72

Please sign in to comment.