Skip to content

feat: pointing mintlify docs at stainless generated openapi#210

Open
pengying wants to merge 1 commit intomainfrom
02-18-feat_pointing_mintlify_docs_at_stainless_generated_openapi
Open

feat: pointing mintlify docs at stainless generated openapi#210
pengying wants to merge 1 commit intomainfrom
02-18-feat_pointing_mintlify_docs_at_stainless_generated_openapi

Conversation

@pengying
Copy link
Contributor

@pengying pengying commented Feb 19, 2026

TL;DR

Updated the OpenAPI specification URL in the Mintlify documentation configuration.

What changed?

Changed the OpenAPI specification source from a local file openapi.yaml to a remote URL https://app.stainless.com/api/spec/documented/grid/openapi.documented.yml in the docs.json file.

How to test?

  1. Build and deploy the Mintlify documentation
  2. Navigate to the API documentation section
  3. Verify that the API documentation is properly loading from the new URL
  4. Check that all endpoints and schemas are correctly displayed

Why make this change?

This change points our documentation to the official Stainless API specification, ensuring that our documentation always reflects the most up-to-date API definitions. Using the remote URL eliminates the need to manually update a local copy of the OpenAPI specification file whenever the API changes.

Copy link
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@pengying pengying marked this pull request as ready for review February 19, 2026 05:17
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 19, 2026

Greptile Summary

This PR updates the Mintlify documentation configuration to point to the Stainless-hosted OpenAPI specification instead of a local file. The change modifies mintlify/docs.json to use the remote URL https://app.stainless.com/api/spec/documented/grid/openapi.documented.yml rather than the local openapi.yaml file.

Key changes:

  • Replaced local OpenAPI spec reference with remote Stainless URL
  • Ensures documentation stays synchronized with the official API specification
  • Eliminates manual updates to local OpenAPI files

Considerations:

  • The local openapi.yaml file still exists in the mintlify/ directory and may need to be cleaned up or documented as deprecated
  • Documentation now depends on external URL availability
  • According to CLAUDE.md, the bundled openapi.yaml files are generated by make build and shouldn't be edited directly, so this change aligns with using the authoritative source

Confidence Score: 5/5

  • This PR is safe to merge with minimal risk
  • This is a straightforward configuration change that updates a single URL reference in the documentation config. The change aligns with the repository's architecture of using Stainless for API spec management, and there are no code logic changes, security concerns, or breaking changes introduced
  • No files require special attention

Important Files Changed

Filename Overview
mintlify/docs.json Changed OpenAPI spec from local file to remote Stainless URL

Last reviewed commit: 404337e

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

Comments