Skip to content

WIP: align platform docs with canonical identifiers - #179

Draft
EthanThatOneKid wants to merge 2 commits into
mainfrom
platform-id-cutover
Draft

EthanThatOneKid wants to merge 2 commits into
mainfrom
platform-id-cutover

Conversation

@EthanThatOneKid

Copy link
Copy Markdown
Contributor

Status: draft staging branch, not a merge unit

This preserves the documentation and OpenAPI-example updates for review. It documents the server-minted World ID across management- and data-plane usage. The branch also includes broader public-resource identifier examples and drift checks that belong to wazootech/workspace#148.

Do not merge the complete diff as the active world-identity cutover. Split world-specific examples from the all-resource ID/primary-key normalization before treating either as independently releasable. See wazootech/wazoo-api#63 for the active contract and wazootech/workspace#144 for coordination.

Local validation

  • npm run precommit — passed (format and documentation build validation)

No release, deployment, or database reset was performed or authorized by this draft.

@wazoocomputer

wazoocomputer Bot commented Sep 28, 2026

Copy link
Copy Markdown

This pull request, titled "WIP: align platform docs with canonical identifiers," updates the documentation to align with canonical identifiers, specifically addressing the shift to server-minted World IDs and other public resource identifiers. This includes changes to CI workflows, documentation files, and OpenAPI specifications to reflect the new ID formats and deprecate legacy naming conventions like _uid.

Here's a breakdown of the changes in this pull request:

File Path Change Type Summary
.github/workflows/ci.yml modified Adds a CI check to reject legacy platform identity names in documentation.
contribute/security.mdx modified Updates user_uid to user_id.
docs.json modified Updates OpenAPI paths and replaces id with worldId and keyId with apiKeyId in World API documentation.
getting-started.mdx modified Clarifies that World IDs are server-minted and not user-chosen.
guides/company-brain.mdx modified Updates wazoo worlds create command and clarifies that the Worlds API mints immutable w_<UUIDv4> IDs.
guides/entity-resolution.mdx modified Updates example curl commands to use the new w_<UUIDv4> World ID format.
openapi/wazoo-api.json added Adds the OpenAPI specification for the Wazoo Platform API.
openapi/worlds-api.json added Adds the OpenAPI specification for the Worlds API.
platform/api.mdx modified Updates API documentation.
platform/typescript-sdk.mdx modified Updates TypeScript SDK documentation.
projects/worlds.mdx modified Updates Worlds project documentation.
quickstart.mdx modified Updates quickstart guide.
reference/cli/usage.mdx modified Updates CLI usage documentation.
reference/cli/worlds.mdx modified Updates CLI worlds documentation.
skills/wazoo.mdx modified Updates Wazoo skills documentation.
worlds/client.mdx modified Updates Worlds client documentation.
worlds/query.mdx modified Updates Worlds query documentation.
worlds/search.mdx modified Updates Worlds search documentation.
worlds/update.mdx modified Updates Worlds update documentation.

Reviewers should begin by examining the changes to .github/workflows/ci.yml and docs.json to understand the core identifier changes.

@EthanThatOneKid

Copy link
Copy Markdown
Contributor Author

Superseded by its non-WIP successor #180.

@EthanThatOneKid
EthanThatOneKid deleted the platform-id-cutover branch October 10, 2026 17:00
@EthanThatOneKid
EthanThatOneKid restored the platform-id-cutover branch October 10, 2026 17:53
@EthanThatOneKid

Copy link
Copy Markdown
Contributor Author

Reopened, with the branch restored at its original head. I closed this by mistake as "superseded". wazoo-api#71 keeps it as staging for the resource-ID cleanup (workspace#148), not as a world-ID merge unit. Nothing in it changed.

@EthanThatOneKid

EthanThatOneKid commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor Author

Update: #183 (pnpm migration) merged after #185 fixed main's check failure (the live Worlds spec renamed {id} to {worldId}; #185 makes the same docs.json change this PR does). When you pick this up, merge main in: besides the existing content conflicts, ci.yml will conflict next to your "Reject legacy platform identity names" step. Keep your step and take main's pnpm commands. Happy to resolve that if you want.

@EthanThatOneKid

Copy link
Copy Markdown
Contributor Author

Tracker moved: resource-ID normalization (formerly workspace#148, now frozen in the archived workspace-v1) is tracked in wazootech/wazoo-api#101. This draft is still staging for it. It predates the w_<ULID> world-ID switch (worlds-api#118), so rebase or rewrite it before it's used.

This branch has not been deployed

No deployments
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.

1 participant