Add documentation indicating that APIs are internal #14090
+48
−1
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
Addresses issue learningequality#3306 by adding clear notices that most Kolibri APIs are internal and unstable, with the exception of /public/ endpoints which are maintained with backwards compatibility. Changes: - Add API stability warning to backend architecture documentation - Add module docstring to kolibri/core/api.py clarifying internal status - Add module docstring to kolibri/core/api_urls.py (central routing file) - Enhance public API documentation to emphasize stability distinction - Add integration notice to getting started guide - Update API explorer (Swagger) description with stability warning This ensures developers understand which APIs are safe to build against and sets proper expectations for API stability. Co-Authored-By: Claude Opus 4.5 <[email protected]>
github-actions
bot
added
DEV: backend
Contributor
Build Artifacts
|
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.
Summary
Addresses issue #3306 by adding clear notices that most Kolibri APIs are internal and unstable, with the exception of
/public/endpoints which are maintained with backwards compatibility.Changes:
kolibri/core/api.py(base utilities module)kolibri/core/api_urls.py(central routing file)Screenshot of API explorer showing the warning:
References
Fixes #3306
Reviewer guidance
/api_explorer/