Skip to content

Commit

Permalink
Design: small update to add a PATCH endpoint
Browse files Browse the repository at this point in the history
Endpoint to update a notification.
This will be used by the front-end to mark a notification as read, for example.

Ref: #10890 (comment)
  • Loading branch information
humitos committed Nov 23, 2023
1 parent 6723e59 commit e78fe85
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/dev/design/new-notifications-system.rst
Original file line number Diff line number Diff line change
Expand Up @@ -425,6 +425,30 @@ Notification create
we want to attach a ``Notification`` (e.g. ``User``, ``Organization``, etc)


Notification update
~~~~~~~~~~~~~~~~~~~


.. http:patch:: /api/v3/projects/(str:project_slug)/builds/(int:build_id)/notifications/(int:notification_id)/
Update an existing notification.
Mainly used to change the state from the front-end.

**Example request**:

.. sourcecode:: json

{
"state": "read",
}


.. note::

Similar API endpoints will be created for each of the resources
we want to attach a ``Notification`` (e.g. ``User``, ``Organization``, etc)


Backward compatibility
----------------------

Expand Down

0 comments on commit e78fe85

Please sign in to comment.