scalar schema
Manage shared schemas in the Scalar Registry.
| Command | Description |
|---|---|
scalar schema delete |
Delete a shared schema |
scalar schema update |
Update shared schema metadata |
scalar schema list |
List shared schemas in a team namespace |
scalar schema get |
Download a shared schema version from the Scalar Registry |
scalar schema publish |
Publish a shared schema to the Scalar Registry |
delete
Delete a shared schema.
scalar schema delete [options]
Options
| Option | Description |
|---|---|
--json |
Output the mutation result as JSON without prompting. |
-s, --slug <slug> |
Schema slug. |
-n, --namespace <namespace> |
Team namespace. |
--no-input |
Disable prompts and browser launches. |
update
Update shared schema metadata.
scalar schema update [options]
Options
| Option | Description |
|---|---|
--json |
Output the mutation result as JSON without prompting. |
-s, --slug <slug> |
Schema slug. |
-n, --namespace <namespace> |
Team namespace. |
--title <title> |
Schema title. |
--description <description> |
Schema description. |
--isPrivate <isPrivate> |
Whole-entry access, including existing versions (true/private or false/public). One of true, false, public, private. |
--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. |
list
List shared schemas in a team namespace.
scalar schema list [options]
Options
| Option | Description |
|---|---|
--namespace <namespace> |
Team namespace. |
--json |
Output schema metadata as JSON. |
--no-input |
Disable prompts and browser launches. |
get
Download a shared schema 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. One of json, yaml. |
json |
-o, --output <file> |
Output file (defaults to stdout). | |
--no-input |
Disable prompts and browser launches. |
publish
Publish a shared schema to the Scalar Registry.
scalar schema publish [options] [file]
Arguments
| Argument | Description |
|---|---|
file |
Shared schema file path or URL to upload. |
Options
| Option | Description | Default |
|---|---|---|
--json |
Output the mutation result as JSON without prompting. | |
--slug <slug> |
Shared schema slug. | |
--title <title> |
Schema title. | |
--namespace <namespace> |
Scalar team namespace. | |
--version <version> |
Schema version (for example, 0.1.0). | |
--private |
Create a private entry or require an existing private entry. | false |
--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. |
What did you think of this content?
