onaio/onadata

Define additional verbs that should be added to the messaging endpoint

Open

#2,067 opened on Apr 30, 2021

View on GitHub
 (3 comments) (1 reaction) (1 assignee)Python (143 forks)auto 404
APIHelp Wanted

Repository metrics

Stars
 (187 stars)
PR merge metrics
 (PR metrics pending)

Description

Suggested enhancement

Currently the messaging endpoint only supports a limited amount of verbs that do not cover all the actions we'd like to track on the API. This issue is a discussion thread for verbs that might be nice to have on the endpoint.

The currently supported verbs are:

  • message
  • submission_created
  • submission_edited
  • submission_deleted
  • submission_reviewed
  • form_updated

A few nice to have verbs IMO are:

  • export_created
  • export_deleted
  • form_created
  • form_deleted
  • project_created
  • project_edited
  • project_deleted
  • permission_granted
  • permission_revoked

Contributor guide

Research direction
Review the list of suggested verbs and discuss which ones to add. Then implement them by updating the endpoint configuration.
Tech stack
python
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90