cds-snc / notification-planning

Project planning for GC Notify Team
4 stars 0 forks source link

Fix api docs concerning getting single notification status #1468

Open andrewleith opened 6 months ago

andrewleith commented 6 months ago

Describe the bug

The docs incorrectly state that you can pass filtering criteria to the /v2/notifications/{id} endpoint to filter the results. This is not the case - filtering is not possible.

Amend the docs to remove the part that says:

You can filter the returned messages by including the following optional parameters in the URL

  • template_type
  • status
  • reference
  • older_than

NOTE: filtering is possible for the /v2/notifications endpoint (note no ID is passed) so don't change the docs for that one!

Bug Severity

SEV-4