Skip to content

Commit

Permalink
improve the outputs_key_field description in command result class (#1362
Browse files Browse the repository at this point in the history
)

* improve the outputs_key_field description in command result class

* improve

* cr fixes
  • Loading branch information
MosheEichler authored Jun 29, 2023
1 parent 3b53bf7 commit a0f4213
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/integrations/code-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) |
Expand Down

0 comments on commit a0f4213

Please sign in to comment.