REST Section Migration#457
Merged
Ethan-Arrowood merged 1 commit intomajor-version-reorgfrom Mar 18, 2026
Merged
Conversation
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-457 This preview will update automatically when you push new commits. |
Adds all 5 pages of the REST reference section: - overview.md: HTTP methods (GET/PUT/POST/PATCH/DELETE), URL structure, ETag caching, OpenAPI endpoint - querying.md: Full URL query syntax — FIQL operators, unions, grouping, select/limit/sort functions, relationships/joins, null queries, type conversion - headers.md: Request/response headers (ETag, If-None-Match, Content-Type, Accept, etc.) - content-types.md: JSON, CBOR, MessagePack, CSV — with encoding recommendations - websockets.md: WebSocket connections, custom connect() handler, MQTT-over-WS, message ordering - server-sent-events.md: SSE connections, one-directional streaming, connect() usage Also adds rest-link-placeholders.md and marks REST section Complete in migration map. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Ethan-Arrowood
force-pushed
the
rest-section-migration
branch
from
9f4cdcf to
3e18d01
Compare
🚀 Preview DeploymentYour preview deployment is ready! 🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-457 This preview will update automatically when you push new commits. |
25 tasks
🧹 Preview CleanupThe preview deployment for this PR has been removed. |
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
2 participants
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
Adds the REST reference section (
reference_versioned_docs/version-v4/rest/) with 5 pages:GET /openapi)()and[],select()/limit()/sort()functions, relationships/joins with dot-syntax, null queries, type conversion rules,directURLMappingETag,If-None-Match,Content-Type,Accept,Accept-Encoding,Authorization,Sec-WebSocket-Protocolconnect()handler, MQTT-over-WebSocket, message ordering in distributed environmentsconnect()withoutincomingMessages, SSE vs WebSockets comparisonAlso adds
migration-context/link-placeholders/rest-link-placeholders.mdand marks all REST entries as Complete inv4-docs-migration-map.md.Pending TODO: links
database/schema.md— referenced fromoverview.mdandquerying.md(PENDING Database section migration)resources/overview.md— referenced fromwebsockets.mdandserver-sent-events.md(PENDING Resources section migration)Test plan
versioned_docs/version-4.7/developers/rest.md,real-time.md,reference/headers.md,reference/content-types.md)Added in: v4.2.0,v4.3.0,v4.5.0)../http/,../mqtt/,../security/)v4-docs-migration-map.mdREST section entries are all marked Complete🤖 Generated with Claude Code