Output notification handler messages as a header #15786
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prerequisites
Description
This PR appends notification messages from serverside notification handlers to the Management API output. The notification messages are output in the
Umb-Notifications
header. The Swagger docs should reflect this.Messages are only ever appended to non-GET API operations, as notifications are only produced on state changes. Likewise, 401 responses will never produce notifications, so these have been explicitly filtered out when appending the
Umb-Notifications
header in the OpenAPI schema.Testing this PR
Umb-Notifications
header.Umb-Notifications
header - neither in API outputs, nor in the Swagger docs.Umb-Notifications
header in the Swagger docs.A code snippet for testing has been included below.
Test notification handlers