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

Change task comment api #1126

Open
wants to merge 7 commits into
base: develop
Choose a base branch
from

Conversation

RiddhiAthreya
Copy link
Contributor

@RiddhiAthreya RiddhiAthreya commented Jun 26, 2021

Description

  • The API endpoint /mentorship_relation/{relation_id}/task/{task_id}/comments/ response has been changed to include the details of the author of the corresponding comment
  • Swagger UI docs has been changed to reflect the same

The response has been changed to :
Screenshot (178)

Fixes #1110 #685

Type of Change:

  • Code

Code/Quality Assurance Only

  • Bug fix (non-breaking change which fixes an issue)
  • This change requires a documentation update (software upgrade on readme file)
  • Enhancement

How Has This Been Tested?

Has been tested in local environment by accessing the endpoint. An example :
Screenshot (177)

Checklist:

  • My PR follows the style guidelines of this project
  • I have performed a self-review of my own code or materials

Code/Quality Assurance Only

  • Unit test cases have been updated

@welcome
Copy link

welcome bot commented Jun 26, 2021

Hello there!👋 Welcome to the project!💖
Thank you and congrats 🎉 for opening your first PR on this project.✨
Please ensure your Pull Request meets the Commit Message Style Guide.
We will review it soon! Until then you can check out the README.md for more details on it.

AnitaB.org Open Source is an inclusive community, committed to creating a safe and positive environment 🌸 Please follow our Code Of Conduct.

Feel free to join our community at AnitaB.org Open Source Zulip Community to be kept up to date with our projects discussions and community activities.
Hope you have a great time here :)

@RiddhiAthreya
Copy link
Contributor Author

@epicadk I've made a PR , please let me know if any changes are required

@epicadk
Copy link
Member

epicadk commented Jun 27, 2021

Also link #685

@epicadk
Copy link
Member

epicadk commented Jun 27, 2021

If in the future we want to have a mentor groups then I think this would not be easily extendable to that.

@RiddhiAthreya
Copy link
Contributor Author

@epicadk Oh I see. Then should I include the corresponding user's details in each comment object?

@RiddhiAthreya
Copy link
Contributor Author

@epicadk I've made the changes in the latest commit. Let me know if any changes are required

Copy link
Member

@vj-codes vj-codes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@RiddhiAthreya please resolve the merge conflicts

@vj-codes vj-codes added Status: Changes Requested Changes are required to be done by the PR author. and removed Status: Needs Review PR needs an additional review or a maintainer's review. labels Jul 24, 2021
@devkapilbansal devkapilbansal added Status: Needs Review PR needs an additional review or a maintainer's review. and removed Status: Changes Requested Changes are required to be done by the PR author. labels Aug 28, 2021
@devkapilbansal devkapilbansal added Status: Changes Requested Changes are required to be done by the PR author. and removed Status: Needs Review PR needs an additional review or a maintainer's review. labels Oct 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Changes Requested Changes are required to be done by the PR author.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change the Comments API to provide the user details along with the comments
4 participants