Octri

specs convert

When you move to Octri from another tool, the converter turns that tool's export into an OpenAPI spec and writes a conversion report: what it found and every choice it made. On its own, octri specs convert shows whether the current spec came from a conversion.

You can save the report, edit it, and import it back, and Octri reruns the conversion from it. See importing a spec.

bash
octri specs convert [status | report | import <report.json>]

octri specs convert report

Saves the current spec's conversion report as JSON. It fails if the current spec wasn't converted.

Flags

--out <file>pathdefault: conversion-report.json

Where to save it.

octri specs convert import <report.json>

Reruns the conversion from a report and ingests the result as the current spec, keeping the report alongside it. It follows ingestion like specs push.

The import only lands while the spec the report was made from is still current, so an upload that happened in the meantime isn't overwritten.

Arguments

<report.json>pathrequired

The report, usually one you saved with report and edited.

Flags

--expect-spec <specId>stringdefault: the current spec

The spec the report was made from. The import is refused if a different spec is current.

--no-waitboolean

Return once the import is accepted.

Examples

Check the current spec

bash
octri specs convert
Output
✔ Loading converter source

Spec converter
  current spec  6acd4f5218c2528b59327451
  spec size     36 KB
  converted     no
  targets       2.0, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.0.4, 3.1.0, 3.1.1, 3.1.2, 3.2.0, 3.2.1
  report limit  60 MB
  octri specs convert import <report.json>: import a conversion report
  • octri specs push: Upload an OpenAPI spec and follow it through parsing, pages and search.
  • Importing a spec: Formats, the converter, and moving from another tool.