Skip to content

v0.6.0

Released: 2026-09-13

This release renames the project to systemspec-apistyle as part of the PlexusOne systemspec-{domain} family consolidation, and adds HTML style guide and gap-analysis report generators, semantic category grouping, and a PayPal REST exemplar.

Highlights

  • Breaking: Go module renamed from github.com/plexusone/api-style-spec to github.com/plexusone/systemspec-apistyle
  • HTML style guide and gap-analysis report generators, with new generate guide-html and generate gap-analysis CLI commands
  • CategoryGroup semantic rule grouping applied to the default profile
  • PayPal REST API style guide added as a reference exemplar

Installation

go install github.com/plexusone/systemspec-apistyle/cmd/api-style@v0.6.0

Upgrade from v0.5.0

Breaking: the Go module path changed. Update imports and go install/go get invocations:

# old
go install github.com/plexusone/api-style-spec/cmd/api-style@latest

# new
go install github.com/plexusone/systemspec-apistyle/cmd/api-style@latest

The api-style CLI name, .api-style.yaml config, .api-style.json profile extension, and api-style-spec.schema.json filename are unchanged — only the repository and module path moved. The schema $id and rule URLs moved from api-style-spec.dev to plexusone.dev/systemspec-apistyle. Releases up to v0.5.0 remain available under the old module path; they are not retagged.

No CLI command changes are required beyond the import path update.

New features:

  1. Use api-style generate guide-html --spec my-style.json --output docs/ for an HTML style guide
  2. Use api-style generate gap-analysis for an HTML gap-analysis report
  3. The default profile now groups rules into semantic CategoryGroups
  4. api-style exemplar show paypal-rest for a new reference exemplar

Features

HTML Report Generators

New HTML generators complement the existing Markdown and MkDocs output:

# HTML style guide
api-style generate guide-html --spec my-style.json --output docs/

# HTML gap-analysis report
api-style generate gap-analysis --spec my-style.json --output docs/

Category Groups

CategoryGroup groups related rule categories under a semantic label, applied to the default profile so generated documentation and reports read as organized sections rather than a flat rule list.

score-profile JSON Input

generate report now accepts score-profile's JSON output directly, so a profile-quality evaluation can be turned into a report without an intermediate conversion step.

PayPal REST Exemplar

A new reference exemplar based on the PayPal REST API style guide:

api-style exemplar show paypal-rest

Fixes

  • x-extension JSONPath expressions use bracket notation, avoiding analyzer crashes on some specs
  • omniagent-rest profile's dangling basedOn pointer resolved, restoring schema validity
  • Exception scopes support glob matching and a Paths list
  • The LLM judge surfaces spec truncation instead of silently discarding it
  • The Version constant, previously stale, now matches the released version

Documentation

  • README, MkDocs site, and guides updated for the systemspec-apistyle project name
  • Adopted "SystemSpec: API Style" as the display name in titles, alongside the systemspec-apistyle slug used in URLs, install commands, and code
  • CHANGELOG.json's historical commit references (v0.1.0–v0.4.0) repointed to their current main-branch equivalents after an earlier history rewrite