docs: Add comprehensive API endpoint documentation #47
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
- Add new API.md with complete endpoint documentation - Document all 6 API endpoints with request/response examples - Include authentication, error handling, and usage examples - Update docs/README.md to link to API documentation
Author
|
Please note this documentation was drafted with the help of AI so we def need to get some closer looks |
bonus414
requested review from
bomoko,
bryangruneberg,
dan2k3k4 and
rocketeerbkw
Contributor
|
I'm not sure if anyone plans to do anything via the API routes, but we should add documentation around the |
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
This PR adds comprehensive API endpoint documentation for the Polydock Engine REST API.
Changes
docs/API.md- Complete API documentation covering all 6 endpointsdocs/README.md- Added link to API documentationDocumentation Includes
All 6 API endpoints with detailed specifications:
GET /api/user- Get current authenticated userPOST /api/register- Register a new userGET /api/register/{uuid}- Get registration statusGET /api/regions- Get available regions and appsGET|POST /api/instance/{uuid}/health/{status}- Update instance health statusGET /app-instances/{appInstance}- Redirect to app instanceRequest/response examples with JSON
Authentication requirements
Error handling documentation
Status codes and error responses
cURL examples for each endpoint
Rate limiting information
Review Notes
Please review for: