Validate Mintlify slugs across OpenAPI specs#781
Draft
danielporterda wants to merge 1 commit into
Draft
Conversation
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
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.
Summary
Follow-up to #780. Extend the Mintlify-safe OpenAPI summary handling and validation across every published OpenAPI spec under
docs-main/openapi, not just the Splice Token Metadata regression case.Changes
GET /path/{param}summaries are rewritten toGET /path/:parambefore Mintlify sees them.scripts/validate_mintlify_openapi_slugs.pyandnpm run validate:mintlify-openapi-slugsto scan all published OpenAPI specs for Mintlify-style operation route collisions.Regeneration
Ran both OpenAPI generation paths:
direnv exec . npm run generate:json-api-referencedirenv exec . npm run generate:splice-mintlify-openapiNo additional generated output changes were produced on top of current
main/ #780.Validation
direnv exec . npm run validate:mintlify-openapi-slugs(12 specs)direnv exec . python3 -m pytest tests/test_json_api_openapi.py tests/test_splice_mintlify_openapi.pydirenv exec . npm run validate:splice-mintlify-openapi-navdirenv exec . python3 -m py_compile scripts/generate_json_api_reference.py scripts/generate_splice_mintlify_openapi.py scripts/validate_splice_mintlify_openapi_nav.py scripts/validate_mintlify_openapi_slugs.pydirenv exec . git diff --check