Skip to content

Comments

[NDH-840] Centralizing API Documentation Content#399

Merged
sachin-panayil merged 5 commits intomainfrom
sachin/ndh-840-centralzing-api-docs
Feb 20, 2026
Merged

[NDH-840] Centralizing API Documentation Content#399
sachin-panayil merged 5 commits intomainfrom
sachin/ndh-840-centralzing-api-docs

Conversation

@sachin-panayil
Copy link
Collaborator

@sachin-panayil sachin-panayil commented Feb 12, 2026

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.py and centralized with tests to confirm they appear in the APIs /schema

Test Plan

  • run make up
  • run make test

@sachin-panayil sachin-panayil self-assigned this Feb 12, 2026
@sachin-panayil sachin-panayil merged commit a3407d5 into main Feb 20, 2026
12 checks passed
@sachin-panayil sachin-panayil deleted the sachin/ndh-840-centralzing-api-docs branch February 20, 2026 15:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants