Update Hosted API docs for background operations - #215
Merged
Merged
Conversation
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
Review comments are limited to minor documentation nits with no approval-blocking issues.
Review effort: Lite
Findings: None
What changed in this PR
Updates Hosted v1 API documentation for asynchronous backups, version changes, instance reboots, and operation polling.
Changes:
- Extends the OpenAPI specification with new endpoints and operation schemas.
- Regenerates deployment, model, operation, and overview documentation.
- Adds Operation navigation and generator support.
| File | Description |
|---|---|
specs/hosted-v1.yaml |
Defines new endpoints, schemas, and operation semantics. |
site/dolt/src/nav.ts |
Adds Operation navigation. |
site/dolt/src/content/products/hosted/api/v1/README.md |
Updates endpoint overview and asynchronous behavior. |
site/dolt/src/content/products/hosted/api/v1/operation.md |
Documents operation polling. |
site/dolt/src/content/products/hosted/api/v1/models.md |
Documents new request and response models. |
site/dolt/src/content/products/hosted/api/v1/deployment.md |
Documents backup, version, and reboot endpoints. |
scripts/generate-hosted-api-v1.mjs |
Registers Operation page generation. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Updates the Hosted v1 API docs from the OpenAPI spec on
ld/mainat69b359bd0e6, documenting on-demand backups, database version listing and changes, instance reboots, and operation polling.Regenerates deployment and model pages, adds the Operation page to the generator and navigation, and updates the overview with all new endpoints and their asynchronous completion behavior.
Validation:
npm run build:doltpassed (CSS:globalwarnings).git diff --checkpassed.