mirror of
https://github.com/mattermost/mattermost.git
synced 2026-10-13 09:27:38 +08:00
* Added server and client side frameowkr for configuring settings * Type fixes * Added test mocks * Review fixes * Restored gotool go modules * CI * (2) - Post tracking audit event implementation (#37919) * Initial implementation for generating delivery tracking * Initial implementation for generating delivery tracking * Some performance improvements * Some performance improvements * Record list.Posts instead of list.Order * Fixed email batch delivery recording * Fixed a couple of pending delivery mechanisms * Caching fixes * another few fixes * Stub DeliveryTracking in store mocks used by cache purge InvalidateAllCachesSkipSend now also clears the delivery tracking store's caches. The partial store mocks in these tests mirror the store list that function touches, so the added call panicked with an unexpected DeliveryTracking() during test cleanup. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> * Recorded post delivery event after JSON encoding succeeds * Updated decisionmkaing point in email delivery tracking * Plugin hook handling * Added the Learn More button on delivery tracking section * Added in inline code comment for explaining a decision * Restored go modules * Updated indirect status of a go dependency * Removed learn more button * fixed a test --------- Co-authored-by: Claude Opus 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
68 lines
3.2 KiB
YAML
68 lines
3.2 KiB
YAML
/api/v4/delivery_tracking/config:
|
|
get:
|
|
summary: Get the post delivery audit logging configuration
|
|
description: |
|
|
Returns the post delivery audit logging configuration: whether the feature is enabled, whether it applies to
|
|
all channels, and the ids of the channels deliveries are recorded in.
|
|
|
|
Requires an Enterprise Advanced license and the `PostDeliveryTracking` feature flag. Only system admins can
|
|
access this endpoint.
|
|
tags:
|
|
- Delivery Tracking
|
|
operationId: GetDeliveryTrackingConfig
|
|
responses:
|
|
'200':
|
|
description: Configuration retrieved successfully
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/DeliveryTrackingConfig"
|
|
'403':
|
|
description: User does not have permission to manage system configuration.
|
|
'500':
|
|
description: Internal server error.
|
|
'404':
|
|
description: |
|
|
The endpoint is not registered because the `PostDeliveryTracking` feature flag was disabled at server start. Enabling the flag requires a server restart.
|
|
'501':
|
|
description: An Enterprise Advanced license is not available, or the `PostDeliveryTracking` feature flag was disabled after the server started.
|
|
put:
|
|
summary: Update the post delivery audit logging configuration
|
|
description: |
|
|
Updates the post delivery audit logging configuration.
|
|
|
|
`ChannelIds` fully replaces the stored list. Omit the field to leave the stored list unchanged; send an empty
|
|
array to clear it. An empty array is only accepted when the resulting configuration is still valid, which means
|
|
`EnableForAllChannels` must be true. Turning `Enable` off does not clear the list.
|
|
|
|
Direct and group message channels can never be recorded. The request is rejected in full if any submitted
|
|
channel is a DM or GM, or does not exist.
|
|
|
|
Requires an Enterprise Advanced license and the `PostDeliveryTracking` feature flag. Only system admins can
|
|
access this endpoint.
|
|
tags:
|
|
- Delivery Tracking
|
|
operationId: UpdateDeliveryTrackingConfig
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/DeliveryTrackingConfig"
|
|
responses:
|
|
'200':
|
|
description: Configuration updated successfully
|
|
'400':
|
|
description: |
|
|
Bad request. Returned when `EnableForAllChannels` is false and no channels are selected, when a channel id
|
|
is malformed, when a submitted channel does not exist, or when a submitted channel is a DM or GM.
|
|
'403':
|
|
description: User does not have permission to manage system configuration.
|
|
'500':
|
|
description: Internal server error.
|
|
'404':
|
|
description: |
|
|
The endpoint is not registered because the `PostDeliveryTracking` feature flag was disabled at server start. Enabling the flag requires a server restart.
|
|
'501':
|
|
description: An Enterprise Advanced license is not available, or the `PostDeliveryTracking` feature flag was disabled after the server started.
|