craftr schema import

Import an OpenAPI spec: preview the diff, resolve conflicts, write, and remap. Source may be a file path or URL; omit to use the saved source or piped stdin.

Usage

craftr schema import [source] [--api <api>] [--yes] [--no-persist-source] [--no-auto-clear-caught-up]

Flags

FlagDescription
--api-aAPI slug.
--yes-ySkip the apply confirmation (required for non-interactive use).
--no-persist-sourceDo not persist the spec source in api.json when a path or URL is given. Ignored for stdin and for a saved source.
--no-auto-clear-caught-upKeep overrides whose value already matches the new source.

Examples

craftr schema import ./openapi.json -a petstore-api
craftr schema import https://petstore3.swagger.io/api/v3/openapi.json -a petstore-api --yes
  • schema diff· Preview the diff between the current schema and a candidate spec. Uses the persisted source if no path is given.
  • schema read· Read the effective schema (resources, unmapped, ignored, orphan rules).
  • schema unmapped· List operations that are not mapped to any resource.
  • schema ignored· List ignored operations with their rule ids.
  • schema map· Map an unmapped operation to a resource and operation name.
  • schema map-all· Bulk-map every unmapped operation. Choose exactly one mode.
  • schema rename operation· Rename a single operation within a resource.
  • schema rename resource· Rename a resource.
  • schema set-parent· Set or clear the parent of a resource. Provide a parent or pass --clear, not both.
  • schema ignore· Ignore an operation. It is removed from the effective schema.
  • schema unignore· Remove an ignore rule by operationId.
  • schema define· Define a local operation that does not exist in the source spec. Creates the resource if new.
  • schema undefine· Delete a locally-defined operation.

See also