[NDH-840] Centralizing API Documentation Content#399
Merged
sachin-panayil merged 5 commits intomainfrom Feb 20, 2026
Merged
Conversation
rmillergv
approved these changes
Feb 19, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Centralizing API Documentation Content
Jira Ticket #840
Problem
Currently, we have API documentation content defined in a number of places: views.py, each of the filter python files, etc. This makes it harder to holistically look at our documentation content and also runs the risk that documentation content could drift (e.g. if the description of a practitioner name filter is updates in practitioner_filter_set.py but not practitioner_role_filter_set.py.
Solution
Create a new python file with a dictionary to store API documentation content, which can then be imported into and referenced in the files that currently have API documentation hard-coded.
Result
All content for API documentation is now stored in
documentation_content.pyand centralized with tests to confirm they appear in the APIs /schemaTest Plan
make upmake test