Orange-OpenSource/hurl
1
1
Fork 0
mirror of https://github.com/Orange-OpenSource/hurl.git synced 2024-09-11 05:35:53 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update docs.

Browse Source
This commit is contained in:
jcamiel 2023-09-19 15:12:18 +02:00
parent ba8e7f6250
commit 419c377f31
No known key found for this signature in database
GPG Key ID: 07FF11CFD55356CC
4 changed files with 16 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -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)
@ -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/
@ -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

9
docs/asserting-response.md
View File

@ -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` |
| __`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` |
| __`isString`__ | Query returns a string | `jsonpath "$.name" isString` |
| __`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` |
| __`isFloat`__ | Query returns a float | `jsonpath "$.height" isFloat` |
| __`isInteger`__ | Query returns an integer | `jsonpath "$.count" isInteger` |
| __`isString`__ | Query returns a string | `jsonpath "$.name" isString` |
Each predicate can be negated by prefixing it with `not` (for instance, `not contains` or `not exists`)

5
docs/samples.md
View File

@ -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/
@ -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
packages/hurl/README.md
View File

@ -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)
@ -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/
@ -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