Skip to content

Commit 297f3ab

Browse files
authored
Release Version (#130)
2 parents 7efd8d8 + 44bd9fb commit 297f3ab

20 files changed

+125
-56
lines changed

.changeset/three-singers-rush.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/commands/export-backup.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,13 @@ Usage: xano export-backup [options]
2424
Backup Xano Workspace via Metadata API
2525
2626
Options:
27-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
28-
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
29-
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
27+
--instance <instance> The instance name. This is used to fetch the instance
28+
configuration. The value provided at the setup
29+
command.
30+
--workspace <workspace> The workspace name. This is used to fetch the
31+
workspace configuration. Same as on Xano interface.
32+
--branch <branch> The branch name. This is used to select the branch
33+
configuration. Same as on Xano Interface.
3034
--print-output-dir Expose usable output path for further reuse.
3135
-h, --help display help for command
3236
```

docs/commands/generate-code.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,27 @@ $ xano generate-code [options]
3131
$ xano generate-code --help
3232
Usage: xano generate-code [options]
3333
34-
Create a library based on the OpenAPI specification. If the openapi specification has not yet been generated, this will generate that as well
35-
as the first step.
34+
Create a library based on the OpenAPI specification. If the openapi
35+
specification has not yet been generated, this will generate that as well as the
36+
first step.
3637
3738
Options:
38-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
39-
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
40-
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
39+
--instance <instance> The instance name. This is used to fetch the instance
40+
configuration. The value provided at the setup
41+
command.
42+
--workspace <workspace> The workspace name. This is used to fetch the
43+
workspace configuration. Same as on Xano interface.
44+
--branch <branch> The branch name. This is used to select the branch
45+
configuration. Same as on Xano Interface.
4146
--group <name> API group name. Same as on Xano Interface.
42-
--all Regenerate for all API groups in the workspace / branch of the current context.
47+
--all Regenerate for all API groups in the workspace /
48+
branch of the current context.
4349
--print-output-dir Expose usable output path for further reuse.
44-
--generator <generator> Generator to use, see all options at: https://openapi-generator.tech/docs/generators
45-
--args <args> Additional arguments to pass to the generator. See https://openapi-generator.tech/docs/usage#generate
46-
--debug Specify this flag in order to allow logging. Logs will appear in output/_logs. Default: false
50+
--generator <generator> Generator to use, see all options at:
51+
https://openapi-generator.tech/docs/generators
52+
--args <args> Additional arguments to pass to the generator. See
53+
https://openapi-generator.tech/docs/usage#generate
54+
--debug Specify this flag in order to allow logging. Logs
55+
will appear in output/_logs. Default: false
4756
-h, --help display help for command
4857
```

docs/commands/generate-oas.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,16 @@ Usage: xano generate-oas [options]
2828
Update and generate OpenAPI spec(s) for the current context.
2929
3030
Options:
31-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
32-
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
33-
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
31+
--instance <instance> The instance name. This is used to fetch the instance
32+
configuration. The value provided at the setup
33+
command.
34+
--workspace <workspace> The workspace name. This is used to fetch the
35+
workspace configuration. Same as on Xano interface.
36+
--branch <branch> The branch name. This is used to select the branch
37+
configuration. Same as on Xano Interface.
3438
--group <name> API group name. Same as on Xano Interface.
35-
--all Regenerate for all API groups in the workspace / branch of the current context.
39+
--all Regenerate for all API groups in the workspace /
40+
branch of the current context.
3641
--print-output-dir Expose usable output path for further reuse.
3742
-h, --help display help for command
3843
```

docs/commands/generate-repo.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,15 @@ Process Xano workspace into repo structure
3232
Options:
3333
--input <file> workspace yaml file
3434
--output <dir> output directory (overrides config)
35-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
36-
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
37-
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
35+
--instance <instance> The instance name. This is used to fetch the instance
36+
configuration. The value provided at the setup
37+
command.
38+
--workspace <workspace> The workspace name. This is used to fetch the
39+
workspace configuration. Same as on Xano interface.
40+
--branch <branch> The branch name. This is used to select the branch
41+
configuration. Same as on Xano Interface.
3842
--print-output-dir Expose usable output path for further reuse.
39-
--fetch Specify this if you want to fetch the workspace schema from Xano
43+
--fetch Specify this if you want to fetch the workspace
44+
schema from Xano
4045
-h, --help display help for command
4146
```

docs/commands/generate-xs-repo.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,13 @@ Usage: xano generate-xs-repo [options]
2424
Process Xano workspace into repo structure
2525
2626
Options:
27-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
28-
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
29-
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
27+
--instance <instance> The instance name. This is used to fetch the instance
28+
configuration. The value provided at the setup
29+
command.
30+
--workspace <workspace> The workspace name. This is used to fetch the
31+
workspace configuration. Same as on Xano interface.
32+
--branch <branch> The branch name. This is used to select the branch
33+
configuration. Same as on Xano Interface.
3034
--print-output-dir Expose usable output path for further reuse.
3135
-h, --help display help for command
3236
```

docs/commands/registry-add.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,15 @@ Usage: xano registry-add [options]
2626
Add a prebuilt component to the current Xano context.
2727
2828
Options:
29-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
30-
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
31-
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
29+
--instance <instance> The instance name. This is used to fetch the instance
30+
configuration. The value provided at the setup
31+
command.
32+
--workspace <workspace> The workspace name. This is used to fetch the
33+
workspace configuration. Same as on Xano interface.
34+
--branch <branch> The branch name. This is used to select the branch
35+
configuration. Same as on Xano Interface.
3236
--components Comma-separated list of components to add
33-
--registry <url> URL to the component registry. Default: http://localhost:5500/registry/definitions
37+
--registry <url> URL to the component registry. Default:
38+
http://localhost:5500/registry/definitions
3439
-h, --help display help for command
3540
```

docs/commands/registry-scaffold.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,15 @@ $ xano registry-scaffold [options]
1717
$ xano registry-scaffold --help
1818
Usage: xano registry-scaffold [options]
1919
20-
Scaffold a Xano registry folder with a sample component. Xano registry can be used to share and reuse prebuilt components. In the registry you
21-
have to follow the [registry](https://calycode.com/schemas/registry/registry.json) and [registry
22-
item](https://calycode.com/schemas/registry/registry-item.json) schemas.
20+
Scaffold a Xano registry folder with a sample component. Xano registry can be
21+
used to share and reuse prebuilt components. In the registry you have to follow
22+
the [registry](https://calycode.com/schemas/registry/registry.json) and
23+
[registry item](https://calycode.com/schemas/registry/registry-item.json)
24+
schemas.
2325
2426
Options:
2527
--output <path> Output path for the registry
26-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
28+
--instance <instance> The instance name. This is used to fetch the instance
29+
configuration. The value provided at the setup command.
2730
-h, --help display help for command
2831
```

docs/commands/restore-backup.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,11 @@ Usage: xano restore-backup [options]
2424
Restore a backup to a Xano Workspace via Metadata API
2525
2626
Options:
27-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
28-
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
27+
--instance <instance> The instance name. This is used to fetch the instance
28+
configuration. The value provided at the setup
29+
command.
30+
--workspace <workspace> The workspace name. This is used to fetch the
31+
workspace configuration. Same as on Xano interface.
2932
--source-backup <file> Path to the backup file to restore
3033
--force Force restoration without confirmation
3134
-h, --help display help for command

docs/commands/run-test.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,16 @@ Usage: xano run-test [options]
3030
Run an API test suite via the OpenAPI spec. WIP...
3131
3232
Options:
33-
--instance <instance> The instance name. This is used to fetch the instance configuration. The value provided at the setup command.
34-
--workspace <workspace> The workspace name. This is used to fetch the workspace configuration. Same as on Xano interface.
35-
--branch <branch> The branch name. This is used to select the branch configuration. Same as on Xano Interface.
33+
--instance <instance> The instance name. This is used to fetch the
34+
instance configuration. The value provided at the
35+
setup command.
36+
--workspace <workspace> The workspace name. This is used to fetch the
37+
workspace configuration. Same as on Xano interface.
38+
--branch <branch> The branch name. This is used to select the branch
39+
configuration. Same as on Xano Interface.
3640
--group <name> API group name. Same as on Xano Interface.
37-
--all Regenerate for all API groups in the workspace / branch of the current context.
41+
--all Regenerate for all API groups in the workspace /
42+
branch of the current context.
3843
--print-output-dir Expose usable output path for further reuse.
3944
--test-config-path <path> Path to a test configuration file.
4045
-h, --help display help for command

0 commit comments

Comments
 (0)