Expose an API for Design Repositories for Geo Admin area
Problem to solve
We don't currently have a way to pull Design Repository data into a Vue component. Exposing an API will allow for us to create a Vue
view for the Design Repositories /admin/geo/designs
.
Intended users
- Systems Administrators
Further details
There are some discussions around using a REST api or a GraphQL api. Feel free to leave comments below to which would be the best path for this.
This also will set the standard for further efforts of pulling /admin/geo/projects
and /admin/geo/uploads
into Vue
in the future.
Proposal
Expose an API that gives access into data about Design Repositories in relation to their Sync status. Very similar to /admin/geo/projects
currently.
This api will be required to have:
- Server Side Pagination
- Server Side Searching (Based on Status and Keyword)
- The ability to Reverify/Resync each Design Repository individually
- The ability to Reverify/Resync ALL Design Repositories
Permissions and Security
I am not sure what levels of security are required here, but I would imagine the same level for any of the other Geo APIs currently. I.E /api/v4/geo_nodes
Documentation
The documentation for the Geo api will need to be updated
Testing
TBD
What does success look like, and how can we measure that?
Success will look like a safe API that exposes the actions listed above. This will then allow for a separate Issue (#34336 (closed)) to be worked to create the View in Vue