Skip to content

docs: update Restish v2 references#1041

Merged
danielgtaylor merged 1 commit into
mainfrom
docs/restish-v2-public-docs
Jun 5, 2026
Merged

docs: update Restish v2 references#1041
danielgtaylor merged 1 commit into
mainfrom
docs/restish-v2-public-docs

Conversation

@danielgtaylor

Copy link
Copy Markdown
Owner

Summary

  • update Restish install instructions for v2, including Homebrew core and the v2 Go module path
  • switch CLI setup docs and terminal recording from api configure to api connect
  • refresh Restish docs links and fix the CLI auto-config extension key to x-cli-config

Testing

  • rg sweep for stale Restish v1 strings
  • parsed docs/docs/terminal/restish-config.cast as JSON-lines
  • mkdocs build --strict (fails locally: missing Cairo library required by cairosvg)

Copilot AI review requested due to automatic review settings June 5, 2026 01:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR refreshes the documentation and inline references for the Restish CLI after its v2 updates, aligning install instructions, CLI commands, OpenAPI extension naming, and external documentation links.

Changes:

  • Updated Restish installation instructions (new GitHub org/release link and v2 Go module path; removed Homebrew tap step).
  • Switched tutorial guidance and terminal recording from restish api configure to restish api connect.
  • Standardized the CLI auto-config OpenAPI extension key to x-cli-config and updated Restish documentation links.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/docs/tutorial/cli-client.md Updates Restish install steps, links, and tutorial flow to use api connect.
docs/docs/terminal/restish-config.cast Re-records terminal session to reflect restish api connect behavior/output.
docs/docs/how-to/oauth2-jwt.md Updates Restish auto-configuration link for the x-cli-config extension mention.
docs/docs/features/json-schema-registry.md Updates Restish “edit” command documentation link.
docs/docs/features/cli-auto-config.md Fixes extension key to x-cli-config and updates Restish documentation link.
docs/docs/features/auto-patch.md Updates Restish shorthand merge patch documentation links.
autoconfig.go Updates the comment link pointing readers to Restish OpenAPI reference docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov

codecov Bot commented Jun 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.14%. Comparing base (8258b45) to head (3c49bf5).
⚠️ Report is 32 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff            @@
##             main    #1041    +/-   ##
========================================
  Coverage   93.14%   93.14%            
========================================
  Files          23       23            
  Lines        4667     4901   +234     
========================================
+ Hits         4347     4565   +218     
- Misses        264      272     +8     
- Partials       56       64     +8     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@danielgtaylor danielgtaylor merged commit 2b69054 into main Jun 5, 2026
8 checks passed
@danielgtaylor danielgtaylor deleted the docs/restish-v2-public-docs branch June 5, 2026 01:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants