Skip to content

Fix VM API reference to use app.prod.validmind.ai#1360

Merged
jamadriz merged 1 commit into
mainfrom
jamadriz/fix/fix-api-route
May 29, 2026
Merged

Fix VM API reference to use app.prod.validmind.ai#1360
jamadriz merged 1 commit into
mainfrom
jamadriz/fix/fix-api-route

Conversation

@jamadriz
Copy link
Copy Markdown
Contributor

Summary

  • Update /reference/vm-api.html RapiDoc spec-url, server-url, and default-api-server from api.prod.validmind.ai to app.prod.validmind.ai
  • Update the get-api-json Makefile target so local swagger downloads use the same host

Test plan

Made with Cursor

The VM API swagger and server URLs moved from api.prod to app.prod; update the RapiDoc page and Makefile fetch target so /reference/vm-api.html loads correctly.

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions
Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal, highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions
Copy link
Copy Markdown
Contributor

PR Summary

The changes in this PR update the VM API endpoints from using the domain api.prod.validmind.ai to app.prod.validmind.ai in two key locations:

  1. In the Makefile (target: get-api-json), the URL used to fetch the VM API Swagger specification has been updated. This ensures that the API spec is fetched from the new VM API endpoint.

  2. In the QMarkdown documentation file (site/reference/vm-api.qmd), the attributes for the rapi-doc component (i.e., spec-url, server-url, and default-api-server) have been updated to reflect the new domain. This ensures that the interactive API documentation displays data from the updated endpoint.

These changes are intended to point the tooling and documentation to the current API infrastructure without altering the underlying API functionalities or data schemas.

Test Suggestions

  • Manually verify that the Makefile successfully downloads the Swagger JSON from the new URL and that an appropriate error message is printed if the fetch fails.
  • Load the QMarkdown page in a browser to ensure the rapi-doc component successfully fetches the new API spec and renders the API documentation correctly.
  • Perform integration tests to confirm that all API calls from the application are routed correctly and that the change in the domain does not introduce connectivity issues.

@jamadriz jamadriz requested a review from validbeck May 29, 2026 14:49
@jamadriz jamadriz added bug Something isn't working internal Not to be externalized in the release notes labels May 29, 2026
@jamadriz jamadriz merged commit d246991 into main May 29, 2026
7 of 10 checks passed
@jamadriz jamadriz deleted the jamadriz/fix/fix-api-route branch May 29, 2026 14:57
@github-actions
Copy link
Copy Markdown
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@validbeck validbeck mentioned this pull request Jun 1, 2026
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants