Create means for programmatically displaying view/edit permissions for endpoints - Githubissues

Police-Data-Accessibility-Project / data-sources-app

An API and UI for using and maintaining the Data Sources database

MIT License

4 stars 5 forks source link

Create means for programmatically displaying view/edit permissions for endpoints #406

Closed maxachis closed 1 month ago

maxachis commented 3 months ago

Context

As discussed in https://github.com/Police-Data-Accessibility-Project/data-sources-app/issues/390#issuecomment-2289244848, I determined that we could programmatically display the varying permissions for different users for the relation returned by an endpoint.
Therefore, let's look into developing that!

Requirements

Wait for an endpoint, such as #390 , to be developer which utilizes variable view/edit permissions.
Develop the above solution
Worth considering: How might this impact the time it takes for the swagger generation to load?
Perhaps cache the contents initially to load as needed?

Tests

Test how swagger documentation appears when it loads
Evaluate the impact on load times.

Docs

Swagger documentation will be impacted.

Open questions

These tables can add a lot of text real estate to the documentation -- evaluate how that looks and whether that's what we want to go for.

josh-chamberlain commented 3 months ago

I believe Swagger gives us the ability to hide stuff in expanding menus / accordions, so that takes care of the TMI problem. We can default to hiding things like this.