Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#1234 - Update Swagger for callback create route require property notification statues #2262

Conversation

MackHalliday
Copy link

@MackHalliday MackHalliday commented Jan 22, 2025

Description

issue #1234

We are updating the Swagger documentation for POST /service/{service_id}/callback. Originally, the documentation said the field notification_statuses was required if the callback_type is delivery_status. However, this is not true. If notification_statuses is not included, the service by default will receive updates on ALL notification_statues. I have updated the Swagger doc to reflect how the endpoint actually behaves.

How Has This Been Tested?

Screenshot 2025-01-22 at 12 16 49 PM

Checklist

  • I have assigned myself to this PR
  • PR has an appropriate title: #9999 - What the thing does
  • PR has a detailed description, including links to specific documentation
  • I have added the appropriate labels to the PR.
  • I did not remove any parts of the template, such as checkboxes even if they are not used
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to any documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works. Testing guidelines
  • I have ensured the latest main is merged into my branch and all checks are green prior to review
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • The ticket was moved into the DEV test column when I began testing this change

@MackHalliday MackHalliday self-assigned this Jan 22, 2025
@MackHalliday MackHalliday marked this pull request as ready for review January 22, 2025 17:20
@MackHalliday MackHalliday requested a review from a team as a code owner January 22, 2025 17:20
Copy link

@cris-oddball cris-oddball left a comment

Choose a reason for hiding this comment

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

Please update the version on line 4 (increment it) - sorry I forgot to tell you that when we talked!

Copy link
Member

@k-macmillan k-macmillan left a comment

Choose a reason for hiding this comment

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

Looks good:
image

@MackHalliday MackHalliday merged commit 8ae8ed1 into main Jan 22, 2025
13 checks passed
@MackHalliday MackHalliday deleted the 1234-bug-callback-create-route-require-property-notification-statuses branch January 22, 2025 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants