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

chore: update generated docs #1615

Merged
merged 1 commit into from
Jan 7, 2025
Merged

chore: update generated docs #1615

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
45 changes: 26 additions & 19 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Usage'
weight: 50
weight: 40
---

<!--
Expand Down Expand Up @@ -50,7 +50,7 @@ USAGE
* [`asyncapi config context remove CONTEXT-NAME`](#asyncapi-config-context-remove-context-name)
* [`asyncapi config context use CONTEXT-NAME`](#asyncapi-config-context-use-context-name)
* [`asyncapi config versions`](#asyncapi-config-versions)
* [`asyncapi convert [SPEC-FILE]`](#asyncapi-convert-spec-file)
* [`asyncapi convert [SPEC-FILE] [PROXYHOST] [PROXYPORT]`](#asyncapi-convert-spec-file-proxyhost-proxyport)
* [`asyncapi diff OLD NEW`](#asyncapi-diff-old-new)
* [`asyncapi format [SPEC-FILE]`](#asyncapi-format-spec-file)
* [`asyncapi generate`](#asyncapi-generate)
Expand All @@ -60,11 +60,11 @@ USAGE
* [`asyncapi new file`](#asyncapi-new-file)
* [`asyncapi new glee`](#asyncapi-new-glee)
* [`asyncapi new template`](#asyncapi-new-template)
* [`asyncapi optimize [SPEC-FILE]`](#asyncapi-optimize-spec-file)
* [`asyncapi optimize [SPEC-FILE] [PROXYHOST] [PROXYPORT]`](#asyncapi-optimize-spec-file-proxyhost-proxyport)
* [`asyncapi pretty SPEC-FILE`](#asyncapi-pretty-spec-file)
* [`asyncapi start`](#asyncapi-start)
* [`asyncapi start studio`](#asyncapi-start-studio)
* [`asyncapi validate [SPEC-FILE]`](#asyncapi-validate-spec-file)
* [`asyncapi validate [SPEC-FILE] [PROXYHOST] [PROXYPORT]`](#asyncapi-validate-spec-file-proxyhost-proxyport)

## `asyncapi bundle`

Expand Down Expand Up @@ -308,17 +308,19 @@ DESCRIPTION

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

## `asyncapi convert [SPEC-FILE]`
## `asyncapi convert [SPEC-FILE] [PROXYHOST] [PROXYPORT]`

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

```
USAGE
$ asyncapi convert [SPEC-FILE] -f openapi|asyncapi|postman-collection [-h] [-o <value>] [-t <value>] [-p
client|server][--proxyHost][--proxyPort]
$ asyncapi convert [SPEC-FILE] [PROXYHOST] [PROXYPORT] -f openapi|asyncapi|postman-collection [-h] [-o
<value>] [-t <value>] [-p client|server] [--proxyHost <value>] [--proxyPort <value>]

ARGUMENTS
SPEC-FILE spec path, url, or context-name
PROXYHOST Name of the Proxy Host
PROXYPORT Name of the Port of the ProxyHost

FLAGS
-f, --format=<option> (required) [default: asyncapi] Specify the format to convert from (openapi or asyncapi)
Expand All @@ -329,8 +331,8 @@ FLAGS
server). Note: This option is only applicable for OpenAPI to AsyncAPI conversions.
<options: client|server>
-t, --target-version=<value> [default: 3.0.0] asyncapi version to convert to
--proxyHost Name of the Proxy Host.
--proxyPort The number of Port for enabling Proxy.
--proxyHost=<value> Name of the ProxyHost
--proxyPort=<value> Port number number for the proxyHost.

DESCRIPTION
Convert asyncapi documents older to newer versions or OpenAPI/postman-collection documents to AsyncAPI
Expand Down Expand Up @@ -693,18 +695,20 @@ DESCRIPTION

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

## `asyncapi optimize [SPEC-FILE]`
## `asyncapi optimize [SPEC-FILE] [PROXYHOST] [PROXYPORT]`

optimize asyncapi specification file

```
USAGE
$ asyncapi optimize [SPEC-FILE] [-h] [-p
$ asyncapi optimize [SPEC-FILE] [PROXYHOST] [PROXYPORT] [-h] [-p
remove-components|reuse-components|move-duplicates-to-components|move-all-to-components...] [-i schema...] [-o
terminal|new-file|overwrite] [--no-tty] [--proxyHost][--proxyPort]
terminal|new-file|overwrite] [--no-tty] [--proxyHost <value>] [--proxyPort <value>]

ARGUMENTS
SPEC-FILE spec path, url, or context-name
PROXYHOST Name of the Proxy Host
PROXYPORT Name of the Port of the ProxyHost

FLAGS
-h, --help Show CLI help.
Expand All @@ -717,8 +721,8 @@ FLAGS
<options: remove-components|reuse-components|move-duplicates-to-components|move-all-to
-components>
--no-tty do not use an interactive terminal
--proxyHost Name of the Proxy Host.
--proxyPort The number of Port for enabling Proxy.
--proxyHost=<value> Name of the ProxyHost
--proxyPort=<value> Port number number for the proxyHost.

DESCRIPTION
optimize asyncapi specification file
Expand Down Expand Up @@ -795,17 +799,20 @@ DESCRIPTION

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

## `asyncapi validate [SPEC-FILE]`
## `asyncapi validate [SPEC-FILE] [PROXYHOST] [PROXYPORT]`

validate asyncapi file

```
USAGE
$ asyncapi validate [SPEC-FILE] [-h] [-w] [--log-diagnostics] [--diagnostics-format
json|stylish|junit|html|text|teamcity|pretty] [--fail-severity error|warn|info|hint] [-o <value>] [--score] [--proxyHost] [--proxyPort]
$ asyncapi validate [SPEC-FILE] [PROXYHOST] [PROXYPORT] [-h] [-w] [--log-diagnostics] [--diagnostics-format
json|stylish|junit|html|text|teamcity|pretty] [--fail-severity error|warn|info|hint] [-o <value>] [--score]
[--proxyHost <value>] [--proxyPort <value>]

ARGUMENTS
SPEC-FILE spec path, url, or context-name
PROXYHOST Name of the Proxy Host
PROXYPORT Name of the Port of the ProxyHost

FLAGS
-h, --help Show CLI help.
Expand All @@ -817,10 +824,10 @@ FLAGS
code
<options: error|warn|info|hint>
--[no-]log-diagnostics log validation diagnostics or not
--proxyHost=<value> Name of the ProxyHost
--proxyPort=<value> Port number number for the proxyHost.
--score Compute the score of the AsyncAPI document. Scoring is based on whether the
document has description, license, server and/or channels.
--proxyHost Name of the Proxy Host.
--proxyPort The number of Port for enabling Proxy.

DESCRIPTION
validate asyncapi file
Expand Down
Loading