Skip to content

CON-6332 Mark Requestor as optional in Integration Webhooks documentation#49

Open
carlospalmermews wants to merge 7 commits intomainfrom
CON-6332-resolve-doc-consistency
Open

CON-6332 Mark Requestor as optional in Integration Webhooks documentation#49
carlospalmermews wants to merge 7 commits intomainfrom
CON-6332-resolve-doc-consistency

Conversation

@carlospalmermews
Copy link
Copy Markdown

Summary

This PR updates the Integration Webhooks > Integration created data table to correctly document the Requestor property as optional instead of required

Details

The current docs list Requestor with contract required, but:

  • The example payload already shows "Requestor": null.
  • Producer and consumer code model Requestor as a nullable/optional field (Requestor? / RequestorDto?), so integrations must handle null.

This change updates the table row to:

  • Mark the contract as optional.
  • Clarify that Requestor is present only when the integration was created by a known user; otherwise the value is null.

Motivation

Align the public documentation with the actual runtime contract so that integrators:

  • Do not treat Requestor as a mandatory non-null field.
  • Correctly support payloads where Requestor is omitted or null

Testing

  • Docs-only change.

Verified against:

  • Existing webhook examples showing "Requestor": null
  • Integration webhook data models using nullable Requestor types in producer and consumer services.

@carlospalmermews carlospalmermews self-assigned this Apr 22, 2026
Copilot AI review requested due to automatic review settings April 22, 2026 02:20
@carlospalmermews carlospalmermews requested a review from a team as a code owner April 22, 2026 02:20
Copy link
Copy Markdown
Contributor

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

Updates the Integration Webhooks documentation to reflect that the Requestor field in the Integration created payload is optional (nullable) rather than required.

Changes:

  • Mark Requestor as optional in the “Integration created data” table.
  • Add clarifying text about when Requestor is populated vs null.

Comment thread connector-api/events/wh-integration.md Outdated
Comment thread connector-api/events/wh-integration.md
Copy link
Copy Markdown
Member

@jnv jnv 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, but please also update the changelog and make clear it's a docs correction, not a change in behavior (use the magical formulation "Documentation-only, no change to API.").

Comment thread connector-api/events/wh-integration.md Outdated
Co-authored-by: Jan Vlnas <jan.vlnas@mews.com>
Copilot AI review requested due to automatic review settings April 23, 2026 23:36
Copy link
Copy Markdown
Contributor

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Comment thread connector-api/events/wh-integration.md Outdated
Comment thread connector-api/events/wh-integration.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 24, 2026 00:22
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

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

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comment thread connector-api/changelog/changelog2026.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 24, 2026 00:25
Copy link
Copy Markdown
Contributor

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

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

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.

issue: Wait, this is wrong file. It should go to connector-api/changelog/README.md with correct updates markup.

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.

4 participants