Giter Club home page Giter Club logo

Comments (5)

Varsha-Kulkarni avatar Varsha-Kulkarni commented on June 14, 2024

Please assign this to me, once backend issue is merged, I would love to complete this. Thanks.

from notykt.

PatilShreyas avatar PatilShreyas commented on June 14, 2024

I guess I replied on the wrong thread. NVM

Ref:
#547 (comment)
#547 (comment)

from notykt.

tyaporush avatar tyaporush commented on June 14, 2024

Hi @PatilShreyas Assign this to me

from notykt.

PatilShreyas avatar PatilShreyas commented on June 14, 2024

Thanks, @tyaporush for showing interest in contributing to this. Assigning this to you 😄.

from notykt.

PatilShreyas avatar PatilShreyas commented on June 14, 2024

@tyaporush Here's the REST API spec for you.


REST API Specification

Request

  • Method: PATCH
  • URL: BASE_URL/note/{note-id}/pin
  • Header: Authorization <TOKEN>
  • Body:
{
  "isPinned": true/false
}

Example:

PATCH https://API_BASE_URL/note/noteId1234/pin
Content-Type: application/json
Authorization: Bearer YOUR_AUTH_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"
}

from notykt.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.