Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: improve link accuracy #258

Merged
merged 3 commits into from
May 29, 2024
Merged

docs: improve link accuracy #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ea8978f
docs(guide): adds the missing `amp` (&) for the "Filtering & Projecti…
eitamal May 27, 2024
6fe9f04
docs(openapi): fixes the link to the "files or URLs" configuration su…
eitamal May 27, 2024
15431c5
docs(bulk): remove the preceding `./` in the Shorthand Query links
eitamal May 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/bulk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -134,7 +134,7 @@ Alias: `i`
| Param / Option | Description & Example |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `URL` | The URL to list resources<br/>Example: `api.rest.sh/books` |
| `-f`, `--rsh-filter` | Filter the response via [Shorthand Query](./shorthand.md#querying)<br/>Example: `-f 'body.{id, version: last_modified_dt}'` |
| `-f`, `--rsh-filter` | Filter the response via [Shorthand Query](shorthand.md#querying)<br/>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.<br/>Example: `--url-template='/items/{id}` |

#### Automatically recognized fields
Expand Down Expand Up @@ -189,7 +189,7 @@ Alias: `ls`
| Param / Option | Description & Example |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `-m`, `--match` | Match resources using [mexpr](https://github.com/danielgtaylor/mexpr) expressions<br/>Example: `-m 'rating_average >= 4.8'` |
| `-f`, `--rsh-filter` | Filter each resource via [Shorthand Query](./shorthand.md#querying) and print the result<br/>Example: `-f 'recent_ratings[0].rating'` |
| `-f`, `--rsh-filter` | Filter each resource via [Shorthand Query](shorthand.md#querying) and print the result<br/>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".

Expand Down
2 changes: 1 addition & 1 deletion docs/guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/openapi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading