Merge pull request #1041 from danielgtaylor/docs/restish-v2-public-docs

docs: update Restish v2 references

Author: danielgtaylor

autoconfig.go

@@ -17,7 +17,7 @@ type AutoConfigVar struct {
 // are advertised via OpenAPI extension and picked up by the CLI to make it
 // easier to get started using an API. This struct should be put into the
 // `OpenAPI.Extensions` map under the key `x-cli-config`. See also:
-// https://rest.sh/#/openapi?id=autoconfiguration
+// https://rest.sh/docs/reference/openapi/
 type AutoConfig struct {
 	Security string                   `json:"security"`
 	Headers  map[string]string        `json:"headers,omitempty"`

docs/docs/features/auto-patch.md

@@ -22,7 +22,7 @@ If the `GET` returns an `ETag` or `Last-Modified` header, then these will be use
 The following formats are supported out of the box, selected via the `Content-Type` header:
 
 -   [JSON Merge Patch](https://datatracker.ietf.org/doc/html/rfc7386) `application/merge-patch+json`
--   [Shorthand Merge Patch](https://rest.sh/#/shorthand?id=patch-partial-update) `application/merge-patch+shorthand`
+-   [Shorthand Merge Patch](https://rest.sh/docs/reference/shorthand/) `application/merge-patch+shorthand`
 -   [JSON Patch](https://www.rfc-editor.org/rfc/rfc6902.html) `application/json-patch+json`
 
 !!! info "Merge on Steroids"
@@ -63,5 +63,5 @@ huma.Register(api, huma.Operation{
 -   External Links
     -   [HTTP PATCH Method](https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods/PATCH)
     -   [RFC7386 JSON Merge Patch](https://datatracker.ietf.org/doc/html/rfc7386)
-    -   [Shorthand Merge Patch](https://rest.sh/#/shorthand?id=patch-partial-update)
+    -   [Shorthand Merge Patch](https://rest.sh/docs/reference/shorthand/)
     -   [RFC6902 JSON Patch](https://www.rfc-editor.org/rfc/rfc6902.html)

docs/docs/features/cli-auto-config.md

@@ -12,7 +12,7 @@ o.Components.SecuritySchemes["my-scheme"] = &huma.SecurityScheme{
 	Type: "oauth2",
 	// ... security scheme definition ...
 }
-o.Extensions["x-cli-autoconfig"] = huma.AutoConfig{
+o.Extensions["x-cli-config"] = huma.AutoConfig{
 	Security: "my-scheme",
 	Params: map[string]string{
 		"client_id": "abc123",
@@ -23,4 +23,4 @@ o.Extensions["x-cli-autoconfig"] = huma.AutoConfig{
 }
 ```
 
-See the [CLI AutoConfiguration](https://rest.sh/#/openapi?id=autoconfiguration) documentation for more info, including how to ask the user for custom parameters.
+See the [CLI AutoConfiguration](https://rest.sh/docs/reference/openapi/) documentation for more info, including how to ask the user for custom parameters.

docs/docs/features/json-schema-registry.md

@@ -38,7 +38,7 @@ Alternatively, you can manually manage your `Transformers` and `OnAddOperation`
 
 !!! info "Editing"
 
-    The `$schema` field is incredibly powerful when paired with Restish's [edit](https://rest.sh/#/guide?id=editing-resources) command, giving you a quick and easy way to edit strongly-typed resources in your favorite editor.
+    The `$schema` field is incredibly powerful when paired with Restish's [edit](https://rest.sh/docs/reference/edit-command/) command, giving you a quick and easy way to edit strongly-typed resources in your favorite editor.
 
 ## Schema Registry
 

docs/docs/how-to/oauth2-jwt.md

@@ -212,7 +212,7 @@ As mentioned previously, the Oauth2.0 standard does not specify the format of th
 
 ## Optional: Client Auto-Configuration
 
-Some clients like [Restish](https://rest.sh/) support [OpenAPI-based auth auto-configuration](https://rest.sh/#/openapi?id=autoconfiguration). This means that you can configure your client to fetch the OpenAPI document and automatically configure itself to use the correct auth mechanism. This is done by adding the `x-cli-config` extension to the OpenAPI:
+Some clients like [Restish](https://rest.sh/) support [OpenAPI-based auth auto-configuration](https://rest.sh/docs/reference/openapi/). This means that you can configure your client to fetch the OpenAPI document and automatically configure itself to use the correct auth mechanism. This is done by adding the `x-cli-config` extension to the OpenAPI:
 
 ```go title="main.go"
 config.Extensions["x-cli-config"] = huma.AutoConfig{ /* ... */ }

docs/docs/terminal/restish-config.cast

@@ -1,74 +1,54 @@
-{"version": 2, "width": 72, "height": 30, "timestamp": 1699509947, "idle_time_limit": 1.0, "env": {"SHELL": "/bin/bash", "TERM": "xterm-256color"}}
-[0.024399, "o", "\u001b[?1034h\u001b[34m$\u001b[0m "]
-[0.49882, "o", "r"]
-[0.585517, "o", "e"]
-[0.670626, "o", "s"]
-[0.758715, "o", "t"]
-[0.837654, "o", "i"]
-[1.002379, "o", "s"]
-[1.202177, "o", "h"]
-[1.31646, "o", " "]
-[1.444513, "o", "a"]
-[1.568832, "o", "p"]
-[1.682237, "o", "i"]
-[1.768867, "o", " "]
-[1.941194, "o", "c"]
-[2.025374, "o", "o"]
-[2.08862, "o", "n"]
-[2.222313, "o", "f"]
-[2.305716, "o", "i"]
-[2.495639, "o", "g"]
-[2.693832, "o", "u"]
-[2.841225, "o", "r"]
-[2.926078, "o", "e"]
-[3.024863, "o", " "]
-[3.160123, "o", "t"]
-[3.294376, "o", "u"]
-[3.42395, "o", "t"]
-[3.536855, "o", "o"]
-[3.718715, "o", "r"]
-[3.812994, "o", "i"]
-[3.941427, "o", "a"]
-[4.233979, "o", "l"]
-[4.348669, "o", " "]
-[4.717842, "o", "h"]
-[4.796502, "o", "t"]
-[4.962324, "o", "t"]
-[5.045922, "o", "p"]
-[5.364332, "o", ":"]
-[5.581268, "o", "/"]
-[5.726223, "o", "/"]
-[5.831477, "o", "l"]
-[6.027057, "o", "o"]
-[6.118001, "o", "c"]
-[6.20297, "o", "a"]
-[6.253663, "o", "l"]
-[6.441775, "o", "h"]
-[6.505986, "o", "o"]
-[6.585059, "o", "s"]
-[6.774343, "o", "t"]
-[7.025055, "o", ":"]
-[7.379098, "o", "8"]
-[7.541677, "o", "8"]
-[7.724613, "o", "8"]
-[8.135692, "o", "8"]
-[8.575874, "o", "\r\n\u001b[0m"]
-[8.606146, "o", "\u001b7\u001b[?25l\u001b8\u001b[0G\u001b[2K"]
-[8.606451, "o", "\u001b[0;1;92m? \u001b[0m\u001b[0;1;99mSelect option\u001b[0m  \u001b[0;36m[Use arrows to move, type to filter]\u001b[0m\r\n\u001b[0m\u001b[0;1;36m> Change base URI (http://localhost:8888)\u001b[0m\r\n\u001b[0m\u001b[0;39m  Add profile\u001b[0m\r\n\u001b[0m\u001b[0;39m  Edit profile default\u001b[0m\r\n\u001b[0m\u001b[0;39m  Save and exit\u001b[0m\r\n\u001b[0m\u001b7"]
-[8.60661, "o", "\u001b[1A\u001b[0G\u001b[1A\u001b[0G\u001b[1A\u001b[0G\u001b[1A"]
-[8.60662, "o", "\u001b[0G"]
-[9.705099, "o", "\u001b8\u001b[0G\u001b[2K\u001b[1A\u001b[0G\u001b[2K\u001b[1A\u001b[0G\u001b[2K\u001b[1A\u001b[0G\u001b[2K\u001b[1A\u001b[0G\u001b[2K\u001b[1A\u001b[0G\u001b[2K"]
-[9.705426, "o", "\u001b[0;1;92m? \u001b[0m\u001b[0;1;99mSelect option\u001b[0m  \u001b[0;36m[Use arrows to move, type to filter]\u001b[0m\r\n\u001b[0m\u001b[0;39m  Change base URI (http://localhost:8888)\u001b[0m\r\n\u001b[0m\u001b[0;1;36m> Add profile\u001b[0m\r\n\u001b[0m\u001b[0;39m  Edit profile default\u001b[0m\r\n\u001b[0m\u001b[0;39m  Save and exit\u001b[0m\r\n\u001b[0m\u001b7"]
-[9.705752, "o", "\u001b[1A\u001b[0G\u001b[1A\u001b[0G\u001b[1A\u001b[0G"]
-[9.934581, "o", "\u001b8"]
-[9.935927, "o", "\u001b[0G\u001b[2K\u001b[1A\u001b[0G\u001b[2K\u001b[1A\u001b[0G\u001b[2K"]
-[9.936108, "o", "\u001b[1A\u001b[0G\u001b[2K\u001b[1A\u001b[0G\u001b[2K\u001b[1A\u001b[0G\u001b[2K"]
-[9.93632, "o", "\u001b[0;1;92m? \u001b[0m\u001b[0;1;99mSelect option\u001b[0m  \u001b[0;36m[Use arrows to move, type to filter]\u001b[0m\r\n\u001b[0m\u001b[0;39m  Change base URI (http://localhost:8888)\u001b[0m\r\n\u001b[0m\u001b[0;39m  Add profile\u001b[0m\r\n\u001b[0m\u001b[0;1;36m> Edit profile default\u001b[0m\r\n\u001b[0m\u001b[0;39m  Save and exit\u001b[0m\r\n\u001b[0m\u001b7\u001b[1A\u001b[0G\u001b[1A\u001b[0G"]
-[10.243835, "o", "\u001b8"]
-[10.243892, "o", "\u001b[0G\u001b[2K\u001b[1A\u001b[0G\u001b[2K\u001b[1A\u001b[0G\u001b[2K\u001b[1A\u001b[0G\u001b[2K\u001b[1A\u001b[0G\u001b[2K\u001b[1A\u001b[0G\u001b[2K"]
-[10.244195, "o", "\u001b[0;1;92m? \u001b[0m\u001b[0;1;99mSelect option\u001b[0m  \u001b[0;36m[Use arrows to move, type to filter]\u001b[0m\r\n\u001b[0m\u001b[0;39m  Change base URI (http://localhost:8888)\u001b[0m\r\n\u001b[0m\u001b[0;39m  Add profile\u001b[0m\r\n\u001b[0m\u001b[0;39m  Edit profile default\u001b[0m\r\n\u001b[0m\u001b[0;1;36m> Save and exit\u001b[0m\r\n\u001b[0m\u001b7"]
-[10.244432, "o", "\u001b[1A\u001b[0G"]
-[10.830028, "o", "\u001b8\u001b[?25h\u001b8\u001b[0G"]
-[10.831493, "o", "\u001b[2K\u001b[1A\u001b[0G\u001b[2K\u001b[1A\u001b[0G\u001b[2K\u001b[1A"]
-[10.831525, "o", "\u001b[0G\u001b[2K\u001b[1A\u001b[0G\u001b[2K\u001b[1A\u001b[0G\u001b[2K"]
-[10.83169, "o", "\u001b[0;1;92m? \u001b[0m\u001b[0;1;99mSelect option\u001b[0m\u001b[0;36m Save and exit\u001b[0m\r\n\u001b[0m\r\n"]
+{"version": 2, "width": 72, "height": 30, "timestamp": 1780516800, "idle_time_limit": 1.0, "env": {"SHELL": "/bin/bash", "TERM": "xterm-256color"}}
+[0.018568, "o", "\u001b[?1034h\u001b[34m$\u001b[0m "]
+[0.188660, "o", "r"]
+[0.229757, "o", "e"]
+[0.270692, "o", "s"]
+[0.311781, "o", "t"]
+[0.352810, "o", "i"]
+[0.394051, "o", "s"]
+[0.434368, "o", "h"]
+[0.475367, "o", " "]
+[0.516407, "o", "a"]
+[0.556868, "o", "p"]
+[0.597752, "o", "i"]
+[0.639444, "o", " "]
+[0.681048, "o", "c"]
+[0.722430, "o", "o"]
+[0.763333, "o", "n"]
+[0.805948, "o", "n"]
+[0.845837, "o", "e"]
+[0.886664, "o", "c"]
+[0.927486, "o", "t"]
+[0.968549, "o", " "]
+[1.010207, "o", "t"]
+[1.051288, "o", "u"]
+[1.092439, "o", "t"]
+[1.132578, "o", "o"]
+[1.174078, "o", "r"]
+[1.215378, "o", "i"]
+[1.256107, "o", "a"]
+[1.297256, "o", "l"]
+[1.338090, "o", " "]
+[1.379593, "o", "h"]
+[1.420593, "o", "t"]
+[1.461593, "o", "t"]
+[1.502593, "o", "p"]
+[1.543593, "o", ":"]
+[1.584593, "o", "/"]
+[1.625593, "o", "/"]
+[1.666593, "o", "l"]
+[1.707593, "o", "o"]
+[1.748593, "o", "c"]
+[1.789593, "o", "a"]
+[1.830593, "o", "l"]
+[1.871593, "o", "h"]
+[1.912593, "o", "o"]
+[1.953593, "o", "s"]
+[1.994593, "o", "t"]
+[2.035593, "o", ":"]
+[2.076593, "o", "8"]
+[2.117593, "o", "8"]
+[2.158593, "o", "8"]
+[2.199593, "o", "8"]
+[2.240593, "o", "\r\n\u001b[0m"]
+[2.381000, "o", "Discovered My API\r\n\u001b[0mBase URL: http://localhost:8888\r\n\u001b[0mOpenAPI:  http://localhost:8888/openapi.json\r\n\u001b[0m\r\n\u001b[0mWrote config: ~/.config/restish/restish.json\r\n\u001b[0mConnected API \"tutorial\" with base URL http://localhost:8888 (2 operations discovered - run 'restish tutorial --help')\r\n\u001b[0m"]

docs/docs/tutorial/cli-client.md

@@ -14,44 +14,42 @@ First, install [Restish](https://rest.sh/):
 
 === "Mac"
 
-    Install using Homebrew, Go, or [download a release](https://github.com/danielgtaylor/restish/releases).
+    Install using Homebrew, Go, or [download a release](https://github.com/rest-sh/restish/releases).
 
     ```bash title="Terminal"
     # Homebrew
-    $ brew tap danielgtaylor/restish
     $ brew install restish
 
-    # Go (requires Go 1.18+)
-    $ go install github.com/danielgtaylor/restish@latest
+    # Go
+    $ go install github.com/rest-sh/restish/v2/cmd/restish@latest
     ```
 
 === "Linux"
 
-    Install using Go, Homebrew for Linux, or [download a release](https://github.com/danielgtaylor/restish/releases).
+    Install using Go, Homebrew for Linux, or [download a release](https://github.com/rest-sh/restish/releases).
 
     ```bash title="Terminal"
-    # Go (requires Go 1.18+)
-    $ go install github.com/danielgtaylor/restish@latest
+    # Go
+    $ go install github.com/rest-sh/restish/v2/cmd/restish@latest
 
     # Homebrew for Linux
-    $ brew tap danielgtaylor/restish
     $ brew install restish
     ```
 
 === "Windows"
 
-    Install using Go or [download a release](https://github.com/danielgtaylor/restish/releases).
+    Install using Go or [download a release](https://github.com/rest-sh/restish/releases).
 
     ```bash title="Terminal"
-    # Go (requires Go 1.18+)
-    $ go install github.com/danielgtaylor/restish@latest
+    # Go
+    $ go install github.com/rest-sh/restish/v2/cmd/restish@latest
     ```
 
-Also consider setting up [shell command-line completion](https://rest.sh/#/guide?id=shell-command-line-completion) for Restish.
+Also consider setting up [shell command-line completion](https://rest.sh/docs/getting-started/shell-setup/) for Restish.
 
 ## Configure your API
 
-Next, we need to tell Restish about your API and give it a short name, which we'll call `tutorial`. Do this using the `api configure` command. This only needs to be done one time. Make sure your API is running and accessible before continuing, as this pulls the OpenAPI spec from the service.
+Next, we need to tell Restish about your API and give it a short name, which we'll call `tutorial`. Do this using the `api connect` command. This only needs to be done one time. Make sure your API is running and accessible before continuing, as this pulls the OpenAPI spec from the service.
 
 {{ asciinema("../../terminal/restish-config.cast", rows="8") }}
 
@@ -77,6 +75,6 @@ Congratulations! You just learned:
 Want to learn more about how Restish works and how to use it? Check these out next:
 
 -   [Restish](https://rest.sh/)
--   [Restish OpenAPI 3 support](https://rest.sh/#/openapi)
--   [Restish input](https://rest.sh/#/input)
+-   [Restish OpenAPI reference](https://rest.sh/docs/reference/openapi/)
+-   [Restish input](https://rest.sh/docs/guides/input-and-shorthand/)
 -   [A CLI for REST APIs](https://dev.to/danielgtaylor/a-cli-for-rest-apis-part-1-104b)