scalar registry
Manage API descriptions in the Scalar Registry.
| Command | Description |
|---|---|
scalar registry publish |
Publish an OpenAPI description to the Scalar Registry |
scalar registry update |
Update API description metadata in the Scalar Registry |
scalar registry delete |
Delete an API description from the Scalar Registry |
scalar registry list |
List Scalar Registry API descriptions in a team namespace |
scalar registry get |
Download an API description version from the Scalar Registry |
publish
Publish an OpenAPI description to the Scalar Registry.
scalar registry publish [options] [file]
Arguments
| Argument | Description |
|---|---|
file |
API description file path or URL to upload. |
Options
| Option | Description | Default |
|---|---|---|
--json |
Output the mutation result as JSON without prompting. | |
--slug <slug> |
Scalar Registry entry slug (defaults to a slug generated from the title). | |
--namespace <namespace> |
Scalar team namespace. | |
--version <version> |
API description version (for example, 0.1.0). | |
--private |
Create a private entry or require an existing private entry. | false |
--no-current |
Keep the existing current version. | |
--force |
Overwrite an existing version. | false |
--bundle |
Bundle all external references before uploading. | |
--treeShake |
Remove unused components from the bundled document. | |
--urlMap |
Generate a map of resolved URLs when bundling the document. | |
--fetchLimit <limit> |
Maximum number of concurrent URL fetches when bundling. | |
--no-input |
Disable prompts and browser launches. |
update
Update API description metadata in the Scalar Registry.
scalar registry update [options] [namespace] [slug]
Arguments
| Argument | Description |
|---|---|
namespace |
Team namespace. |
slug |
API description slug. |
Options
| Option | Description |
|---|---|
--json |
Output the mutation result as JSON without prompting. |
--title <title> |
API description title. |
--description <description> |
API description summary. |
--public |
Make the whole entry public, including existing versions. |
--private |
Make the whole entry private, including existing versions. |
--no-input |
Disable prompts and browser launches. |
delete
Delete an API description from the Scalar Registry.
scalar registry delete [options] [namespace] [slug]
Arguments
| Argument | Description |
|---|---|
namespace |
Team namespace. |
slug |
API description slug. |
Options
| Option | Description |
|---|---|
--json |
Output the mutation result as JSON without prompting. |
--no-input |
Disable prompts and browser launches. |
list
List Scalar Registry API descriptions in a team namespace.
scalar registry list [options]
Options
| Option | Description |
|---|---|
--namespace <namespace> |
Team namespace. |
--json |
Output Scalar Registry API metadata as JSON. |
--no-input |
Disable prompts and browser launches. |
get
Download an API description version from the Scalar Registry.
scalar registry get [options] [namespace] [slug]
Arguments
| Argument | Description |
|---|---|
namespace |
Team namespace. |
slug |
API description slug. |
Options
| Option | Description | Default |
|---|---|---|
--version <version> |
API description version (defaults to latest). | |
--format <format> |
Output format. One of json, yaml. |
json |
-o, --output <file> |
Output file (defaults to stdout). | |
--no-input |
Disable prompts and browser launches. |
What did you think of this content?
