[Backend] Feature Request: Pin Notes

[PatilShreyas]

This is regarding feature "pinning notes" as discussed here: #534

This also needs to be implemented on the backend side so that the state of the pinning of notes will be persisted.

Task

Create an API for updating the note's pin.

API Contract

Request

PUT /note/<NOTE_ID>/pin
Content-Type: application/json
Authorization: Bearer <TOKEN>

{
  "isPinned": true
}

Response

1. When note gets pinned/unpinned successfully

Response Code: 200

{
  "status": "SUCCESS",
  "message": "Note is pinned/unpinned successfully",
  "noteId": <NOTE ID>
}

2. When note note exist in system

Response Code: 404

{
  "status": "NOT_FOUND",
  "message": "Note not exist with ID '$noteId'"
}

3. When unauthorized user tries to update note pin

Response Code: 401

{
  "status": "UNAUTHORIZED",
  "message": "Access denied"
}

[kunalkumbhar7]

Heyy @PatilShreyas I can take this up... should I start working on this feature??

[PatilShreyas]

Thanks for showing interest in contributing this @mrfamouskk7. Sure, Assigning this to you.

[kunalkumbhar7]

Thanks for showing interest in contributing this @mrfamouskk7. Sure, Assigning this to you.

Thanks @PatilShreyas

[PatilShreyas]

Let me know if you need any help in setting up this project locally.

[kunalkumbhar7]

Actually, I am done with local setup.
I just had a question, so isPinned flag will be required while fetching notes as well right? So should I include that in same PR??

[PatilShreyas]

Yes, it'll be required to have isPinned flag in all notes response. If you're fine with doing it in the same PR, then okay. Otherwise we can also have a dedicated PR for that.

[PatilShreyas]

@mrfamouskk7 Current API looks good to you?

Otherwise, we can also have two API endpoints for pin and unpin operations.

Like,

• PUT /note/{noteId}/pin
• PUT /note/{noteId}/unpin

This will not require a request body.

WDYT?

[kunalkumbhar7]

I think both the ways should okay:

• Single API with body
• Separate APIs without body

But it seems unusual/unconventional to have PUT/POST request without body.
Single API with body should be the ideal way to implement.

[kunalkumbhar7]

Yes, it'll be required to have isPinned flag in all notes response. If you're fine with doing it in the same PR, then okay. Otherwise we can also have a dedicated PR for that.

I will include in the same PR

[PatilShreyas]

I think both the ways should okay:

• Single API with body
• Separate APIs without body

But it seems unusual/unconventional to have PUT/POST request without body.
Single API with body should be the ideal way to implement.

Makes sense!

[kunalkumbhar7]

Heyy Shreyash, so I have a couple of suggestions:

• Pinning API can be changed from PUT request to a PATCH request. PATCH is more suitable because we are not updating the complete resource here.
• A new field updated can be added to notes so that the most recent pinned note will be at the top

WDYT?

[PatilShreyas]

@mrfamouskk7 this sounds good to me. Definitely we can have updated field

[kunalkumbhar7]

Sure... I will add those changes in the same PR 👍