Mentorship-backend: Add extra field to Cancel API indicating reason of cancellation

[isabelcosta]

Description

As a user,
I need to explain mentorship relation cancellation reason,
so that I can help improving the system with proper feedback.

Acceptance Criteria

Update

• [ ] Optional text field, e.g.: cancellation_reason, to API request data of Cancel API and Mentorship relation database model
• [ ] Add and fix tests for this
• [ ] Document properly on Swagger UI

Definition of Done

• [ ] All of the required items are completed.
• [x] Approval by 1 mentor.

Estimation

3 hours

[flacode]

@isabelcosta, can I please work on this issue?

[isabelcosta]

Sure @flacode :) go ahead!

[bhawesh96]

If this is stale, I'd like to work on it!

[isabelcosta]

@flacode are you still working on this?

[isabelcosta]

@bhawesh96 you can work on this if you want, since there are no updates :) Do you still want to work on this?

[bhawesh96]

Yes, I'll take it up

[bhawesh96]

Can we store the reason for cancellation under notes (overwriting the existing value) or do I make a new column?

[bhawesh96]

Since cancellation_reason has to be sent in the request, will we need to change the request type from PUT to POST?

[isabelcosta]

@bhawesh96

Can we store the reason for cancellation under notes (overwriting the existing value) or do I make a new column?

I think that overriding notes isn't a great option, because we may still want to know the details of the relationship even after cancelation, for historical purposes. So its best to create the new field in the MentorshipRelationModel class.

Since cancellation_reason has to be sent in the request, will we need to change the request type from PUT to POST?

I think it should remain PUT, you won't be creating anything, just updating the relationship with the state from ACCEPTED to CANCELLED and updating the cancellation_reason field.

[sharifa2708]

@isabelcosta I would like to work on this issue

[isabelcosta]

I will review your PR first, so please do the changes and then work on this. @sharifa2708

[sharifa2708]

@isabelcosta Sure I will make the changes suggested

[CleverFool77]

Hi @isabelcosta Is this issue available?

[isabelcosta]

Yes it is :) @CleverFool77 you can work on it if you want. Do you?

[CleverFool77]

Yes I would like to take this up.
Thanks @isabelcosta

[BadduCoder]

@isabelcosta I want to work on this issue, if it's available.

[isabelcosta]

@BadduCoder I think you can work on this yes since we have no recent updates on this issue.
cc @CleverFool77

[isabelcosta]

@BadduCoder I left you a note on your latest PR, please address that before moving onto this issue ;)

[BadduCoder]

@isabelcosta Shouldn't we consider who(Mentor/Mentee) cancelled the relation, or just update the reason without taking in consideration who did it.

[BadduCoder]

@isabelcosta I will start working on this once the previous PR is approved. Till then I will explore the project where the changes are to be done and discuss doubts if I encounter any.

[BadduCoder]

@isabelcosta I tried updating swagger.json, but it doesn't reflects changes on Swagger UI. Any suggestions where I might be doing something wrong?

[BadduCoder]

@isabelcosta Updated the PR! 😄