From a0f4213cb605421aa384636ce6a8e36a0f3f7c9e Mon Sep 17 00:00:00 2001 From: Moshe Eichler <78307768+MosheEichler@users.noreply.github.com> Date: Thu, 29 Jun 2023 08:14:12 +0300 Subject: [PATCH] improve the outputs_key_field description in command result class (#1362) * improve the outputs_key_field description in command result class * improve * cr fixes --- docs/integrations/code-conventions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/code-conventions.md b/docs/integrations/code-conventions.md index 560ebc1d8..fb8e575c5 100644 --- a/docs/integrations/code-conventions.md +++ b/docs/integrations/code-conventions.md @@ -909,7 +909,7 @@ This class is used to return outputs. This object represents an entry in warroom | Arg | Type | Description | |-------------------|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | outputs_prefix | str | Should be identical to the prefix in the yml contextPath in yml file. for example: CortexXDR.Incident | -| outputs_key_field | str | Primary key field in the main object. If the command returns Incidents, and of the properties of Incident is incident_id, then outputs_key_field='incident_id' | +| outputs_key_field | str | Primary key field in the main object. If the command returns incidents, and one of the properties of the incident is incident_id, then outputs_key_field='incident_id' | | outputs | list / dict | (Optional) The data to be returned and will be set to context. If not set, no data will be added to the context | | readable_output | str | (Optional) markdown string that will be presented in the War Room, should be human readable - (HumanReadable) - if not set, readable output will be generated via tableToMarkdown function | | raw_response | object | (Optional) must be dictionary, if not provided then will be equal to outputs. Usually must be the original raw response from the 3rd party service (originally Contents) |