From 52581cec50359bf24ac70ee22bc7c2ff591c5548 Mon Sep 17 00:00:00 2001 From: Loi Le Date: Mon, 30 Mar 2026 15:36:30 +0700 Subject: [PATCH] [CMX-4574] - Update docs --- spec/openapi.yaml | 36 ++++++++++++++++++++++++++++++------ 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/spec/openapi.yaml b/spec/openapi.yaml index e7e4c33..e42b552 100644 --- a/spec/openapi.yaml +++ b/spec/openapi.yaml @@ -6417,13 +6417,21 @@ components: type: string example: "+61555555555" metadata_key: - description: Filter results for messages that include a metadata key. + description: Filter results for messages that include a metadata key. Can be used independently for searching. type: string example: broadcastId metadata_value: - description: Filter results for messages that include a metadata key containing this value. If this parameter is provided, the metadata_key parameter must also be provided. + description: Filter results for messages that include a metadata key containing this value. If this parameter is provided, the metadata_key parameter must also be provided. Cannot be used together with metadata_values. type: string example: ABC + metadata_values: + description: Filter results for messages that include a metadata key containing these values. Must be used together with metadata_key. Cannot be used together with metadata_value. + type: array + items: + type: string + example: + - meta1 + - meta2 accounts: description: >- Filter results by a specific account. By default results @@ -6485,13 +6493,21 @@ components: type: string example: "+61555555555" metadata_key: - description: Filter results for messages that include a metadata key. + description: Filter results for messages that include a metadata key. Can be used independently for searching. type: string example: broadcastId metadata_value: - description: Filter results for messages that include a metadata key containing this value. If this parameter is provided, the metadata_key parameter must also be provided. + description: Filter results for messages that include a metadata key containing this value. If this parameter is provided, the metadata_key parameter must also be provided. Cannot be used together with metadata_values. type: string example: ABC + metadata_values: + description: Filter results for messages that include a metadata key containing these values. Must be used together with metadata_key. Cannot be used together with metadata_value. + type: array + items: + type: string + example: + - meta1 + - meta2 accounts: description: >- Filter results by a specific account. By default results @@ -6590,13 +6606,21 @@ components: - "+61555555555" - "+614987654321" metadata_key: - description: Filter results for messages that include a metadata key. + description: Filter results for messages that include a metadata key. Can be used independently for searching. type: string example: broadcastId metadata_value: - description: Filter results for messages that include a metadata key containing this value. If this parameter is provided, the metadata_key parameter must also be provided. + description: Filter results for messages that include a metadata key containing this value. If this parameter is provided, the metadata_key parameter must also be provided. Cannot be used together with metadata_values. type: string example: ABC + metadata_values: + description: Filter results for messages that include a metadata key containing these values. Must be used together with metadata_key. Cannot be used together with metadata_value. + type: array + items: + type: string + example: + - meta1 + - meta2 accounts: description: >- Filter results by a specific account. By default results