docs: improve backend API routes documentation #1145
Closed
Conversation
This file contains 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
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
- Add reserved routes table - Include token and state examples - Document rx.Base limitations - Add utility function examples - Include nginx conflict resolution Co-Authored-By: Alek Petuskey <alek@reflex.dev>
Co-Authored-By: Alek Petuskey <alek@reflex.dev>
Co-Authored-By: Alek Petuskey <alek@reflex.dev>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
⚙️ Control Options:
Add "(aside)" to your comment to have me ignore it. |
Co-Authored-By: Alek Petuskey <alek@reflex.dev>
- Use raw string markers for dictionary keys
- Change route parameters from {param} to [param] syntax
- Update dictionary returns to prevent template evaluation
- Use model_dump() instead of dict() for Pydantic V2
Co-Authored-By: Alek Petuskey <alek@reflex.dev>
Co-Authored-By: Alek Petuskey <alek@reflex.dev>
Co-Authored-By: Alek Petuskey <alek@reflex.dev>
Co-Authored-By: Alek Petuskey <alek@reflex.dev>
Co-Authored-By: Alek Petuskey <alek@reflex.dev>
…nd computed_vars Co-Authored-By: Alek Petuskey <alek@reflex.dev>
Co-Authored-By: Alek Petuskey <alek@reflex.dev>
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.
Backend API Routes Documentation Improvements
This PR enhances the documentation for backend API routes with more comprehensive examples and clearer explanations.
Changes Made
Current Status
🚧 Work in Progress
The following improvements have been made:
Known Issues
Template evaluation errors are still occurring in the documentation server, preventing proper rendering. We're working with the core team to resolve these issues. Screenshots will be added once the documentation server can properly render the pages.
Testing
Link to Devin run
https://app.devin.ai/sessions/7422045c53d1402786daa45812aefcf1
Screenshots will be added once the template evaluation issues are resolved.