Update Edge FQM to Handle New /entity-types Endpoint Behavior
Description
The /entity-types endpoint has been updated to allow a query parameter (includeAll=true) that returns both simple and composite entity types. The Edge FQM module needs to be updated to handle this new behavior to ensure it does not break existing functionality and supports the new request format.
Ensure the Edge FQM module can handle the new includeAll=true query parameter for the /entity-types endpoint, which retrieves both simple and composite entity types.
If the includeAll=true parameter is passed, ensure that Edge FQM correctly processes the response containing both entity types (simple and composite)
Test the Edge FQM module with the updated /entity-types endpoint to ensure it correctly fetches and processes both simple and composite entity types when includeAll=true is provided
Verify that Edge FQM continues to function correctly with the default behavior (only composite entity types returned when includeAll is omitted).
If the parameter is includeAll=true we receive all available entity types, even hidden entity types
If the parameter is includeAll=false we receive only not hidden entity types, hidden entity types are not available
Bobby Sharp February 19, 2025 at 1:43 PM
Hey , this is now available for testing in snapshot. To test this, you can make calls to edge-fqm’s /entity-types API with the includeAll parameter set to true, false, or not included at all. If set to true, you should be able to see all entity types that a user has access to, including hidden ones (such as Categories and Loan types). If false or not present, then only public ETs should be returned.
I’m not sure how much familiarity you have with using the edge APIs, so I can help with setting things up if needed, or we can have another dev test it. It can also be kind of difficult to find the edge URLs, but the one for okapi snapshot is https://folio-snapshot.dev.folio.org:8000.
The
/entity-typesendpoint has been updated to allow a query parameter (includeAll=true) that returns both simple and composite entity types. The Edge FQM module needs to be updated to handle this new behavior to ensure it does not break existing functionality and supports the new request format.Ensure the Edge FQM module can handle the new
includeAll=truequery parameter for the/entity-typesendpoint, which retrieves both simple and composite entity types.If the
includeAll=trueparameter is passed, ensure that Edge FQM correctly processes the response containing both entity types (simple and composite)Test the Edge FQM module with the updated
/entity-typesendpoint to ensure it correctly fetches and processes both simple and composite entity types whenincludeAll=trueis providedVerify that Edge FQM continues to function correctly with the default behavior (only composite entity types returned when
includeAllis omitted).