[TASK] Change dataset progress and current user metrics endpoints to support distribution task #5139
Assignees
Comments
2 tasks
2 tasks
jfcalvo
added a commit
that referenced
this issue
Jul 4, 2024
# Description
This PR adds changes to the endpoints to get the dataset progress and
current user metrics in the following way:
## `GET /datasets/:dataset_id/progress`
I have changed the endpoint to support the new business logic behind the
distribution task. Responding with only `completed` and `pending` type
of records and using `total` as the sum of the two types of records.
Old response without distribution task:
```json
{
"total": 8,
"submitted": 2,
"discarded": 2,
"conflicting": 1,
"pending": 3
}
```
New response with the changes from this PR supporting distribution task:
* The `completed` attribute will have the count of all the records with
status as `completed` for the dataset.
* The `pending` attribute will have the count of all the records with
status as `pending` for the dataset.
* The `total` attribute will have the sum of the `completed` and
`pending` attributes.
```json
{
"total": 5
"completed": 2,
"pending": 3,
}
```
@damianpumar some changes are required on the frontend to support this
new endpoint structure.
## `GET /me/datasets/:dataset_id/metrics`
Old response without distribution task:
```json
{
"records": {
"count": 7
},
"responses": {
"count": 4,
"submitted": 1,
"discarded": 2,
"draft": 1
}
}
```
New response with the changes from this PR supporting distribution task:
* `records` section has been eliminated because is not necessary
anymore.
* `responses` `count` section has been renamed to `total`.
* `pending` section has been added to the `responses` section.
```json
{
"responses": {
"total": 7,
"submitted": 1,
"discarded": 2,
"draft": 1,
"pending": 3
}
}
```
The logic behind these attributes is the following:
* `total` is the sum of `submitted`, `discarded`, `draft` and `pending`
attribute values.
* `submitted` is the count of all responses belonging to the current
user in the specified dataset with `submitted` status.
* `discarded` is the count of all responses belonging to the current
user in the specified dataset with `discarded` status.
* `draft` is the count of all responses belonging to the current user in
the specified dataset with `draft` status.
* `pending` is the count of all records with `pending` status for the
dataset that has not responses belonging to the current user.
@damianpumar some changes are required on the frontend to support this
new endpoint structure as well.
Closes #5139
**Type of change**
- Breaking change (fix or feature that would cause existing
functionality to not work as expected)
**How Has This Been Tested**
- [x] Modifying existent tests.
- [x] Running test suite with SQLite and PostgreSQL.
**Checklist**
- I added relevant documentation
- follows the style guidelines of this project
- I did a self-review of my code
- I made corresponding changes to the documentation
- I confirm My changes generate no new warnings
- I have added tests that prove my fix is effective or that my feature
works
- I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)
---------
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Paco Aranda <[email protected]>
Co-authored-by: Damián Pumar <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
No description provided.
The text was updated successfully, but these errors were encountered: