docs: DoltHub API v2 reference pages#121
Merged
Merged
Conversation
Adds generated reference docs for the v2 API alongside the existing v1alpha1 pages.
- `specs/dolthub-v2.yaml` — copy of the OpenAPI spec from the dolthub app repo; update this and re-run the generator when the spec changes
- `scripts/generate-api-v2.mjs` — Node.js generator that reads the spec and writes one Markdown page per tag (user, database, operations) plus a models page; run with `npm run generate-api-v2` from `site/dolt/`
- `site/dolt/src/content/products/dolthub/api/v2/` — generated pages (database.md, user.md, operations.md, models.md) plus hand-written README.md and authentication.md
- nav.ts — v2 added as a sibling of v1alpha1 under DoltHub → API
- astro.mjs — migrated remarkPlugins/rehypePlugins from deprecated `markdown.*` config to the `unified({...})` integration from `@astrojs/markdown-remark`; added `remark-heading-id` so `{#anchor}` syntax in generated headings produces real HTML id attributes
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This is a yarn workspace; package-lock.json should not be tracked. Add package-lock.json to .gitignore and commit yarn.lock instead. Also remove the packageManager field added erroneously to root package.json. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
package-lock.json was removed in favor of yarn.lock; update both workflows to use yarn for installs and set cache: "yarn". Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
yarn hoists packages differently from npm; @types/node was previously resolved transitively but needs to be explicit since root tsconfig.json references it in "types". Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Covers URL changes, response envelope, RFC 9457 error model, cursor pagination, unified async operations, and a full endpoint mapping table. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Pulls the latest v2.yaml from origin/main which adds:
- POST /api/v2/databases/{owner}/{database}/forks (createFork)
- GET /api/v2/databases/{owner}/{database}/operations (listOperations)
Regenerates database.md (21 endpoints) and operations.md (2 endpoints),
and fixes the migration guide to use the real paths instead of guesses.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Point new integrations to v2, demote v1alpha1 to "still supported", and link to the migration guide. Split CSV/Webhooks into their own section. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Revert the yarn migration — restore package-lock.json, drop yarn.lock, and update CI workflows to use npm install/cache instead of yarn. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
The initial lockfile only recorded the darwin-arm64 rollup binary, hitting the npm/cli#4828 optional-deps bug on Linux CI runners ("Cannot find module @rollup/rollup-linux-x64-gnu"). A clean reinstall with node_modules removed first produces a lockfile with resolved entries for every optional platform variant. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
unified({ remarkPlugins, rehypePlugins }) from @astrojs/markdown-remark
returns a MarkdownProcessor, not an Astro integration — it was being
passed into the integrations array where Astro silently ignored it, so
remark-heading-id never ran and headings rendered with the literal
{#customId} syntax still in the text. Astro 6.4+ expects this processor
under markdown.processor instead.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
npm ci was an unnecessary leftover from the yarn revert — dev's site.yaml already used plain npm install, so .github should have no diff against the PR base branch. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Move the v1alpha1 and v2 generation instructions out of Caveats into their own section, and document the v2 generate-api-v2 workflow that was missing. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
README.md's endpoint table is hand-written and wasn't updated when 7c72962 regenerated database.md/operations.md with these two endpoints. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.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
/products/dolthub/api/v2/alongside the existing v1alpha1 pagesuser,database,operations) plus amodelspage and hand-writtenREADME+authenticationpages###headings per pageHow to update when the spec changes
cp path/to/ld/web/packages/dolthub/openapi/v2.yaml specs/dolthub-v2.yamlnpm run generate-api-v2(fromsite/dolt/)Technical notes
scripts/generate-api-v2.mjsreadsspecs/dolthub-v2.yaml, resolves internal$refs, groups endpoints by tag and sub-resource, and emits one Markdown file per tagremark-heading-idso{#operationId}syntax in generated headings produces real HTMLidattributes — allows deep-linking from the endpoint index and cross-page schema linksmarkdown.remarkPlugins/markdown.rehypePluginsinastro.mjsto theunified({...})integration from@astrojs/markdown-remark(was deprecated in Astro 5+)Test plan
npm run buildfromsite/dolt/passes clean/products/dolthub/api/v2renders the overview with the full endpoint index/products/dolthub/api/v2/databaseright nav shows endpoint summaries (not paths)Database,Problem) navigate to the correct anchor on the models page{#createDatabase}-style anchors resolve —database#createDatabasedeep-links to the right heading🤖 Generated with Claude Code