Octri

sdk audit

Scores your spec on what makes a good SDK, such as clear operation IDs, described parameters and typed errors, and lists each finding with its severity, where it is, whether Octri can fix it for you, and its key. It's the same review as the dashboard's spec audit.

bash
octri sdk audit [report | apply <key> | ignore <key> | source]

octri sdk audit apply <key>

Writes one automatic fix into your spec, as a new version, and prints the new score. Only findings marked auto can be applied.

Arguments

<key>stringrequired

The finding's key, from the list.

Flags

--input <value>string

The value a fix needs from you, for the findings that ask for one.

octri sdk audit ignore <key>

Mutes a finding that doesn't apply to your API, so it stops costing points.

Arguments

<key>stringrequired

The finding's key.

Flags

--unignoreboolean

Brings an ignored finding back.

octri sdk audit source

Prints the spec text the audit scores, so you can run your own linter over it. The findings you've ignored are listed after it.

Flags

--out <file>path

Saves the spec to a file instead of printing it.

Examples

Audit the spec

bash
octri sdk audit