Geo Primary Verification API: POST api/v4/admin/data_management/:model/checksum?query
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Why are we doing this work
This work will be behind feature flag geo_primary_verification_view
We are building a view for customers to manage their instance's data and verify primary data integrity for Geo Improve primary verification experience (&16554)
important: This endpoint should be marked as experimental
or beta
until this work is complete to avoid issues with deprecations or removals as we explore what is needed.
note: The proposed endpoint may be changed based on decisions on the routing
What is needed in this change
This functionality will only be available if checksumming is enabled for the model.
This change is focused on expanding the API endpoint added in Geo Primary Verification API: POST `api/v4/admi... (#537709 - closed) to support query parameters.
Expected query parameters
We should support the filter layer endpoints as the GET endpoint Geo Primary Verification API: GET `api/v4/admin... (#537710 - closed)
-
?ids
- This should support a list of IDs to create a very specific curated list
-
?checksum_status
- This will only be available when checksumming is enabled. This will allow us to filter by the checksum_status ENUM
Relevant links
- Routing discussion: Geo Primary Verification: Routing (#537677 - closed)
- API Endpoint Definition: Geo Primary Verification API: POST `api/v4/admi... (#537709 - closed)
- GET Query Params Geo Primary Verification API: GET `api/v4/admin... (#537710 - closed)
Implementation plan
This is an extension from #537709 (closed).
- add the parameters to the endpoint created in the aforementioned issue;
- return an error if Model (through its Replicator class) is not verifiable.
- find the matching model records from the received parameters
- loop through them: instantiate Replicators matching the model class and apply
.verify
on each instance.