v1.1.0: CLI output improvements and validation changes

Added

• Verbose flag (--verbose) to display detailed violation breakdown
• OpenAPI validation errors written to .specgate.log
• Enhanced CLI styling with lipgloss for warning boxes and color-coded output

Changed

• Softened validation logic to continue readiness checks even when OAS structure has issues
• Improved report messaging

Usage

# Quick check (CI-friendly)
specgate check oas.yaml

# Detailed debugging (local development)
specgate check oas.yaml --verbose

v1.0.0: Initial stable release of SpecGate

Installation

go install github.com/itsdeannat/specgate@latest

Usage

specgate check oas.json
specgate check oas.json --strict
specgate check oas.json --format json
specgate advise oas.json
specgate rules
specgate init

What's included

• Quality gates — enforces errors and warnings against OAS files, with non-zero exit codes for CI integration
• Config file support — .specgate.yaml for customizing server URL blocklists
• AI-powered suggestions — specgate advise generates suggested summaries and descriptions via OpenAI's GPT-5-mini model
• Tabular output — color-coded, scannable results
• Strict mode — promotes warnings to errors
• JSON output — --format json for tooling and pipeline integration

Changes since 0.4.0

• Redesigned CLI output — tabular format with color-coded error and warning severity
• Added error and warning counts to output summary
• Fixed pluralization in output
• Renamed repository to specgate and updated module path for go install support

v0.4.0: Improved CLI output

Added

• Error and warning colors in display output, making it easier to spot issues at a glance
• Summary to show how many errors and warnings were found

Changed

• Refactored display function and its parameters
• Updated server URL rule descriptions and display output
• HasWarnings now correctly includes operation ID and tags when evaluating warnings

Fixed

• Pluralization in display output (no more "1 errors")

v0.3.0: initial config file support for SpecGate

Added

• specgate init: generates a .specgate.yaml config file with default values
• --force flag for init: overwrites an existing config file
• Server URL blocklist: flag server URLs in your spec that match entries in the blocklist
• Config file generation: if no config file is found, specgate check creates one automatically and exits with a prompt to review it before running again

Usage

specgate init
specgate init --force

Example configuration file

rules:
  server_url_blocklist:
    - https://example.com

Initial release of SpecGate, a CLI tool for enforcing OpenAPI specification readiness.

Added

• specgate check — validates an OpenAPI spec against a set of error and warning rules
• specgate advise — generates AI-powered suggestions for operations missing summaries or descriptions using OpenAI
• specgate rules — displays the error and warning rules SpecGate enforces
• --strict flag — promotes warnings to errors, failing the check if any are found
• --format json — outputs check results as structured JSON for CI and tooling integration
• Exit code support — exits with code 1 when errors are detected, making SpecGate suitable for use as a CI quality gate

Usage

specgate check oas.json
specgate check oas.json --strict
specgate check oas.json --format json
specgate advise oas.json
specgate rules

Examples

$ specgate check oas.json

ERRORS
------

Missing operation summaries for 1 operation(s):

- GET /menu/{itemId}

Missing error responses (4xx/5xx/default) for 4 operation(s):

- POST /orders
- GET /loyalty/{customerId}

WARNINGS
--------

Missing operation descriptions for 3 operation(s):

- GET /loyalty/{customerId}
- POST /loyalty/{customerId}

Run with --strict to treat warnings as errors.

Requirements

• Go 1.21 or later
• OpenAI API key (required for specgate advise)