Project Open-swagger
Opens the swagger page for a given service
beam project open-swagger [<service-name>] [options]
About
Opens the swagger page for a given service
Arguments
| Name | Type | Description |
|---|---|---|
| service-name | ServiceName | Name of the service to open swagger to |
Options
| Name | Type | Description |
|---|---|---|
| --routing-key | String | The routing key for the service instance we want. If not passed, defaults to the local service |
| --remote | Boolean | When set, enforces the routing key to be the one for the service deployed to the realm. Cannot be specified when --routing-key is also set |
| --src-tool | String | A hint to the Portal page which tool is being used |
| --dryrun | Boolean | Should any networking happen? |
| --cid | String | Cid to use; will default to whatever is in the file system |
| --pid | String | Pid to use; will default to whatever is in the file system |
| --quiet | Boolean | When true, skip input waiting and use defaults |
| --host | String | The host endpoint for beamable |
| --access-token | String | The access token to use for the requests |
| --refresh-token | String | Refresh token to use for the requests |
| --log | String | Extra logs gets printed out |
| --no-redirect | Boolean | If there is a local dotnet tool installation (with a ./config/dotnet-tools.json file) for the beam tool, then any global invocation of the beam tool will automatically redirect and call the local version. However, there will be a performance penalty due to the extra process invocation. This option flag will cause an error to occur instead of automatically redirecting the execution to a new process invocation. |
| --unmask-logs | Boolean | By default, logs will automatically mask tokens. However, when this option is enabled, tokens will be visible in their full text. This is a security risk. |
| --no-log-file | Boolean | By default, logs are automatically written to a temp file so that they can be used in an error case. However, when this option is enabled, logs are not written. Also, if the BEAM_CLI_NO_FILE_LOG environment variable is set, no log file will be written. |
| --docker-cli-path | String | a custom location for docker. By default, the CLI will attempt to resolve docker through its usual install locations. You can also use the BEAM_DOCKER_EXE environment variable to specify. |
| Currently, a docker path has been automatically identified. | ||
| --emit-log-streams | Boolean | Out all log messages as data payloads in addition to however they are logged |
| --add-project-path | IEnumerable`1 | additional file paths to be included when building a local project manifest. |
| --dir | String | Directory to use for configuration |
| --raw | Boolean | Output raw JSON to standard out. This happens by default when the command is being piped |
| --pretty | Boolean | Output syntax highlighted box text. This happens by default when the command is not piped |
| --dotnet-path | String | a custom location for dotnet |
| --version | Boolean | Show version information |
| --help | Boolean | Show help and usage information |
Parent Command
Updated 10 days ago