scalar registry
Manage your scalar registry. Generated from @scalar/cli 2.10.0.
| Command | Description |
|---|---|
scalar registry publish |
Publish an OpenAPI document to the Scalar registry |
scalar registry update |
Update document metadata on scalar registry |
scalar registry delete |
Delete a document from scalar registry |
scalar registry list |
List all registry APIs for a team namespace |
scalar registry get |
Get a document version from scalar registry |
publish
Publish an OpenAPI document to the Scalar registry.
scalar registry publish [options] [file]
Arguments
| Argument | Description |
|---|---|
file |
OpenAPI file to upload. |
Options
| Option | Description | Default |
|---|---|---|
--slug <slug> |
Slug identifier for the registry entry. Defaults to title. | |
--namespace <namespace> |
Scalar team namespace. | |
--version <version> |
API version (e.g. 0.1.0). | |
--private |
Make API private. | false |
--no-current |
Do not set as the current version. | |
--force |
Force override 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 URLs to fetch when bundling the document. |
update
Update document metadata on scalar registry.
scalar registry update [options] [namespace] [slug]
Arguments
| Argument | Description |
|---|---|
namespace |
Namespace of document you want to update. |
slug |
Slug of document you want to update. |
Options
| Option | Description |
|---|---|
--title <title> |
Document title. |
--description <description> |
Document description. |
delete
Delete a document from scalar registry.
scalar registry delete [options] [namespace] [slug]
Arguments
| Argument | Description |
|---|---|
namespace |
Team namespace. |
slug |
Managed doc slug. |
list
List all registry APIs for a team namespace.
scalar registry list [options]
Options
| Option | Description |
|---|---|
--namespace <namespace> |
Team namespace. |
--json |
Output registry API metadata as JSON. |
get
Get a document version from scalar registry.
scalar registry get [options] [namespace] [slug]
Arguments
| Argument | Description |
|---|---|
namespace |
Team namespace. |
slug |
Managed doc slug. |
Options
| Option | Description | Default |
|---|---|---|
--version <version> |
Document version (defaults to latest). | |
--format <format> |
Output format (json or yaml). One of json, yaml. |
json |
-o, --output <file> |
Output file (defaults to stdout). |
