echolot spec

echolot spec brings two things from the Specs page to the terminal: the linter, and the link between a spec and the folder of requests made from it.

echolot spec lintCopy Anchor Link

echolot spec lint <file> [--strict] [--hints]

<file> is the spec, YAML or JSON. Files it refers to with $ref are read from beside it.

echolot spec lint Alpenglow.echolot/specs/alpenglow.yaml

0 errors, 0 warnings.

Each problem is one line on standard output, with the file, line and column, the severity, the message and the rule in brackets, so editors and CI can point at it. The count goes to standard error:

api.yaml:2:1: error: info needs a version (of the API, such as 1.0.0). [info]
api.yaml:7:7: error: GET /x documents no responses. [responses]
api.yaml:6:5: hint: GET /x has no operationId; code generators and agents name it from one. [operation-id]
2 errors, 0 warnings.

The rules are the same as on the Specs page; see editing specs.

echolot spec checkCopy Anchor Link

echolot spec check [--workspace <workspace>] <folder> [--refresh]

A folder made by importing a spec, or linked to one in the app, follows that spec. check compares the folder with the spec as it is now and lists each operation that was added, changed (with the fields) or removed. A change to something you edited in the workspace says so: those edits are kept.

echolot spec check -w Shop.echolot pets

added    POST /pets
changed  GET /pets/{id}  (parameters, responses)
removed  DELETE /pets/{id}
3 changes, 12 unchanged.

<folder> is the linked folder's path, such as pets. Use check in CI to fail a build when the requests have fallen behind the spec.

echolot spec applyCopy Anchor Link

echolot spec apply [--workspace <workspace>] <folder> [--operation <operation> ...]

Writes the spec's changes into the folder: new operations become requests, changed ones are updated, removed ones are removed. What you edited in a request is kept. A request you edited whose operation the spec no longer has is kept too, and stops following the spec. Each line says what happened:

added    pets/create-pet
updated  pets/get-pet  kept edits to headers
removed  pets/delete-pet

Exit codesCopy Anchor Link