Skip to content

Conversation

@nathanaelgoertzen
Copy link
Contributor

@nathanaelgoertzen nathanaelgoertzen commented Aug 7, 2025

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

  • Find the Service owning team for these changes, and tag the team as "Reviewers" on this PR
  • Test the documentation changes on readthedocs as a private branch
  • If changing general content, have agreement on whether to apply to latest version or all versions (if all versions, provide links to the related PRs below)

@nathanaelgoertzen nathanaelgoertzen requested review from a team and Copilot August 7, 2025 21:42
Copy link

Copilot AI left a 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

Copy link

@tomm-invoca tomm-invoca 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 from the Omega side.

@nathanaelgoertzen nathanaelgoertzen requested a review from a team August 8, 2025 19:58
Copy link
Contributor

@cgaroutte cgaroutte left a 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. 👍

@nathanaelgoertzen nathanaelgoertzen requested a review from a team August 8, 2025 20:56
@joroeinvoca joroeinvoca merged commit 3bb8f68 into 2022-08-01 Aug 8, 2025
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.

5 participants