docs: Sync edge server documentation with latest features#243
Open
Jordan Baxter (baxterjo) wants to merge 5 commits intomainfrom
Open
docs: Sync edge server documentation with latest features#243Jordan Baxter (baxterjo) wants to merge 5 commits intomainfrom
Jordan Baxter (baxterjo) wants to merge 5 commits intomainfrom
Conversation
Updated edge-server/README.md to reflect new features from edge_server source:
- Added documentation for new HTTP API endpoints:
- POST /execute for DQL query execution
- POST /attachments/upload and GET /attachments/{id}
- GET /presence for presence graph viewing
- GET /logs for log download
- GET /docs for API documentation
- Added Advanced Security Features section covering:
- HTTPS/TLS 1.2 and 1.3 support
- API key authentication
- Permission-based access control
- Audit logging
- HTTP request throttling
- Configurable connection limits and timeouts
Synced from edge_server CHANGELOG unreleased features.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Jordan Baxter (baxterjo)
requested review from
Copilot and
Nick Robinson (nickrobinson)
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Edge Server quickstart documentation to reflect newly supported HTTP endpoints and production-grade security capabilities, aligning edge-server/README.md with the upstream “source of truth” docs.
Changes:
- Documented additional HTTP endpoints (execute, attachments, monitoring/diagnostics).
- Added a section describing advanced security features for production deployments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
edge-server/README.md
Outdated
| # Execute custom DQL statements | ||
| curl -X POST http://localhost:8080/my_server/execute \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{"query": "SELECT * FROM tasks"}' |
There was a problem hiding this comment.
The /execute example posts {"query": ...}, but the rest of this quickstart (e.g., requests/*.json and the just recipes that call /execute) uses a statement field (and optionally args). As written, this example is likely to fail against the quickstart edge server configuration. Update the payload key(s) to match the existing /execute request schema used elsewhere in this repo.
Suggested change
| -d '{"query": "SELECT * FROM tasks"}' | |
| -d '{"statement": "SELECT * FROM tasks"}' |
Add comprehensive documentation for: - OpenAPI specification access (runtime and offline generation) - Configuration schema generation for IDE autocomplete - Usage examples with common tools (Swagger UI, Postman, etc.) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
The OpenAPI spec is now generated from real HTTP handlers, ensuring it stays in sync with actual API behavior. Updated docs to highlight: - Generated from real handlers (21+ schema definitions) - Complete error responses (401, 403, 413, 429, 431, 500) - All status codes with detailed schemas - Authentication requirements and formats - Enhanced use cases (contract testing, API gateways, SDKs) - CI/CD integration examples Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Update Edge Server quickstart configuration to use the new flat schema structure instead of the deprecated resources wrapper. Changes: - Replace `resources:` wrapper with flat `database:` and `http_server:` structure - Update endpoint paths from `/my_server/execute` to `/execute` - Add required `tls_config`, `auth`, and `logging` sections - Remove deprecated `base_path` field - Remove deprecated `databases:` map structure The HTTP API request body still uses "statement" field (not "query") as this is the external API contract. Verified with full quickstart test workflow: ✅ Config validation passes ✅ Server starts successfully ✅ Create task works ✅ Get tasks works ✅ Update task works ✅ Delete task works Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Update all HTTP API endpoint examples to reflect the new Edge Server schema that removes the base_path field. Changes: - Remove `/my_server` prefix from all endpoint examples - Update execute endpoint: `/my_server/execute` → `/execute` - Update attachments: `/my_server/attachments/*` → `/attachments/*` - Update presence: `/my_server/presence` → `/presence` - Update logs: `/my_server/logs` → `/logs` - Update docs: `/my_server/docs` → `/docs` - Fix execute request body: `"query"` → `"statement"` (correct HTTP API field) - Update OpenAPI spec URL to `/docs/edge_server_api.json` - Remove mention of base_path in configuration description - Enable `serve_docs: true` in sample config so doc examples work All examples tested and verified working with new schema. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Jonathan Reyes (jreyes33)
approved these changes
Mar 6, 2026
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.
Summary
Synced edge-server/README.md with latest features from the edge_server source of truth repository.
Changes
New API Endpoints Documented
/execute- Execute DQL statements/attachments/upload- Upload attachments/attachments/{id}- Download attachments/presence- View presence graph/logs- Download server logs/docs- View API documentationNew Security Features Documented
Source
These updates are based on the unreleased features documented in the edge_server CHANGELOG.
Testing
Documentation-only changes. No code modifications.
🤖 Generated with Claude Code