From ea8978ffc56176a3d08316c0bfdcffeb12fc34cc Mon Sep 17 00:00:00 2001 From: Itamar Lencovsky <4740959+eitamal@users.noreply.github.com> Date: Mon, 27 May 2024 11:39:00 +1000 Subject: [PATCH 1/3] docs(guide): adds the missing `amp` (&) for the "Filtering & Projection" sub-section's link --- docs/guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guide.md b/docs/guide.md index e7ea5ac..b213780 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -172,7 +172,7 @@ $ restish api.rest.sh -f headers.Date -r Sat, 1 Jan 2022 12:00:00 GMT ``` -See [filtering & projection](output.md#filtering--projection) for more info & examples. +See [filtering & projection](output.md#filtering-amp-projection) for more info & examples. ### Output defaults From 6fe9f0481448e02f58a9f21ff17a40ff1af1d8b6 Mon Sep 17 00:00:00 2001 From: Itamar Lencovsky <4740959+eitamal@users.noreply.github.com> Date: Mon, 27 May 2024 11:46:28 +1000 Subject: [PATCH 2/3] docs(openapi): fixes the link to the "files or URLs" configuration sub-section --- docs/openapi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/openapi.md b/docs/openapi.md index fe09a9d..478d97b 100644 --- a/docs/openapi.md +++ b/docs/openapi.md @@ -61,7 +61,7 @@ If neither one of those returns an OpenAPI spec, then the loader gives up. ### Loading from files -For local testing or an API you don't control or can't update, you can load from OpenAPI files. See [Configuration: Loading from Files](configuration.md#loading-from-files) for an example configuration. +For local testing or an API you don't control or can't update, you can load from OpenAPI files. See [Configuration: Loading from files or URLs](configuration.md#loading-from-files-or-urls) for an example configuration.; ## OpenAPI extensions From 15431c502cdfb960893fb3e7916451e43657b7e9 Mon Sep 17 00:00:00 2001 From: Itamar Lencovsky <4740959+eitamal@users.noreply.github.com> Date: Mon, 27 May 2024 11:50:08 +1000 Subject: [PATCH 3/3] docs(bulk): remove the preceding `./` in the Shorthand Query links --- docs/bulk.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/bulk.md b/docs/bulk.md index 370f0ea..0e466e5 100644 --- a/docs/bulk.md +++ b/docs/bulk.md @@ -66,7 +66,7 @@ recent_ratings > 5 ...............^^^^ ``` -Additionally, you can use the `-f` flag to apply a [Shorthand Query](./shorthand.md#querying) filter to each matched file and print out the result, enabling a quick way to get specific values from a set of matched files: +Additionally, you can use the `-f` flag to apply a [Shorthand Query](shorthand.md#querying) filter to each matched file and print out the result, enabling a quick way to get specific values from a set of matched files: ```bash # Get the most recent rating of each matched book @@ -134,7 +134,7 @@ Alias: `i` | Param / Option | Description & Example | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `URL` | The URL to list resources
Example: `api.rest.sh/books` | -| `-f`, `--rsh-filter` | Filter the response via [Shorthand Query](./shorthand.md#querying)
Example: `-f 'body.{id, version: last_modified_dt}'` | +| `-f`, `--rsh-filter` | Filter the response via [Shorthand Query](shorthand.md#querying)
Example: `-f 'body.{id, version: last_modified_dt}'` | | `--url-template` | Template string to build URLs from list response items. If a filter is passed, it is processed _before_ rendering the URL template.
Example: `--url-template='/items/{id}` | #### Automatically recognized fields @@ -189,7 +189,7 @@ Alias: `ls` | Param / Option | Description & Example | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | `-m`, `--match` | Match resources using [mexpr](https://github.com/danielgtaylor/mexpr) expressions
Example: `-m 'rating_average >= 4.8'` | -| `-f`, `--rsh-filter` | Filter each resource via [Shorthand Query](./shorthand.md#querying) and print the result
Example: `-f 'recent_ratings[0].rating'` | +| `-f`, `--rsh-filter` | Filter each resource via [Shorthand Query](shorthand.md#querying) and print the result
Example: `-f 'recent_ratings[0].rating'` | ?> Match expressions show any resource whose expression result is "truthy" (meaning a non-zero scalar or non-empty map/slice). `false`, `0`, `""`, `[]`, and `{}` are considered "falsey".