Skip to content

feat: add bulk job status retrieval documentation - #237

Merged
andrewleith merged 4 commits into
mainfrom
feat/update-bulk-status-docs
Aug 31, 2026
Merged

feat: add bulk job status retrieval documentation#237
andrewleith merged 4 commits into
mainfrom
feat/update-bulk-status-docs

Conversation

@andrewleith

Copy link
Copy Markdown
Member

Summary | Résumé

This pull request adds new documentation for the bulk job status endpoints in both the English and French API reference guides. The updates describe how to retrieve the status and statistics for bulk notification jobs, including details on the endpoints, request parameters, response formats, and error codes.

Related Issues | Cartes liées

Test instructions | Instructions pour tester la modification

  • Review the content for accuracy

Release Instructions | Instructions pour le déploiement

None.

Reviewer checklist | Liste de vérification du réviseur

  • This PR does not break existing functionality.
  • This PR does not violate GCNotify's privacy policies.
  • This PR does not raise new security concerns. Refer to our GC Notify Risk Register document on our Google drive.
  • This PR does not significantly alter performance.
  • Additional required documentation resulting of these changes is covered (such as the README, setup instructions, a related ADR or the technical documentation).

⚠ If boxes cannot be checked off before merging the PR, they should be moved to the "Release Instructions" section with appropriate steps required to verify before release. For example, changes to celery code may require tests on staging to verify that performance has not been affected.

@github-actions

Copy link
Copy Markdown

A review app will be deployed. Get the URL by going to https://cds-snc.github.io/notification-documentation/

@github-actions

github-actions Bot commented Aug 31, 2026

Copy link
Copy Markdown

Review Apps

URLS

Last updated at

Mon Aug 31 2026 17:18:03 GMT+0000 (Coordinated Universal Time)

@smcmurtry smcmurtry left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

English content looks good! One suggestion - I think it would be better to move this to its own section, so instead of:

Get message status
- Email status
- Text message status
- Get bulk job status
- Get the status of multiple messages

we have:

Get message status
- Email status
- Text message status
- Get the status of multiple messages
Get bulk job status

Since the new endpoint doesn't actually return the status of individual messages.

@andrewleith

Copy link
Copy Markdown
Member Author

English content looks good! One suggestion - I think it would be better to move this to its own section, so instead of:

Get message status
- Email status
- Text message status
- Get bulk job status
- Get the status of multiple messages

we have:

Get message status
- Email status
- Text message status
- Get the status of multiple messages
Get bulk job status

Since the new endpoint doesn't actually return the status of individual messages.

Good point, I'll make those changes...

@jimleroyer jimleroyer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The French additions are good. I left a nitpick on formulation but overall, the changes are aligned with existing precedents.

Comment thread src/fr/etat.md Outdated
@smcmurtry

smcmurtry commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Looks good Andrew!

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