Skip to content

Conversation

@kaapstorm
Copy link
Contributor

@kaapstorm kaapstorm commented Dec 29, 2025

Technical Summary

🦖 SAAS-18882

This adds an API for ExportInstance objects that have show_det_config_download = True.

This is required by CommCare Data Pipeline (formerly CommCare Sync) to list the available exports on HQ, and download the DET config file for the CommCare Data Pipeline user.

Safety Assurance

Safety story

  • Adds a simple API
  • Leverages existing API code infrastructure
  • Does not change existing APIs

Automated test coverage

Yes

QA Plan

CommCare Data Pipeline changes will go through QA, including DET config file download.

Rollback instructions

  • This PR can be reverted after deploy with no further considerations

Labels & Review

  • Risk label is set correctly
  • The set of people pinged as reviewers is appropriate for the level of risk of the change

@kaapstorm kaapstorm added the product/invisible Change has no end-user visible impact label Dec 29, 2025
@dimagimon dimagimon added the Risk: High Change affects files that have been flagged as high risk. label Dec 29, 2025
Comment on lines 240 to 244
form_exports = [
FormExportInstance.wrap(result['doc'])
for result in form_results
if result['doc'].get('show_det_config_download', False)
]

This comment was marked as outdated.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


class Meta(CustomResourceMeta):
resource_name = 'det_export_instance'
authentication = RequirePermissionAuthentication(HqPermissions.view_reports)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

view_reports seems like the right permission to be checking, but please let me know if you think there is a better one to use.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product/invisible Change has no end-user visible impact Risk: High Change affects files that have been flagged as high risk.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants