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.

Sign up for GitHub

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

Design: small update to add a PATCH endpoint #10919

Merged
merged 1 commit into from
Nov 28, 2023
Merged

Design: small update to add a PATCH endpoint #10919

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/dev/design/new-notifications-system.rst
View file
Open in desktop
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