-
Notifications
You must be signed in to change notification settings - Fork 6
STORY-22329: Deprecate performance notification fields #411
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
STORY-22329: Deprecate performance notification fields #411
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates API documentation to reflect the deprecation of performance notification fields in the Omega system. The deprecated fields now always return false and are documented as such.
- Updated parameter documentation to mark three performance notification fields as deprecated
- Removed deprecated fields from API response examples
- Updated remaining example values to reflect current API behavior (always false)
Reviewed Changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| source/api_documentation/network_integration/networks/index.rst | Updated parameter descriptions to mark performance notification fields as deprecated |
| source/api_documentation/network_integration/networks/_put_network_user.rst | Removed deprecated performance notification fields from response example |
| source/api_documentation/network_integration/networks/_post_network_users.rst | Removed deprecated performance notification fields from response example |
| source/api_documentation/network_integration/networks/_get_network.rst | Updated monthly campaign performance reports value from true to false |
| source/api_documentation/network_integration/affiliates/index.rst | Updated parameter descriptions to mark performance notification fields as deprecated |
| source/api_documentation/network_integration/affiliates/_post_affiliate.rst | Removed deprecated performance notification fields from response example |
| source/api_documentation/network_integration/affiliates/_get_affiliates.rst | Updated monthly campaign performance reports value from true to false |
| source/api_documentation/network_integration/affiliates/_get_affiliate.rst | Updated monthly campaign performance reports value from true to false |
| source/api_documentation/network_integration/advertisers/index.rst | Updated parameter descriptions to mark performance notification fields as deprecated |
| source/api_documentation/network_integration/advertisers/_put_advertiser.rst | Removed deprecated performance notification fields from response example |
| source/api_documentation/network_integration/advertisers/_post_advertiser.rst | Removed deprecated performance notification fields from response example |
| source/api_documentation/network_integration/advertisers/_get_advertisers.rst | Updated monthly campaign performance reports value from true to false |
| source/api_documentation/network_integration/advertisers/_get_advertiser.rst | Updated monthly campaign performance reports value from true to false |
| source/api_documentation/network_integration/advertiser_users/_put_advertiser_user.rst | Removed deprecated performance notification fields from response example |
| source/api_documentation/network_integration/advertiser_users/_post_advertiser_users.rst | Removed deprecated performance notification fields from response example |
| source/api_documentation/network_integration/advertiser_users/_get_advertiser_users.rst | Updated monthly campaign performance reports value from true to false |
| source/api_documentation/network_integration/advertiser_users/_get_advertiser_user.rst | Updated monthly campaign performance reports value from true to false |
tomm-invoca
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good from the Omega side.
cgaroutte
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not super familiar with this area, but based on the linked thread with Colin, and the ticket description, this looks good to me. 👍
https://invoca.atlassian.net/browse/STORY-22329
Omega has deprecated performance notifications. These fields currently always return false from the deprecation work. We are now updating the documentation to indicate the API's current behavior.
Checklist