From 25f275415e7da1fc2625fc843487e073bce78507 Mon Sep 17 00:00:00 2001 From: ivanauth Date: Mon, 22 Jun 2026 10:39:42 -0400 Subject: [PATCH] fix: use placeholders for remote examples in validate/import help (#487) The validate/import help examples hardcoded specific playground, gist, and pastebin URLs. The playground link had rotted, so copy-pasting it failed; the others can rot the same way. Swap all three for fill-in-the-blank placeholders (YOUR_SHARE_ID, etc.) so the features stay discoverable without going stale. The fetch path itself works and is covered by decoder_test.go. Also drops a disabled url_passes test pinned to the dead link, and regenerates docs/zed.md. --- docs/zed.md | 12 ++++++------ internal/cmd/import.go | 6 +++--- internal/cmd/validate.go | 6 +++--- internal/cmd/validate_test.go | 6 ------ 4 files changed, 12 insertions(+), 18 deletions(-) diff --git a/docs/zed.md b/docs/zed.md index ee21bb0c..2e94b6f4 100644 --- a/docs/zed.md +++ b/docs/zed.md @@ -475,13 +475,13 @@ zed import [flags] ``` From a gist: - zed import https://gist.github.com/ecordell/8e3b613a677e3c844742cf24421c08b6 + zed import https://gist.github.com/YOUR_USERNAME/YOUR_GIST_ID From a playground link: - zed import https://play.authzed.com/s/iksdFvCtvnkR/schema + zed import https://play.authzed.com/s/YOUR_SHARE_ID/schema From pastebin: - zed import https://pastebin.com/8qU45rVK + zed import https://pastebin.com/YOUR_PASTE_ID From a devtools instance: zed import https://localhost:8443/download @@ -1416,13 +1416,13 @@ zed validate [flags] zed validate authzed-x7izWU8_2Gw3.yaml From a gist: - zed validate https://gist.github.com/ecordell/8e3b613a677e3c844742cf24421c08b6 + zed validate https://gist.github.com/YOUR_USERNAME/YOUR_GIST_ID From a playground link: - zed validate https://play.authzed.com/s/iksdFvCtvnkR/schema + zed validate https://play.authzed.com/s/YOUR_SHARE_ID/schema From pastebin: - zed validate https://pastebin.com/8qU45rVK + zed validate https://pastebin.com/YOUR_PASTE_ID ``` ### Options diff --git a/internal/cmd/import.go b/internal/cmd/import.go index 8ce71fb9..19a5ba01 100644 --- a/internal/cmd/import.go +++ b/internal/cmd/import.go @@ -25,13 +25,13 @@ func registerImportCmd(rootCmd *cobra.Command) { Short: "Imports schema and relationships from a file or url", Example: ` From a gist: - zed import https://gist.github.com/ecordell/8e3b613a677e3c844742cf24421c08b6 + zed import https://gist.github.com/YOUR_USERNAME/YOUR_GIST_ID From a playground link: - zed import https://play.authzed.com/s/iksdFvCtvnkR/schema + zed import https://play.authzed.com/s/YOUR_SHARE_ID/schema From pastebin: - zed import https://pastebin.com/8qU45rVK + zed import https://pastebin.com/YOUR_PASTE_ID From a devtools instance: zed import https://localhost:8443/download diff --git a/internal/cmd/validate.go b/internal/cmd/validate.go index 635a10b7..ae7ea27c 100644 --- a/internal/cmd/validate.go +++ b/internal/cmd/validate.go @@ -55,13 +55,13 @@ func registerValidateCmd(cmd *cobra.Command) { zed validate authzed-x7izWU8_2Gw3.yaml From a gist: - zed validate https://gist.github.com/ecordell/8e3b613a677e3c844742cf24421c08b6 + zed validate https://gist.github.com/YOUR_USERNAME/YOUR_GIST_ID From a playground link: - zed validate https://play.authzed.com/s/iksdFvCtvnkR/schema + zed validate https://play.authzed.com/s/YOUR_SHARE_ID/schema From pastebin: - zed validate https://pastebin.com/8qU45rVK`, + zed validate https://pastebin.com/YOUR_PASTE_ID`, Args: commands.ValidationWrapper(cobra.MinimumNArgs(1)), ValidArgsFunction: commands.FileExtensionCompletions("zed", "yaml", "yml", "zaml"), PreRunE: validatePreRunE, diff --git a/internal/cmd/validate_test.go b/internal/cmd/validate_test.go index fcabe6ce..d9232736 100644 --- a/internal/cmd/validate_test.go +++ b/internal/cmd/validate_test.go @@ -215,12 +215,6 @@ complete - 0 relationships loaded, 0 assertions run, 0 expected relations valida " 10 | }\n" + " 11 | \n\n\n", }, - // TODO: https://github.com/authzed/zed/issues/487 - // `url_passes`: { - // files: []string{ - // "https://play.authzed.com/s/iksdFvCtvnkR/schema", - // }, - // }, `composable_schema_passes`: { files: []string{ filepath.Join("validate-test", "composable-schema-root.zed"),