apxy schema
Import OpenAPI schemas and validate captured traffic against them.
apxy schema import
Import an OpenAPI specification from a local file or remote URL for traffic validation.
apxy schema import [flags]Examples:
apxy schema import --name "my-api" --file ./openapi.yaml
apxy schema import --name "petstore" --url "https://petstore.swagger.io/v2/swagger.json"| Flag | Type | Default | Description |
|---|---|---|---|
--file | string | - | Path to OpenAPI spec file |
--name | string | - | Schema name |
--url | string | - | URL to fetch OpenAPI spec from |
Either --file or --url is required.
apxy schema list
List all imported OpenAPI schemas, including their IDs, names, and import dates.
apxy schema list [flags]| Flag | Type | Default | Description |
|---|---|---|---|
--format | string | json | Output format: json or toon |
-q, --quiet | - | false | Output only IDs, one per line |
apxy schema show
Show the full details of an imported schema by its ID.
apxy schema show [flags]Examples:
apxy schema show --id abc123| Flag | Type | Default | Description |
|---|---|---|---|
--id | string | - | Schema ID (required) |
apxy schema delete
Delete an imported schema by its ID.
apxy schema delete [flags]Examples:
apxy schema delete --id abc123| Flag | Type | Default | Description |
|---|---|---|---|
--dry-run | - | false | Preview without executing |
--id | string | - | Schema ID (required) |
apxy schema validate
Validate a specific captured traffic record against an imported OpenAPI schema.
apxy schema validate [flags]Examples:
apxy schema validate --record-id rec123 --schema-id sch456| Flag | Type | Default | Description |
|---|---|---|---|
--record-id | string | - | Traffic record ID (required) |
--schema-id | string | - | Schema ID (required) |
apxy schema validate-recent
Validate the most recent captured traffic records against all imported schemas.
apxy schema validate-recent [flags]Examples:
apxy schema validate-recent --limit 50| Flag | Type | Default | Description |
|---|---|---|---|
--limit | int | 20 | Number of recent records to validate |
Inherited Options
| Flag | Type | Default | Description |
|---|---|---|---|
--config | string | ./configs/default.yaml | Config file path |
--error-format | string | text | Error output format: text or json |
--help-format | string | default | Help output format: default or agent |
--verbose | - | false | Enable verbose output |
Last updated on