echolot spec

echolot spec lleva al terminal dos cosas de la página Especificaciones: el linter y el vínculo entre una especificación y la carpeta de solicitudes creada a partir de ella.

echolot spec lintCopy Anchor Link

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

<file> es la especificación, en YAML o JSON. Los archivos a los que remite con $ref se leen desde su lado.

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

0 errors, 0 warnings.

Cada problema es una línea en la salida estándar, con el archivo, la línea y la columna, la gravedad, el mensaje y la regla entre corchetes, para que los editores y el CI puedan señalarlo. El recuento va a la salida de error estándar:

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.

Las reglas son las mismas que en la página Especificaciones; mira editar especificaciones.

echolot spec checkCopy Anchor Link

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

Una carpeta creada al importar una especificación, o vinculada a una en la app, sigue esa especificación. check compara la carpeta con la especificación tal como está ahora y lista cada operación added, changed (con los campos) o removed. Un cambio en algo que editaste en el espacio de trabajo lo dice: esas ediciones se conservan.

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> es la ruta de la carpeta vinculada, como pets. Usa check en CI para hacer fallar una compilación cuando las solicitudes se han quedado atrás respecto a la especificación.

echolot spec applyCopy Anchor Link

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

Escribe los cambios de la especificación en la carpeta: las operaciones nuevas se convierten en solicitudes, las cambiadas se actualizan y las eliminadas se quitan. Lo que editaste en una solicitud se conserva. También se conserva una solicitud que editaste cuya operación ya no está en la especificación, y deja de seguir la especificación. Cada línea dice lo que ocurrió:

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

Códigos de salidaCopy Anchor Link