fix(docs): scope worlds-api pages to their own directory to stop slug collisions - #101
Merged
Merged
Conversation
… collisions Both OpenAPI specs now share identical x-mint titles (List worlds, Get world, ...), so Mintlify generated colliding /api-reference slugs and the Platform API group's five worlds CRUD pages were silently dropped. Scope the Worlds API group to directory "worlds-api" (Mintlify's documented fix), restoring all 14 wazoo-api pages and giving worlds-api 16 distinct pages including the three previously missing ops (revoke-api-key, sparql-without-world, reindex). Also: widen the title checker's sitemap filter to cover /worlds-api pages, add redirects for the six worlds-api pages that move, and make "operations missing from docs" informational (9 wazoo-api billing/limits/usage/token-admin ops are intentionally not in the nav).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
After the x-mint title deploy (wazoo-api commit
317812e, worlds-api PR #16), both OpenAPI specs share identical operation titles ("List worlds", "Get world", "Update world", "Delete world", "Undelete world", "Get health"). Mintlify generates slugs from those titles, so the two specs' pages collided on/api-reference/worlds/*— and the 5 wazoo-api platform CRUD pages silently dropped (the Worlds API group won the slug race).Verified empirically: the dev server resolved the Platform API group's
GET /v1/worldsentries to worlds-api operations.Fix
directory: "worlds-api"— Mintlify's documented approach for multiple specs with colliding titles. wazoo-api pages stay at/api-reference/*(URLs unchanged), worlds-api moves to/worlds-api/*.pageslist — including the three that had no page at all:DELETE /api-keys/{keyId}(Revoke API key),POST /worlds/sparql(SPARQL without world),POST /worlds/{id}/reindex(Reindex)./api-reference/worlds/*slugs now belong to wazoo-api, so they must NOT be redirected)./api-reference/and/worlds-api/; "operations missing from docs" is informational (9 wazoo-api billing/limits/usage/token-admin ops are intentionally not in the nav).Verified
mintlify validate✅,prettier --check docs.json✅Post-merge
Merging triggers the Mintlify redeploy. After that the checker should show: wazoo-api 14 pages, worlds-api 16 pages, zero findings, zero unintended missing ops.