Skip to content

Commit a171d18

Browse files
asyncapi-botasyncapi-bot
andauthored
chore: update generated docs (#1615)
Co-authored-by: asyncapi-bot <info@asyncapi.io>
1 parent d2e73ec commit a171d18

File tree

1 file changed

+26
-19
lines changed

1 file changed

+26
-19
lines changed

docs/usage.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: 'Usage'
3-
weight: 50
3+
weight: 40
44
---
55

66
<!--
@@ -50,7 +50,7 @@ USAGE
5050
* [`asyncapi config context remove CONTEXT-NAME`](#asyncapi-config-context-remove-context-name)
5151
* [`asyncapi config context use CONTEXT-NAME`](#asyncapi-config-context-use-context-name)
5252
* [`asyncapi config versions`](#asyncapi-config-versions)
53-
* [`asyncapi convert [SPEC-FILE]`](#asyncapi-convert-spec-file)
53+
* [`asyncapi convert [SPEC-FILE] [PROXYHOST] [PROXYPORT]`](#asyncapi-convert-spec-file-proxyhost-proxyport)
5454
* [`asyncapi diff OLD NEW`](#asyncapi-diff-old-new)
5555
* [`asyncapi format [SPEC-FILE]`](#asyncapi-format-spec-file)
5656
* [`asyncapi generate`](#asyncapi-generate)
@@ -60,11 +60,11 @@ USAGE
6060
* [`asyncapi new file`](#asyncapi-new-file)
6161
* [`asyncapi new glee`](#asyncapi-new-glee)
6262
* [`asyncapi new template`](#asyncapi-new-template)
63-
* [`asyncapi optimize [SPEC-FILE]`](#asyncapi-optimize-spec-file)
63+
* [`asyncapi optimize [SPEC-FILE] [PROXYHOST] [PROXYPORT]`](#asyncapi-optimize-spec-file-proxyhost-proxyport)
6464
* [`asyncapi pretty SPEC-FILE`](#asyncapi-pretty-spec-file)
6565
* [`asyncapi start`](#asyncapi-start)
6666
* [`asyncapi start studio`](#asyncapi-start-studio)
67-
* [`asyncapi validate [SPEC-FILE]`](#asyncapi-validate-spec-file)
67+
* [`asyncapi validate [SPEC-FILE] [PROXYHOST] [PROXYPORT]`](#asyncapi-validate-spec-file-proxyhost-proxyport)
6868

6969
## `asyncapi bundle`
7070

@@ -308,17 +308,19 @@ DESCRIPTION
308308

309309
_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/config/versions.ts)_
310310

311-
## `asyncapi convert [SPEC-FILE]`
311+
## `asyncapi convert [SPEC-FILE] [PROXYHOST] [PROXYPORT]`
312312

313313
Convert asyncapi documents older to newer versions or OpenAPI/postman-collection documents to AsyncAPI
314314

315315
```
316316
USAGE
317-
$ asyncapi convert [SPEC-FILE] -f openapi|asyncapi|postman-collection [-h] [-o <value>] [-t <value>] [-p
318-
client|server][--proxyHost][--proxyPort]
317+
$ asyncapi convert [SPEC-FILE] [PROXYHOST] [PROXYPORT] -f openapi|asyncapi|postman-collection [-h] [-o
318+
<value>] [-t <value>] [-p client|server] [--proxyHost <value>] [--proxyPort <value>]
319319
320320
ARGUMENTS
321321
SPEC-FILE spec path, url, or context-name
322+
PROXYHOST Name of the Proxy Host
323+
PROXYPORT Name of the Port of the ProxyHost
322324
323325
FLAGS
324326
-f, --format=<option> (required) [default: asyncapi] Specify the format to convert from (openapi or asyncapi)
@@ -329,8 +331,8 @@ FLAGS
329331
server). Note: This option is only applicable for OpenAPI to AsyncAPI conversions.
330332
<options: client|server>
331333
-t, --target-version=<value> [default: 3.0.0] asyncapi version to convert to
332-
--proxyHost Name of the Proxy Host.
333-
--proxyPort The number of Port for enabling Proxy.
334+
--proxyHost=<value> Name of the ProxyHost
335+
--proxyPort=<value> Port number number for the proxyHost.
334336
335337
DESCRIPTION
336338
Convert asyncapi documents older to newer versions or OpenAPI/postman-collection documents to AsyncAPI
@@ -693,18 +695,20 @@ DESCRIPTION
693695

694696
_See code: [src/commands/new/template.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/new/template.ts)_
695697

696-
## `asyncapi optimize [SPEC-FILE]`
698+
## `asyncapi optimize [SPEC-FILE] [PROXYHOST] [PROXYPORT]`
697699

698700
optimize asyncapi specification file
699701

700702
```
701703
USAGE
702-
$ asyncapi optimize [SPEC-FILE] [-h] [-p
704+
$ asyncapi optimize [SPEC-FILE] [PROXYHOST] [PROXYPORT] [-h] [-p
703705
remove-components|reuse-components|move-duplicates-to-components|move-all-to-components...] [-i schema...] [-o
704-
terminal|new-file|overwrite] [--no-tty] [--proxyHost][--proxyPort]
706+
terminal|new-file|overwrite] [--no-tty] [--proxyHost <value>] [--proxyPort <value>]
705707
706708
ARGUMENTS
707709
SPEC-FILE spec path, url, or context-name
710+
PROXYHOST Name of the Proxy Host
711+
PROXYPORT Name of the Port of the ProxyHost
708712
709713
FLAGS
710714
-h, --help Show CLI help.
@@ -717,8 +721,8 @@ FLAGS
717721
<options: remove-components|reuse-components|move-duplicates-to-components|move-all-to
718722
-components>
719723
--no-tty do not use an interactive terminal
720-
--proxyHost Name of the Proxy Host.
721-
--proxyPort The number of Port for enabling Proxy.
724+
--proxyHost=<value> Name of the ProxyHost
725+
--proxyPort=<value> Port number number for the proxyHost.
722726
723727
DESCRIPTION
724728
optimize asyncapi specification file
@@ -795,17 +799,20 @@ DESCRIPTION
795799

796800
_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v2.14.1/src/commands/start/studio.ts)_
797801

798-
## `asyncapi validate [SPEC-FILE]`
802+
## `asyncapi validate [SPEC-FILE] [PROXYHOST] [PROXYPORT]`
799803

800804
validate asyncapi file
801805

802806
```
803807
USAGE
804-
$ asyncapi validate [SPEC-FILE] [-h] [-w] [--log-diagnostics] [--diagnostics-format
805-
json|stylish|junit|html|text|teamcity|pretty] [--fail-severity error|warn|info|hint] [-o <value>] [--score] [--proxyHost] [--proxyPort]
808+
$ asyncapi validate [SPEC-FILE] [PROXYHOST] [PROXYPORT] [-h] [-w] [--log-diagnostics] [--diagnostics-format
809+
json|stylish|junit|html|text|teamcity|pretty] [--fail-severity error|warn|info|hint] [-o <value>] [--score]
810+
[--proxyHost <value>] [--proxyPort <value>]
806811
807812
ARGUMENTS
808813
SPEC-FILE spec path, url, or context-name
814+
PROXYHOST Name of the Proxy Host
815+
PROXYPORT Name of the Port of the ProxyHost
809816
810817
FLAGS
811818
-h, --help Show CLI help.
@@ -817,10 +824,10 @@ FLAGS
817824
code
818825
<options: error|warn|info|hint>
819826
--[no-]log-diagnostics log validation diagnostics or not
827+
--proxyHost=<value> Name of the ProxyHost
828+
--proxyPort=<value> Port number number for the proxyHost.
820829
--score Compute the score of the AsyncAPI document. Scoring is based on whether the
821830
document has description, license, server and/or channels.
822-
--proxyHost Name of the Proxy Host.
823-
--proxyPort The number of Port for enabling Proxy.
824831
825832
DESCRIPTION
826833
validate asyncapi file

0 commit comments

Comments
 (0)