From 65a1ab03ca51c1abf8e45f5b29e6c40f6ee6e2b6 Mon Sep 17 00:00:00 2001 From: Mike McKiernan Date: Thu, 11 Jun 2026 15:00:36 -0400 Subject: [PATCH] chore: Demo duplicate path removal Signed-off-by: Mike McKiernan --- versioning/fern/docs.yml | 2 +- versioning/fern/versions/v2.yml | 6 ++++++ .../versions/v2/pages/guides/authentication.mdx | 14 ++++++++++++++ .../fern/versions/v2/pages/guides/webhooks.mdx | 17 +++++++++++++++++ versioning/fern/versions/v2/pages/migration.mdx | 2 ++ versioning/fern/versions/v2/pages/welcome.mdx | 10 ++++++++++ 6 files changed, 50 insertions(+), 1 deletion(-) create mode 100644 versioning/fern/versions/v2/pages/guides/authentication.mdx create mode 100644 versioning/fern/versions/v2/pages/guides/webhooks.mdx diff --git a/versioning/fern/docs.yml b/versioning/fern/docs.yml index d1a2381..cacbb1b 100644 --- a/versioning/fern/docs.yml +++ b/versioning/fern/docs.yml @@ -1,7 +1,7 @@ # yaml-language-server: $schema=https://schema.buildwithfern.dev/docs-yml.json instances: - - url: versioning.docs.buildwithfern.com + - url: versioning.docs.buildwithfern.com/guides title: Fern Docs Versioned Example diff --git a/versioning/fern/versions/v2.yml b/versioning/fern/versions/v2.yml index a0c4ea4..e9aebf8 100644 --- a/versioning/fern/versions/v2.yml +++ b/versioning/fern/versions/v2.yml @@ -11,6 +11,12 @@ navigation: contents: - page: Migrating to Latest path: ./v2/pages/migration.mdx + - section: Bringing it Back + contents: + - page: Authentication + path: ./v2/pages/guides/authentication.mdx + - page: Webhooks + path: ./v2/pages/guides/webhooks.mdx - section: Resources contents: - page: Shared resource diff --git a/versioning/fern/versions/v2/pages/guides/authentication.mdx b/versioning/fern/versions/v2/pages/guides/authentication.mdx new file mode 100644 index 0000000..06c2f83 --- /dev/null +++ b/versioning/fern/versions/v2/pages/guides/authentication.mdx @@ -0,0 +1,14 @@ +--- +title: Authentication +subtitle: Authenticate requests with an API key +slug: guides/authentication +--- + +Every request must include your API key in the `Authorization` header: + +```bash +curl https://api.example.com/v4/widgets \ + -H "Authorization: Bearer $API_KEY" +``` + +Keys are scoped to a single environment. Rotate them from the dashboard. diff --git a/versioning/fern/versions/v2/pages/guides/webhooks.mdx b/versioning/fern/versions/v2/pages/guides/webhooks.mdx new file mode 100644 index 0000000..9af686b --- /dev/null +++ b/versioning/fern/versions/v2/pages/guides/webhooks.mdx @@ -0,0 +1,17 @@ +--- +title: Webhooks +subtitle: Receive real-time events from the API +slug: guides/webhooks +--- + +Register a webhook endpoint in the dashboard. We'll POST a signed JSON payload to it whenever a subscribed event fires. + +```ts +app.post("/webhook", (req, res) => { + verifySignature(req.headers["x-example-signature"], req.rawBody); + handle(req.body); + res.sendStatus(200); +}); +``` + +Respond with a 2xx within 5 seconds or the delivery will be retried with exponential backoff. diff --git a/versioning/fern/versions/v2/pages/migration.mdx b/versioning/fern/versions/v2/pages/migration.mdx index de1e4f3..a759d67 100644 --- a/versioning/fern/versions/v2/pages/migration.mdx +++ b/versioning/fern/versions/v2/pages/migration.mdx @@ -8,6 +8,8 @@ slug: migration v2 is deprecated. Plan to migrate to [Latest](/welcome) before the next major release. +If you disagree, proceed to the [quickstart](/quickstart). + ## What changed - `ExampleClient` was renamed to `Client`. diff --git a/versioning/fern/versions/v2/pages/welcome.mdx b/versioning/fern/versions/v2/pages/welcome.mdx index 2904c8c..8bcf685 100644 --- a/versioning/fern/versions/v2/pages/welcome.mdx +++ b/versioning/fern/versions/v2/pages/welcome.mdx @@ -9,3 +9,13 @@ slug: welcome This is the v2 version of the docs. Its pages are served from versioned URLs like `/v2/welcome` and `/v2/quickstart`. + +FIXME: If you've seen the future...and you know it includes authz/authn, we're bringing [authorization](/guides/authorization) back! + +Just kidding. +The path to the preceding authorization URL is `/guides/authentication`. +That file exists in the source: + + + +...but because of the potential duplicate "guides/guides" in the nav bar, one is stripped away.