Skip to content

docs(apikit-asyncapi): clarify that XML validation is not supported#222

Open
stn1slv wants to merge 1 commit intomulesoft:v4.xfrom
stn1slv:patch-2
Open

docs(apikit-asyncapi): clarify that XML validation is not supported#222
stn1slv wants to merge 1 commit intomulesoft:v4.xfrom
stn1slv:patch-2

Conversation

@stn1slv
Copy link

@stn1slv stn1slv commented Oct 13, 2025

Add an explicit NOTE at the start of the "Validation of Messages" section stating that XML message validation is not supported and that only JSON payloads are validated against schemas.

Rationale:

  • Prevent confusion for users expecting XML schema validation
  • Align parameter wording with actual validation capabilities

This product limitation has been confirmed in GUS ID W-16756836

Writer's Quality Checklist

Before merging your PR, did you:

  • Run spell checker
  • Run link checker to check for broken xrefs
  • Check for orphan files
  • Perform a local build and do a final visual check of your content, including checking for:
    • Broken images
    • Dead links
    • Correct rendering of partials if they are used in your content
    • Formatting issues, such as:
      • Misnumbered ordered lists (steps) or incorrectly nested unordered lists
      • Messed up tables
      • Proper indentation
      • Correct header levels
  • Receive final review and signoff from:
    • Technical SME
    • Product Manager
    • Editor or peer reviewer
    • Reporter, if this content is in response to a reported issue (internal or external feedback)
  • If applicable, verify that the software actually got released

Add an explicit NOTE at the start of the "Validation of Messages" section stating that XML message validation is not supported and that only JSON payloads are validated against schemas.

Rationale:
- Prevent confusion for users expecting XML schema validation
- Align parameter wording with actual validation capabilities

Change type: documentation only
@stn1slv stn1slv requested a review from a team as a code owner October 13, 2025 10:14
Copilot AI review requested due to automatic review settings October 13, 2025 10:14
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

Adds clarification that XML message validation is not supported in the APIkit AsyncAPI module documentation. This addresses potential user confusion by explicitly stating that only JSON payloads can be validated against schemas.

Key changes:

  • Added a NOTE block at the beginning of the "Validation of Messages" section
  • Explicitly states XML validation limitation to align documentation with actual product capabilities

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@stn1slv
Copy link
Author

stn1slv commented Oct 13, 2025

This product limitation has been confirmed in GUS ID W-16756836

@stn1slv
Copy link
Author

stn1slv commented Dec 15, 2025

@Crispy-Salesforce, could you please provide a status update?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants