Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
jcamiel committed Sep 19, 2023
1 parent ba8e7f6 commit 419c377
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 11 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ Table of Contents
* [Using SOAP APIs](#using-soap-apis)
* [Capturing and Using a CSRF Token](#capturing-and-using-a-csrf-token)
* [Checking Byte Order Mark (BOM) in Response Body](#checking-byte-order-mark-bom-in-response-body)
* [AWS SigV4 requests](#aws-sigv4-requests)
* [AWS Signature Version 4 Requests](#aws-signature-version-4-requests)
* [Manual](#manual)
* [Name](#name)
* [Synopsis](#synopsis)
Expand Down Expand Up @@ -767,9 +767,9 @@ bytes startsWith hex,efbbbf;

[Doc](https://hurl.dev/docs/asserting-response.html#bytes-assert)

### AWS SigV4 requests
### AWS Signature Version 4 Requests

Generate signed API requests with AWS SigV4, as used by several cloud providers.
Generate signed API requests with [AWS Signature Version 4], as used by several cloud providers.

```hurl
POST https://sts.eu-central-1.amazonaws.com/
Expand Down Expand Up @@ -1210,6 +1210,7 @@ Please follow the [contrib on Windows section].
[`--test` option]: https://hurl.dev/docs/manual.html#test
[`--user`]: https://hurl.dev/docs/manual.html#user
[Hurl templates]: https://hurl.dev/docs/templates.html
[AWS Signature Version 4]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
[GitHub]: https://github.com/Orange-OpenSource/hurl
[hurl-4.0.0-win64.zip]: https://github.com/Orange-OpenSource/hurl/releases/download/4.0.0/hurl-4.0.0-win64.zip
[hurl-4.0.0-win64-installer.exe]: https://github.com/Orange-OpenSource/hurl/releases/download/4.0.0/hurl-4.0.0-win64-installer.exe
Expand Down
7 changes: 4 additions & 3 deletions docs/asserting-response.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,12 +183,13 @@ Predicates consist of a predicate function and a predicate value. Predicate func
| __`includes`__ | Query collections includes the predicate value | `jsonpath "$.nooks" includes "Dune"` |
| __`matches`__ | Part of the query string matches the regex pattern described by the predicate value | `jsonpath "$.release" matches "\\d{4}"`<br><br>`jsonpath "$.release" matches /\d{4}/` |
| __`exists`__ | Query returns a value | `jsonpath "$.book" exists` |
| __`isBoolean`__ | Query returns a boolean | `jsonpath "$.succeeded" isBoolean` |
| __`isCollection`__ | Query returns a collection | `jsonpath "$.books" isCollection` |
| __`isDate`__ | Query returns a date | `jsonpath "$.publication_date" isDate` |
| __`isEmpty`__ | Query returns an empty collection | `jsonpath "$.movies" isEmpty` |
| __`isInteger`__ | Query returns an integer | `jsonpath "$.count" isInteger` |
| __`isFloat`__ | Query returns a float | `jsonpath "$.height" isFloat` |
| __`isBoolean`__ | Query returns a boolean | `jsonpath "$.succeeded" isBoolean` |
| __`isInteger`__ | Query returns an integer | `jsonpath "$.count" isInteger` |
| __`isString`__ | Query returns a string | `jsonpath "$.name" isString` |
| __`isCollection`__ | Query returns a collection | `jsonpath "$.books" isCollection` |


Each predicate can be negated by prefixing it with `not` (for instance, `not contains` or `not exists`)
Expand Down
5 changes: 3 additions & 2 deletions docs/samples.md
Original file line number Diff line number Diff line change
Expand Up @@ -510,9 +510,9 @@ bytes startsWith hex,efbbbf;

[Doc](/docs/asserting-response.md#bytes-assert)

### AWS SigV4 requests
### AWS Signature Version 4 Requests

Generate signed API requests with AWS SigV4, as used by several cloud providers.
Generate signed API requests with [AWS Signature Version 4], as used by several cloud providers.

```hurl
POST https://sts.eu-central-1.amazonaws.com/
Expand Down Expand Up @@ -544,3 +544,4 @@ The Access Key is given per [`--user`].
[`--test` option]: /docs/manual.md#test
[`--user`]: /docs/manual.md#user
[Hurl templates]: /docs/templates.md
[AWS Signature Version 4]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
7 changes: 4 additions & 3 deletions packages/hurl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ Table of Contents
* [Using SOAP APIs](#using-soap-apis)
* [Capturing and Using a CSRF Token](#capturing-and-using-a-csrf-token)
* [Checking Byte Order Mark (BOM) in Response Body](#checking-byte-order-mark-bom-in-response-body)
* [AWS SigV4 requests](#aws-sigv4-requests)
* [AWS Signature Version 4 Requests](#aws-signature-version-4-requests)
* [Manual](#manual)
* [Name](#name)
* [Synopsis](#synopsis)
Expand Down Expand Up @@ -761,9 +761,9 @@ bytes startsWith hex,efbbbf;

[Doc](https://hurl.dev/docs/asserting-response.html#bytes-assert)

### AWS SigV4 requests
### AWS Signature Version 4 Requests

Generate signed API requests with AWS SigV4, as used by several cloud providers.
Generate signed API requests with [AWS Signature Version 4], as used by several cloud providers.

```hurl
POST https://sts.eu-central-1.amazonaws.com/
Expand Down Expand Up @@ -1204,6 +1204,7 @@ Please follow the [contrib on Windows section].
[`--test` option]: https://hurl.dev/docs/manual.html#test
[`--user`]: https://hurl.dev/docs/manual.html#user
[Hurl templates]: https://hurl.dev/docs/templates.html
[AWS Signature Version 4]: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
[GitHub]: https://github.com/Orange-OpenSource/hurl
[hurl-4.0.0-win64.zip]: https://github.com/Orange-OpenSource/hurl/releases/download/4.0.0/hurl-4.0.0-win64.zip
[hurl-4.0.0-win64-installer.exe]: https://github.com/Orange-OpenSource/hurl/releases/download/4.0.0/hurl-4.0.0-win64-installer.exe
Expand Down

0 comments on commit 419c377

Please sign in to comment.