RestContract icon indicating copy to clipboard operation
RestContract copied to clipboard

Add search exposed config endpoint

Open J4bbi opened this issue 9 months ago • 1 comments

Fixes https://github.com/DSpace/DSpace/issues/9056 as discussed in DevMtgs 14th and 21st September 2023.

This PR adds an endpoint to the configuration endpoint to more efficiently share configuration with the frontend.

Current approach

Add the /api/config/properties/search/exposed endpoint, as per the top communities search endpoint.

Pros API endpoint url is clear.

Cons Endpoint url is not consistent with the single case, /api/config/properties/<:property>.

Alternative approach

I am a little undecided about whether I feel /api/config/properties would be a better solution and just implementing the missing findAll method.

Pros There is consistency in the naming of the endpoints. /api/config/properties/<:property> for a single configuration and /api/config/properties/ for every single one.

Cons It might not be apparent that this endpoint is limited to whitelisted, exposed configuration.

J4bbi avatar Sep 30 '23 01:09 J4bbi