scalar schema
Manage your Scalar schemas. Generated from @scalar/cli 2.10.0.
| Command | Description |
|---|---|
scalar schema delete |
Delete a schema |
scalar schema update |
Update schema metadata |
scalar schema list |
List all schemas for a team namespace |
scalar schema get |
Get a schema document version from the Scalar registry |
scalar schema publish |
Publish a shared schema to the Scalar registry |
delete
Delete a schema.
scalar schema delete [options]
Options
| Option | Description |
|---|---|
-s, --slug <slug> |
Schema slug. |
-n, --namespace <namespace> |
Team namespace. |
update
Update schema metadata.
scalar schema update [options]
Options
| Option | Description |
|---|---|
-s, --slug <slug> |
Schema slug. |
-n, --namespace <namespace> |
Team namespace. |
--title <title> |
Title. |
--description <description> |
Description. |
--isPrivate <isPrivate> |
Privacy (true/false or public/private). One of true, false, public, private. |
list
List all schemas for a team namespace.
scalar schema list [options]
Options
| Option | Description |
|---|---|
--namespace <namespace> |
Team namespace. |
--json |
Output schema metadata as JSON. |
get
Get a schema document version from the Scalar registry.
scalar schema get [options] [namespace] [slug]
Arguments
| Argument | Description |
|---|---|
namespace |
Team namespace. |
slug |
Schema slug. |
Options
| Option | Description | Default |
|---|---|---|
--version <version> |
Schema version (defaults to latest). | |
--format <format> |
Output format (json or yaml). One of json, yaml. |
json |
-o, --output <file> |
Output file (defaults to stdout). |
publish
Publish a shared schema to the Scalar registry.
scalar schema 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. | |
--title <title> |
Schema title. | |
--namespace <namespace> |
Scalar team namespace. | |
--version <version> |
API version (e.g. 0.1.0). | |
--private |
Make API private. | false |
--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. |
