Repository navigation
fix(docs): preserve v3 API docs without the unavailable Stainless spec - #2943
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
|
|
Post-deployment verification: Mintlify preview deployment passed and persisted all 32 API pages. I fetched all 32 API-reference Markdown pages from https://stagehand-fix-docs-v3-openapi-source.mintlify.site and compared them with the production baseline captured before this change. Every page passed deep equality for its full OpenAPI document (including schemas, descriptions, auth, and code samples), plus equality of the surrounding Markdown after normalizing only the site origin and spec-source metadata. Result: 32/32 match; no docs content differences found. |
There was a problem hiding this comment.
All reported issues were addressed across 4 files
Architecture diagram
sequenceDiagram
participant Dev as Developer
participant CI as CI Pipeline
participant Mint as Mintlify CLI
participant Spec as v3/openapi.json
participant Docs as Mintlify Build
participant Tests as Vitest Test Suite
Note over Dev,Tests: Runtime Flow After This PR
Dev->>CI: Push docs changes
CI->>Mint: Run mint validate
Note over Mint,Spec: NEW: Spec resolution now local
Mint->>Spec: Read v3/openapi.json (local file)
Spec-->>Mint: OpenAPI spec content
alt Spec unavailable or invalid
Mint-->>CI: Validation failed
CI-->>Dev: Build blocked
end
Mint->>Docs: Generate v3 API reference pages
Docs->>Docs: Create pages for Python, Java, Go, Ruby
CI->>Mint: Run broken-links check
Mint->>Spec: Resolve $ref pointers in spec
Spec-->>Mint: Local schema references
CI->>Tests: Run vitest suite
Tests->>Spec: Read openapi.json
Tests->>Spec: Validate endpoint titles & code samples
Tests->>Spec: Check schema refs resolve locally
Tests->>Spec: Verify auth schemes & server config
alt All tests pass
Tests-->>CI: 11/11 regression tests pass
CI-->>Dev: Validation complete
else Test failure
Tests-->>CI: Test assertions failed
CI-->>Dev: Investigation needed
end
Note over CI,Mint: Future spec updates ride on explicit content changes
Reply with feedback, questions, or to request a fix.
Re-trigger cubic
Summary
mint validatefailing witherror 404 Not Foundbecause the configured Stainless OpenAPI endpoint is unavailable. Reproduced with the CI-pinnedmint@4.2.788on current main before making changes.No-content-regression verification
Validation
mint validatemint broken-links --check-anchors --check-redirects --check-snippetsmint a11y --skip-contrast(145 MDX files)vitest run packages/docs/tests(38 tests)git diff --checkThis fixes the shared docs-validation failure blocking #2939 without modifying its content. Future v3 spec updates must be reviewed as explicit content changes rather than fetched during every build.
Summary by cubic
Fixes Mint validation failing with a 404 from the unavailable Stainless OpenAPI endpoint by switching the v3 API reference to a checked-in snapshot. The snapshot was recovered from the published v3 API pages, so the existing endpoints, schemas, auth, and code samples are unchanged. Future v3 spec updates must be reviewed as explicit content changes.
Changes
docs.jsonOpenAPI source references withv3/openapi.json.packages/docs/v3/openapi.json, containing 8 endpoints, 67 schemas, 2 security schemes, and 8 code-sample languages.packages/docs/README.md.Validation
mint validate, broken-links, a11y, and docs tests pass.Written for commit 5f49e60. Summary will update on new commits.