This pull request introduces a new POP configuration setting to the sciDX API, allowing for conditional visibility of specific routes based on the POP environment variable.
Key Changes:
POP Configuration:
Added POP environment variable to .env_swagger, defaulting to False.
Integrated the POP setting in swagger_settings.py to control route visibility.
Route Visibility:
When POP is True, the POST /stream and GET /stream endpoints are hidden from the API.
When POP is False, all routes, including POST /stream and GET /stream, are visible.
Tests:
Added tests to verify the correct behavior of route visibility based on the POP setting.
Purpose:
This feature enables the API to be configured for use as a Point of Presence (POP) within the NDP project, where only a subset of the API's routes is needed.
This pull request introduces a new
POPconfiguration setting to the sciDX API, allowing for conditional visibility of specific routes based on thePOPenvironment variable.Key Changes:
POP Configuration:
POPenvironment variable to.env_swagger, defaulting toFalse.POPsetting inswagger_settings.pyto control route visibility.Route Visibility:
POPisTrue, thePOST /streamandGET /streamendpoints are hidden from the API.POPisFalse, all routes, includingPOST /streamandGET /stream, are visible.Tests:
POPsetting.Purpose: This feature enables the API to be configured for use as a Point of Presence (POP) within the NDP project, where only a subset of the API's routes is needed.