pulumi Verified current stable Not installed? System Operations

Pulumi / Check Package Schema

Check Package Schema

Validates the schema of a package to ensure compliance with the expected format.

$
Terminal
pulumi schema check <path/to/file>

When To Use

During integration testing to enforce contract compliance of resources.

Pro Tip

Use the `--strict` flag for a more rigorous validation that checks for required keys in JSON/YAML schemas.

Command Builder

Tune the command before you copy it

Back to syntax
$
Generated Command
pulumi schema check <path/to/file>

Anatomy of Output

Understanding the result

Schema validation successful: no issues found. Validation Result

Indicates the schema conforms to expected standards.

File: /schemas/my-schema.json Schema File Path

Path of the schema that was validated.

Warnings: 0 Warnings Count

No warnings indicate full compliance.

Troubleshooting

Common pitfalls

Error: Unable to open file: No such file or directory

Solution: Verify the file path and ensure it exists.

Error: Invalid JSON schema: Unexpected token

Solution: Check the JSON/YAML syntax for errors.

Error: Schema validation failed: missing property

Solution: Ensure all required properties are defined in the schema.

Command Breakdown

What each part is doing

pulumi
Base Command
The executable that performs this operation. Here it runs Pulumi before the shell applies any redirect operators.
<path/to/file>
Input Files
The file path or paths supplied to this command.

Alternative Approaches

Comparable commands in other tools

Alternative system operations tools for the same job.