← Technical API reference

Backend resource · STATIC DECLARATIONS

Web Push Subscription API reference · mansoq-notifications-be

Static source contract for Web Push Subscription: 4 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.

Static API contract — behavior review pending. Source baseline f6e9f05f76d4.

Enable JavaScript to inspect structured operation, parameter, schema and permission evidence. Download this reference and its evidence.

Declared route and availability

This resource is declared in mansoq-notifications-be at /api/{installed_plugin_prefix}/web_push_subscriptions/. plugin/local mount; actual prefix and enablement require deployment verification A registered path and an indexed handler do not prove deployment availability, user permission or production readiness.

Operation map

Method Path Action Evidence
GET /api/{installed_plugin_prefix}/web_push_subscriptions/ list declared/inherited method
POST /api/{installed_plugin_prefix}/web_push_subscriptions/ create declared/inherited method
POST /api/{installed_plugin_prefix}/web_push_subscriptions/unsubscribe/ unsubscribe @action declaration
GET /api/{installed_plugin_prefix}/web_push_subscriptions/vapid_public_key/ vapid_public_key @action declaration

list · GET

GET /api/{installed_plugin_prefix}/web_push_subscriptions/ — action list. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true

response: WebPushSubscriptionListSpec. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
meta dict false No extra constraint extracted
id UUID4 | None false No extra constraint extracted
endpoint str true No extra constraint extracted
created_date datetime.datetime true No extra constraint extracted

Observed authorization checks: can_list_all_notifications. Helper/queryset evidence is included; this is not proof of complete security review.

create · POST

POST /api/{installed_plugin_prefix}/web_push_subscriptions/ — action create. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true

request: WebPushSubscriptionListSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

response: WebPushSubscriptionListSpec. Declared fields below; inherited fields are retained in the schema inventory.

The declared field table is shown at its first occurrence in this reference; this operation links the same schema.

body validation: WebPushSubscribeRequest. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
endpoint str true No extra constraint extracted
keys PushSubscriptionKeys true No extra constraint extracted

Observed authorization checks: can_list_all_notifications. Helper/queryset evidence is included; this is not proof of complete security review.

Explicit response statuses in observed code: status.HTTP_200_OK. Other branches/framework exception handling may differ.

unsubscribe · POST

POST /api/{installed_plugin_prefix}/web_push_subscriptions/unsubscribe/ — action unsubscribe. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true

body validation: WebPushUnsubscribeRequest. Declared fields below; inherited fields are retained in the schema inventory.

Field Type Required Constraints
endpoint str true No extra constraint extracted

Observed authorization checks: can_list_all_notifications. Helper/queryset evidence is included; this is not proof of complete security review.

vapid_public_key · GET

GET /api/{installed_plugin_prefix}/web_push_subscriptions/vapid_public_key/ — action vapid_public_key. static contract extracted; runtime/permission/payload behavior review pending.

Path and deployment-context parameters:

Location Parameter Type Required
deployment mount installed_plugin_prefix deployment-selected mount prefix true

Observed authorization checks: can_list_all_notifications. Helper/queryset evidence is included; this is not proof of complete security review.

Integration review checklist

Confirm the installed route and full schema; review authentication, organization/facility scoping, all accepted fields, value-state and date/time semantics, idempotency, pagination, response/exception branches and the allowed correction/reversal workflow. Test positive and negative cases with synthetic data. This source reference does not establish external certification or replace an illustrated user procedure.

Pinned source evidence

Links require access to the private source repository.