feature: api documentation versioning #5676
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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds slug-based versioning to the PublishedDocs model, enabling multiple versions of the same documentation to be published under a common slug identifier. The changes migrate from an ID-based URL scheme (/view/{id}/{version}) to a slug-based scheme (/view/{slug}/{version}), improving URL stability and user experience when publishing multiple versions of API documentation.
Key changes:
- Added
slugfield toPublishedDocswith a unique constraint on[slug, version] - Implemented slug generation logic that reuses slugs for the same collection across versions
- Added new REST endpoint
/published-docs/slug/:slug/:versionfor slug-based access - Removed
TreeLevelquery parameter (collections now always export with full tree)
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
prisma/schema.prisma |
Added slug field with unique constraint on [slug, version] and index on collectionID |
prisma/migrations/20251207122817_add_slug_to_published_docs/migration.sql |
Migration to add slug column, handle duplicates, and create indexes |
published-docs/published-docs.model.ts |
Added PublishedDocsVersion model and slug/versions fields to PublishedDocs |
published-docs/published-docs.service.ts |
Added getOrGenerateSlug(), getPublishedDocsVersions(), getPublishedDocBySlugPublic() methods; updated URL generation to use slug |
published-docs/published-docs.service.spec.ts |
Added comprehensive tests for new slug-based functionality and version retrieval |
published-docs/published-docs.resolver.ts |
Added versions field resolver for GraphQL |
published-docs/published-docs.controller.ts |
Added slug-based endpoint /slug/:slug/:version; deprecated ID-based endpoint |
published-docs/published-docs.dto.ts |
Removed TreeLevel enum and GetPublishedDocsQueryDto class (no longer needed) |
user-collection/user-collection.service.ts |
Removed withChildren parameter from exportUserCollectionToJSONObject() (always exports full tree) |
team-collection/team-collection.service.ts |
Removed withChildren parameter from exportCollectionToJSONObject() (always exports full tree) |
prisma/prisma.service.ts |
Enhanced acquireLocks() and lockTableExclusive() to support non-public database schemas |
mock-server/mock-server.service.spec.ts |
Code formatting improvements (no functional changes) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
packages/hoppscotch-backend/src/published-docs/published-docs.service.ts
Show resolved
Hide resolved
packages/hoppscotch-backend/src/published-docs/published-docs.service.ts
Outdated
Show resolved
Hide resolved
packages/hoppscotch-backend/src/user-collection/user-collection.service.ts
Show resolved
Hide resolved
packages/hoppscotch-backend/src/team-collection/team-collection.service.ts
Show resolved
Hide resolved
...hoppscotch-backend/prisma/migrations/20251207122817_add_slug_to_published_docs/migration.sql
Show resolved
Hide resolved
packages/hoppscotch-backend/src/published-docs/published-docs.controller.ts
Outdated
Show resolved
Hide resolved
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.
Closes BE-685
What's changed
Backend Changes
Adds stable slugs to PublishedDocs and a new public endpoint to fetch docs by slug and version, enabling consistent URLs and version lists. The old id-based endpoint remains but is deprecated.
New Features
slug=idand removes duplicate docs per collection+version.PublishedDocsincludesslugandversions[]resolver returns all versions for the slug.createPublishedDocreuses a collection’s slug for new versions, retries on unique constraint races, and snapshots documentTree whenautoSync=false.Database Migration
pnpx prisma migrate deployFrontend Changes
Notes to reviewers
Run DB migration.
Summary by cubic
Adds stable slugs to PublishedDocs and a new public endpoint to fetch docs by slug and version, enabling consistent URLs and version lists. The old id-based endpoint remains but is deprecated.
New Features
Migration
Written for commit 5b4bf5b. Summary will update automatically on new commits.