From 74781ff81428f153943ac3aee410f6febb0af598 Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 9 Sep 2026 15:14:50 +0000 Subject: [PATCH] docs(data-objectstack): point the two example `baseUrl`s at a reserved placeholder host MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit `content/docs/utilities/data-objectstack.mdx` named `https://api.objectstack.dev` as the example API host in two copyable fences. That domain does not resolve, so a reader who copies either snippet gets a configuration pointed at nothing and finds out only as a runtime network error — no gate goes red and nothing points them back at this page. Both now read `https://api.example.com`, which the other eleven `baseUrl` examples in the same file — and the package's own published `@example` in its shipped `.d.ts` — already use. `example.com` is reserved by RFC 2606, so it can never resolve to somebody's real service: a reader who forgets to change it fails loudly instead of reaching a stranger's host. Adjacent prose now says so in words. Co-Authored-By: Claude Opus 5 Claude-Session: https://claude.ai/code/session_01611D6ZaRaMmwTNQmSbk8MH --- content/docs/utilities/data-objectstack.mdx | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/content/docs/utilities/data-objectstack.mdx b/content/docs/utilities/data-objectstack.mdx index 3b1a03cff0..1927793690 100644 --- a/content/docs/utilities/data-objectstack.mdx +++ b/content/docs/utilities/data-objectstack.mdx @@ -152,7 +152,7 @@ function createObjectStackAdapter(config: { import { createObjectStackAdapter } from '@object-ui/data-objectstack'; const dataSource = createObjectStackAdapter({ - baseUrl: 'https://api.objectstack.dev', + baseUrl: 'https://api.example.com', token: 'your-api-token', cache: { maxSize: 100, ttl: 5 * 60 * 1000 }, autoReconnect: true, @@ -160,6 +160,12 @@ const dataSource = createObjectStackAdapter({ }); ``` +`api.example.com` is a placeholder — here and in every other example on this +page. RFC 2606 reserves `example.com` precisely so documentation can name a host +that can never resolve to somebody's real service, so a snippet copied with it +left in fails loudly instead of reaching a stranger's server. Replace it with +your own ObjectStack server's URL. + Pass a record type to get typed results — the default is `unknown`: ```typescript @@ -361,7 +367,7 @@ Pass your own `fetch` to route requests through a proxy or attach extra headers: import { createObjectStackAdapter } from '@object-ui/data-objectstack'; const dataSource = createObjectStackAdapter({ - baseUrl: 'https://api.objectstack.dev', + baseUrl: 'https://api.example.com', fetch: (input, init) => fetch(input, { ...init, headers: { ...init?.headers, 'X-Tenant': 'acme' } }), });