Allow custom CDISC Library API URL (proxy / local cache support) #1484
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gerrycampion
requested changes
Jan 8, 2026
Collaborator
gerrycampion
left a comment
gerrycampion
left a comment
There was a problem hiding this comment.
primarily feedback where we will see merge conflicts with #1506 which will allow users to retrieve latest rules with the default library api, but no api key
Comment on lines
+25
to
+30
| # Validation: If using the default CDISC Library URL, API key is required | ||
| if api_url == "https://api.library.cdisc.org/api" and not self._api_key: | ||
| raise ValueError( | ||
| "CDISC_LIBRARY_API_KEY is required when using the default CDISC Library API URL. " | ||
| "Either provide an API key or specify a custom CDISC_LIBRARY_API_URL which does not require an API key." | ||
| ) |
Collaborator
There was a problem hiding this comment.
This will go away with #1506 because a missing library api key will still be able to fetch the rules
Comment on lines
+15
to
+18
| def test_library_service_requires_key_for_default_url(): | ||
| """Test that API key is required when using default CDISC Library URL.""" | ||
| with pytest.raises(ValueError, match="CDISC_LIBRARY_API_KEY is required"): | ||
| CDISCLibraryService("", "", MagicMock()) |
| logger = logging.getLogger("validator") | ||
|
|
||
| # Validation: Ensure at least one is provided when using default URL | ||
| effective_url = apiurl if apiurl else "https://library.cdisc.org/api" |
Collaborator
There was a problem hiding this comment.
can this go into the click "default" value instead?
Comment on lines
+589
to
+596
| if effective_url == "https://library.cdisc.org/api" and not apikey: | ||
| logger.error( | ||
| "CDISC_LIBRARY_API_KEY is required when using the default CDISC Library API URL.\n" | ||
| "Either provide --apikey or set CDISC_LIBRARY_API_KEY environment variable,\n" | ||
| "or specify a custom URL with --apiurl or CDISC_LIBRARY_API_URL environment variable," | ||
| "which does or does not require specific API key for proxy access" | ||
| ) | ||
| ctx.exit(2) |
| @@ -1,4 +1,5 @@ | |||
| CDISC_LIBRARY_API_KEY=your_api_key_here | |||
| CDISC_LIBRARY_API_URL=http://localhost:31415/api # smart proxy server will not use CDISC_LIBRARY_API_KEY, but will might need it's own key to query upstream server. | |||
Collaborator
There was a problem hiding this comment.
typo "but will might need"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds support for configuring a custom CDISC Library API URL, enabling the use of local or private proxy/cache services (e.g. basic example https://github.com/tomhub/cdisc-proxy). This helps reduce load on the upstream CDISC Library API and limits repeated API calls in shared or CI environments.
Key changes
Why this matters
This should partially address issue #1413
NOTE: I think [tests/unit/test_cdisc_library_service.py] needs to be properly fixed.