Skip to content

Commit d1a1c92

Browse files
juliamrchlena-larionovakong-documentation-app[bot]
authored
release: insomnia 13.2 (#6596)
* feat(insomnia): selective co-owner removal * tests: adjust after testing on staging * release: insomnia 13.2 * fix: version * fix(insomnia): external libraries package names (#6667) * feat(insomnia): remove default browser faq (#6625) * feat(insomnia): focus mode (#6659) * feat(insomnia): update user reports data (#6621) * feat(insomnia): update user reports feature * add version * Apply suggestions from code review Co-authored-by: Julia <101819212+juliamrch@users.noreply.github.com> * Update app/insomnia/enterprise-user-management.md Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> --------- Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> * Generate Inso CLI reference docs (#6728) Co-authored-by: juliamrch <101819212+juliamrch@users.noreply.github.com> * Update app/insomnia/enterprise-user-management.md * Update app/_landing_pages/insomnia/collections.yaml --------- Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com> Co-authored-by: kong-documentation-app[bot] <247127266+kong-documentation-app[bot]@users.noreply.github.com>
1 parent 71eee33 commit d1a1c92

15 files changed

Lines changed: 286 additions & 10 deletions

File tree

‎app/_data/products/insomnia.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,6 @@ releases:
4848
version: "13.0.0"
4949
- release: "13.1"
5050
version: "13.1.0"
51+
- release: "13.2"
52+
version: "13.2.0"
5153
latest: true

‎app/_landing_pages/insomnia/collections.yaml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,4 +168,7 @@ rows:
168168
a: Yes, you can use the [`inso run collection`](/inso-cli/reference/run_collection/) command in Inso CLI to run a collection automatically.
169169
- q: Can I set authentication headers at the collection level so I do not repeat them on every request?
170170
a: |
171-
No. As a workaround, group the relevant requests in a **folder** and then set authentication at the folder level for that group to avoid duplicating headers on each request.
171+
No. As a workaround, group the relevant requests in a **folder** and then set authentication at the folder level for that group to avoid duplicating headers on each request.
172+
- q: Can I hide other projects and collections to focus only on one collection?
173+
a: |
174+
Yes. Go to **Preferences** > **General** > **Application** and enable **Sidebar focus for collections**. The sidebar then displays only the contents of the collection you select. This is enabled by default since Insomnia 13.2
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: export
3+
---
4+
5+
## Command Description
6+
7+
Export data from insomnia models
8+
9+
## Syntax
10+
11+
`export [options] [command]`
12+
13+
## Global Flags
14+
15+
- `-v, --version`: output the version number
16+
- `-w, --workingDir <dir>`: set working directory/file: .insomnia folder, *.db.json, export.yaml
17+
- `--verbose`: show additional logs while running the command
18+
- `--ci`: run in CI, disables all prompts, defaults to false
19+
- `--config <path>`: path to configuration file containing above options (.insorc)
20+
- `--printOptions`: print the loaded options
21+
22+
## Subcommands
23+
24+
- [`export spec`](/inso-cli/reference/export_spec/{{page.release}}/): Export an API Specification to a file, identifier can be an API Spec id
25+
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: export spec
3+
---
4+
5+
## Command Description
6+
7+
Export an API Specification to a file, identifier can be an API Spec id
8+
9+
## Syntax
10+
11+
`export spec [options] [identifier]`
12+
13+
## Local Flags
14+
15+
- `-o, --output <path>`: save the generated config to a file
16+
- `-s, --skipAnnotations`: remove all "x-kong-" annotations, defaults to false
17+
18+
## Global Flags
19+
20+
- `-v, --version`: output the version number
21+
- `-w, --workingDir <dir>`: set working directory/file: .insomnia folder, *.db.json, export.yaml
22+
- `--verbose`: show additional logs while running the command
23+
- `--ci`: run in CI, disables all prompts, defaults to false
24+
- `--config <path>`: path to configuration file containing above options (.insorc)
25+
- `--printOptions`: print the loaded options
26+
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: CLI Documentation
3+
---
4+
5+
## Global Flags
6+
7+
- `-v, --version`: output the version number
8+
- `-w, --workingDir <dir>`: set working directory/file: .insomnia folder, *.db.json, export.yaml
9+
- `--verbose`: show additional logs while running the command
10+
- `--ci`: run in CI, disables all prompts, defaults to false
11+
- `--config <path>`: path to configuration file containing above options (.insorc)
12+
- `--printOptions`: print the loaded options
13+
14+
15+
16+
## Commands
17+
18+
- [`run`](/inso-cli/reference/run/{{page.release}}/): Execution utilities
19+
- [`lint`](/inso-cli/reference/lint/{{page.release}}/): Lint a yaml file in the workingDir or the provided file path (with .spectral.yml) or a spec in an Insomnia database directory
20+
- [`export`](/inso-cli/reference/export/{{page.release}}/): Export data from insomnia models
21+
- [`script`](/inso-cli/reference/script/{{page.release}}/): Run scripts defined in .insorc
22+
23+
## Subcommands
24+
25+
- [`run test`](/inso-cli/reference/run_test/{{page.release}}/): Run Insomnia unit test suites, identifier can be a test suite id or a API Spec id
26+
- [`run collection`](/inso-cli/reference/run_collection/{{page.release}}/): Run Insomnia request collection, identifier can be a workspace id
27+
28+
29+
## Subcommands
30+
31+
- [`lint spec`](/inso-cli/reference/lint_spec/{{page.release}}/): Lint an API Specification, identifier can be an API Spec id or a file path
32+
33+
34+
## Subcommands
35+
36+
- [`export spec`](/inso-cli/reference/export_spec/{{page.release}}/): Export an API Specification to a file, identifier can be an API Spec id
37+
38+
39+
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: lint
3+
---
4+
5+
## Command Description
6+
7+
Lint a yaml file in the workingDir or the provided file path (with .spectral.yml) or a spec in an Insomnia database directory
8+
9+
## Syntax
10+
11+
`lint [options] [command]`
12+
13+
## Global Flags
14+
15+
- `-v, --version`: output the version number
16+
- `-w, --workingDir <dir>`: set working directory/file: .insomnia folder, *.db.json, export.yaml
17+
- `--verbose`: show additional logs while running the command
18+
- `--ci`: run in CI, disables all prompts, defaults to false
19+
- `--config <path>`: path to configuration file containing above options (.insorc)
20+
- `--printOptions`: print the loaded options
21+
22+
## Subcommands
23+
24+
- [`lint spec`](/inso-cli/reference/lint_spec/{{page.release}}/): Lint an API Specification, identifier can be an API Spec id or a file path
25+
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: lint spec
3+
---
4+
5+
## Command Description
6+
7+
Lint an API Specification, identifier can be an API Spec id or a file path
8+
9+
## Syntax
10+
11+
`lint spec [options] [identifier]`
12+
13+
## Local Flags
14+
15+
- `-r, --ruleset <path>`: path to a Spectral ruleset file, overrides default OAS ruleset and any ruleset in the API Spec folder
16+
17+
## Global Flags
18+
19+
- `-v, --version`: output the version number
20+
- `-w, --workingDir <dir>`: set working directory/file: .insomnia folder, *.db.json, export.yaml
21+
- `--verbose`: show additional logs while running the command
22+
- `--ci`: run in CI, disables all prompts, defaults to false
23+
- `--config <path>`: path to configuration file containing above options (.insorc)
24+
- `--printOptions`: print the loaded options
25+
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: run
3+
---
4+
5+
## Command Description
6+
7+
Execution utilities
8+
9+
## Syntax
10+
11+
`run [options] [command]`
12+
13+
## Global Flags
14+
15+
- `-v, --version`: output the version number
16+
- `-w, --workingDir <dir>`: set working directory/file: .insomnia folder, *.db.json, export.yaml
17+
- `--verbose`: show additional logs while running the command
18+
- `--ci`: run in CI, disables all prompts, defaults to false
19+
- `--config <path>`: path to configuration file containing above options (.insorc)
20+
- `--printOptions`: print the loaded options
21+
22+
## Subcommands
23+
24+
- [`run test`](/inso-cli/reference/run_test/{{page.release}}/): Run Insomnia unit test suites, identifier can be a test suite id or a API Spec id
25+
- [`run collection`](/inso-cli/reference/run_collection/{{page.release}}/): Run Insomnia request collection, identifier can be a workspace id
26+
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
title: run collection
3+
---
4+
5+
## Command Description
6+
7+
Run Insomnia request collection, identifier can be a workspace id
8+
9+
## Syntax
10+
11+
`run collection [options] [identifier]`
12+
13+
## Local Flags
14+
15+
- `-t, --requestNamePattern <regex>`: run requests that match the regex
16+
- `-i, --item <requestid>`: request or folder id to run
17+
- `-e, --env <identifier>`: environment to use
18+
- `-g, --globals <identifier>`: global environment to use (filepath or id)
19+
- `--delay-request <duration>`: milliseconds to delay between requests
20+
- `--requestTimeout <duration>`: milliseconds before request times out
21+
- `--env-var <key=value>`: override environment variables
22+
- `-n, --iteration-count <count>`: number of times to repeat
23+
- `-d, --iteration-data <path/url>`: file path or url (JSON or CSV)
24+
- `-r, --reporter <reporter>`: reporter to use, options are [dot, list, min, progress, spec, tap]
25+
- `-b, --bail`: abort ("bail") after first non-200 response
26+
- `--disableCertValidation`: disable certificate validation for requests with SSL
27+
- `--httpsProxy <proxy>`: URL for the proxy server for https requests.
28+
- `--httpProxy <proxy>`: URL for the proxy server for http requests.
29+
- `--noProxy <comma_separated_list_of_hostnames>`: Comma separated list of hostnames that do not require a proxy to get reached, even if one is specified.
30+
- `-f, --dataFolders [dataFolders...]`: This allows you to control what folders Insomnia (and scripts within Insomnia) can read/write to.
31+
- `--output <file>`: Output the results to a file in JSON format.
32+
- `--includeFullData <type>`: Include full data in the output file, including request, response, environment and etc.
33+
- `--acceptRisk`: Accept the security warning when outputting to a file, please make sure you understand the risks.
34+
35+
## Global Flags
36+
37+
- `-v, --version`: output the version number
38+
- `-w, --workingDir <dir>`: set working directory/file: .insomnia folder, *.db.json, export.yaml
39+
- `--verbose`: show additional logs while running the command
40+
- `--ci`: run in CI, disables all prompts, defaults to false
41+
- `--config <path>`: path to configuration file containing above options (.insorc)
42+
- `--printOptions`: print the loaded options
43+
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: run test
3+
---
4+
5+
## Command Description
6+
7+
Run Insomnia unit test suites, identifier can be a test suite id or a API Spec id
8+
9+
## Syntax
10+
11+
`run test [options] [identifier]`
12+
13+
## Local Flags
14+
15+
- `-e, --env <identifier>`: environment to use
16+
- `-t, --testNamePattern <regex>`: run tests that match the regex
17+
- `-r, --reporter <reporter>`: reporter to use, options are [dot, list, min, progress, spec, tap]
18+
- `-b, --bail`: abort ("bail") after first test failure
19+
- `--keepFile`: do not delete the generated test file
20+
- `--requestTimeout <duration>`: milliseconds before request times out
21+
- `-k, --disableCertValidation`: disable certificate validation for requests with SSL
22+
- `--httpsProxy <proxy>`: URL for the proxy server for https requests.
23+
- `--httpProxy <proxy>`: URL for the proxy server for http requests.
24+
- `--noProxy <comma_separated_list_of_hostnames>`: Comma separated list of hostnames that do not require a proxy to get reached, even if one is specified.
25+
- `-f, --dataFolders [dataFolders...]`: This allows you to control what folders Insomnia (and scripts within Insomnia) can read/write to.
26+
27+
## Global Flags
28+
29+
- `-v, --version`: output the version number
30+
- `-w, --workingDir <dir>`: set working directory/file: .insomnia folder, *.db.json, export.yaml
31+
- `--verbose`: show additional logs while running the command
32+
- `--ci`: run in CI, disables all prompts, defaults to false
33+
- `--config <path>`: path to configuration file containing above options (.insorc)
34+
- `--printOptions`: print the loaded options
35+

0 commit comments

Comments
 (0)