Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Assess adding SUBMISSION_COMMENT task action for submission comments #1694

Open
manjitapandey opened this issue Jul 23, 2024 · 7 comments
Open
Labels
backend Related to backend code effort:medium Likely a day or two enhancement New feature or request priority:low Backlog of tasks that will be addressed in time

Comments

@manjitapandey
Copy link
Collaborator

manjitapandey commented Jul 23, 2024

Is your feature request related to a problem? Please describe.

  • We have an endpoint to submit comments.
  • We can't distinguish between task comments or submission comments.

Describe the solution you'd like

  • Possibly refactor COMMENT action --> TASK_COMMENT
  • Add SUBMISSION_COMMENT action to enum.
  • Allow the endpoint to receive either a task or submission comment.
  • These will be filtered / displayed differently on the frontend.

Additional context
related to #1617
The UI for posting and viewing comments is below:

image

image

@spwoodcock
Copy link
Member

spwoodcock commented Jul 23, 2024

We definitely need a way to save comments 👍

Should we discuss tomorrow if this should be via a new API, or reusing existing APIs?

If it's a new API, then it also means a new db table, schemas, etc.

@Sujanadh
Copy link
Collaborator

Is this priority high for the next release?

@manjitapandey
Copy link
Collaborator Author

I believe yes, since it is blocking the #1617 . This also significantly impacts user experience when a UI is provided for comments, but they are neither stored nor displayed anywhere.

@manjitapandey
Copy link
Collaborator Author

We decided to temporarily pass submission id and submission prefix to store and show the submission based comments. and create a separate endpoint could be task for later.

@spwoodcock
Copy link
Member

I don't think we will need a separate endpoint, so I will update this issue 👍

@spwoodcock spwoodcock changed the title Post and Get API endpoint needed for comment on the submission. Assess adding SUBMISSION_COMMENT task action for submission comments Jul 25, 2024
@spwoodcock spwoodcock added priority:low Backlog of tasks that will be addressed in time effort:medium Likely a day or two and removed priority:high Should be addressed as a priority labels Jul 25, 2024
@NSUWAL123
Copy link
Collaborator

NSUWAL123 commented Jul 29, 2024

This has been fixed in the front end in PR #1709 by adding a prefix of SUBMISSION text with the submission UUID. I think this would only be a temporary fix for this release and won't be reliable. But in the future, we would probably need a separate API that handles GET & POST for submission-specific comments only like in the ODK.
What do you think @spwoodcock, @Sujanadh , @manjitapandey ?

@spwoodcock
Copy link
Member

Agree 💯

It's a temp fix for now 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Related to backend code effort:medium Likely a day or two enhancement New feature or request priority:low Backlog of tasks that will be addressed in time
Projects
None yet
Development

No branches or pull requests

4 participants