Point API reference at deployed OpenAPI spec - #8
Draft
devin-ai-integration[bot] wants to merge 2 commits into
Draft
Point API reference at deployed OpenAPI spec#8devin-ai-integration[bot] wants to merge 2 commits into
devin-ai-integration[bot] wants to merge 2 commits into
Conversation
- Switch docs.json openapi source from openapi.json to https://api.consensus.app/openapi.json. - Delete the now-redundant openapi.json. - Update api-get-started.mdx search endpoint card href to /api-reference/get-search. Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
The Mintlify page slug is derived from the OpenAPI operation summary. Since the summary is now '/search' (not 'GET /search'), the href becomes /api-reference/search. Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
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.
Summary
Switch the Mintlify API reference to consume the public OpenAPI spec served by the deployed API (
https://api.consensus.app/openapi.json) instead of a committedopenapi.jsoncopy. Delete the localopenapi.jsonand update the get-started card to the new generated endpoint slug (/api-reference/search).Merge order
Consensus-NLP/common#8275to production sohttps://api.consensus.app/openapi.jsonreturns the spec.Note on preview failure
The Mintlify preview deployment on this PR will fail with
Failed to fetch OpenAPI file for anchor or tabuntil the remote endpoint above is live. The generated page slug is/api-reference/search(from the/searchoperation summary) and the deprecated legacy endpoint will appear at/api-reference/quick_search.Link to Devin session: https://app.devin.ai/sessions/0f4920c7851a4f3a99ee9061159065f3
Requested by: @aakashadesara