redex-ai / django-todo

A simple todo app built with django
Apache License 2.0
0 stars 1 forks source link

REDEX #11

Open redex-ai opened 9 months ago

redex-ai commented 9 months ago

Add the support of body in notes. The support is only for title right now

redex-ai-powered-okr-tool[bot] commented 9 months ago

Based on the provided context and the task requirements to add support for a body in notes, here are some clarification questions related to backend development:

  1. Model Changes:

    • Is there a specific character limit or text type (plain text, markdown, HTML, etc.) for the body of the notes?
    • Should the body field be optional or required when creating or updating a note?
    • Are there any default values or placeholders that should be set for the body field when a new note is created?
  2. Database Migrations:

    • Will there be a need to preserve existing data during the database migration, or is it acceptable to reset the database?
    • Should the migration include any data transformation or copying of existing title data into the new body field?
  3. API Changes:

    • Will the existing endpoints for creating and updating notes need to be modified to accept a body parameter?
    • Should there be any validation on the body content (e.g., preventing script injections in case of HTML content)?
  4. Business Logic:

    • Are there any business rules regarding the relationship between the title and the body (e.g., should they be unique, correlated, or independent of each other)?
    • Should the backend perform any processing or formatting on the body text before saving it to the database?
  5. Search and Filtering:

    • Will there be a requirement to search or filter notes based on the content of the body?
    • If search functionality is required, should it be a simple substring search, or is there a need for more advanced text search capabilities?
  6. Performance Considerations:

    • Are there any expected performance implications with the addition of the body field, especially if the body content can be large?
    • Should there be any limitations on the size of the body content to prevent potential performance issues?
  7. Security Concerns:

    • Are there any specific security measures that need to be implemented for the body content, such as sanitization or escaping of user input?
  8. Frontend Integration:

    • How should the backend changes be communicated to the frontend team, and are there any specific API documentation updates required?
    • Is there a need for a separate endpoint to retrieve the body content of a note, or should it be included in the existing note retrieval endpoints?
  9. Backward Compatibility:

    • Should the backend changes be backward compatible with clients that do not expect a body field in the response?
    • How should the system handle requests from older clients that do not provide a body when creating or updating notes?

These questions aim to gather all necessary information to implement the new feature accurately and ensure that the backend changes align with the overall application's functionality and requirements.