Skip to content

v2.3.0

Latest

Choose a tag to compare

@danielgtaylor danielgtaylor released this 30 Jun 04:27
· 6 commits to main since this release
v2.3.0
6305246

Overview

Restish 2.3.0 is a minor release for people building on top of Restish as well as people using it directly from the terminal. It promotes the core config and auth building blocks into public packages, adds a custom embedded command surface for applications that want a Restish-powered CLI, tightens auth header display behavior, and expands the docs and blog around OpenAPI-driven workflows.

Public config and auth packages

The config and auth packages are now available as public API for embedders. Applications can read Restish API registrations, reuse token cache paths, and work with legacy config data without copying internal package behavior.

The migration path is also safer: Restish skips legacy config migration when an explicit config environment is in use, exposes format-agnostic API reading helpers, and includes additional tests around public-package compatibility.

Embedded command surface

Restish now has a custom command surface for embedded CLIs. Projects can build a focused command tree from registered APIs while still leaning on Restish for OpenAPI loading, generated operations, auth handling, and request execution.

The release includes an example embedded CLI, design notes, reference docs, and refreshed promoted-command metadata so applications can choose which Restish commands they expose without pulling in the entire top-level CLI experience.

Safer auth header output

Auth header previewing is more careful in this release. Operation-level auth header printing is aligned with generated command behavior, and cookie-based auth is rejected for header printing so sensitive cookie material does not get displayed as if it were a normal reusable header.

Docs and learning material

The docs gained new material on embedding Restish, OpenAPI-powered command generation, TOON output for compact API data, scripting REST APIs from the shell, and interactive filtering examples. The project maintenance guidance was also refreshed so contributors have clearer validation commands and release checks.

Changelog

  • a1037d2 fix(embed): refresh promoted API metadata
  • 5649ffb feat(embed): add custom command surface
  • 7606e92 docs: publish scripting APIs blog post
  • c0f88bb fix: reject cookie auth header printing
  • 7004c7c fix: align operation auth header printing
  • 26a317c feat(auth): expose TokenCache.Path() for embedders
  • bcf50dd feat(config): add format-agnostic ReadAPIs helper for embedders
  • 082e404 feat: expose embedder helpers for legacy config and auth header
  • 0c5d63f fix: skip legacy migration for explicit config env
  • 6fa2201 fix: address public package review feedback
  • 443c4aa fix: tighten public config and auth surface
  • cc5a460 feat: promote config and auth to public packages with embedder convenience layer
  • 27c66e4 docs: add TOON output blog post
  • caef5e4 feat: promote internal/config, internal/auth, internal/fileutil to public packages
  • 5db0dd6 docs: use full go run command for restish-docgen in CI summary
  • 86a5005 docs: align docs validation commands with CI and drop unshipped references
  • ca95b2b docs: expand AGENTS.md and refresh agent skills
  • 3bebd0c docs: list npm docs-job steps in CI parity guidance
  • 1602b5c docs: refresh AGENTS.md and agent skills for accuracy and CI coverage
  • 6ae06df docs: address interactive docs review feedback
  • f8538b6 docs: remove docs tag cloud
  • 6e5117f docs: add filter trace viewer
  • 888d8e3 docs: improve interactive guides
  • 25ecee7 docs: polish interactive examples
  • 24a4ed4 docs: update blog review guidance
  • 9b09e78 docs: add OpenAPI CLI blog post

Full Changelog: v2.2.0...v2.3.0