Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[EDR Workflows] Correct bugs in Execute action API docs #4236

Merged
merged 6 commits into from
Jan 23, 2024
Merged

[EDR Workflows] Correct bugs in Execute action API docs #4236

merged 6 commits into from
Jan 23, 2024

Conversation

kevinlog
Copy link
Contributor

Updates the Execute API docs based on user feedback.

  • Corrects bug in one of the API parameters where a string was listed, but it should be an integer in seconds
  • Adds a note to inform the user that the document upload functionality is rate limited, so they should batch bulk Endpoint calls.

@github-actions GitHub Actions
Copy link

Documentation previews:

natasha-moore-elastic
natasha-moore-elastic reviewed Nov 13, 2023
View reviewed changes
Copy link
Contributor

@natasha-moore-elastic natasha-moore-elastic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making these updates @kevinlog! LGTM, I've left a couple of questions and minor suggestions.

docs/management/api/execute-api.asciidoc Outdated Show resolved Hide resolved
docs/management/api/execute-api.asciidoc Outdated Show resolved Hide resolved
docs/management/api/execute-api.asciidoc Outdated Show resolved Hide resolved
docs/management/api/execute-api.asciidoc Outdated Show resolved Hide resolved
docs/management/api/execute-api.asciidoc Outdated Show resolved Hide resolved
@natasha-moore-elastic natasha-moore-elastic requested a review from a team November 13, 2023 13:11
joepeeples
joepeeples reviewed Nov 20, 2023
View reviewed changes
Copy link
Contributor

@joepeeples joepeeples left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@natasha-moore-elastic I'm finishing this review as "Comment" since I think our new branch protections will cancel any approval once you commit the open edit suggestions, but everything LGTM. Please ping me again when the edits are merged and I can give the necessary approval! ✅

docs/management/api/execute-api.asciidoc Outdated Show resolved Hide resolved
@natasha-moore-elastic
Copy link
Contributor

@natasha-moore-elastic I'm finishing this review as "Comment" since I think our new branch protections will cancel any approval once you commit the open edit suggestions, but everything LGTM. Please ping me again when the edits are merged and I can give the necessary approval! ✅

Hey @joepeeples, did you mean to tag me here? The PR was opened by @kevinlog.

@dasansol92
Copy link
Contributor

For my own understanding, what's the behavior if this field is not specified?

@natasha-moore-elastic it defaults to 4 hours.
cc: @ashokaditya @paul-tavares

@natasha-moore-elastic
Copy link
Contributor

For my own understanding, what's the behavior if this field is not specified?

@natasha-moore-elastic it defaults to 4 hours. cc: @ashokaditya @paul-tavares

Thanks @dasansol92, I will then add back this sentence, which was originally part of the description:

If no timeout is specified, it defaults to four hours.

@natasha-moore-elastic natasha-moore-elastic added v8.12.0 v8.13.0 Team: EDR Workflows Formerly Defend Workflows, Onboarding and Lifecycle Management API labels Jan 23, 2024
@natasha-moore-elastic natasha-moore-elastic merged commit a108e52 into main Jan 23, 2024
3 checks passed
@natasha-moore-elastic natasha-moore-elastic deleted the task/correct-errors-execute-action branch January 23, 2024 15:00
mergify bot pushed a commit that referenced this pull request Jan 23, 2024
@kevinlog @mergify
[EDR Workflows] Correct bugs in Execute action API docs (#4236)
7d4364c 
* [EDR Workflows] Correct bugs in Execute action API docs

* Update docs/management/api/execute-api.asciidoc

Co-authored-by: Joe Peeples <[email protected]>

* Update docs/management/api/execute-api.asciidoc

* Update docs/management/api/execute-api.asciidoc

* Applies review feedback

---------

Co-authored-by: natasha-moore-elastic <[email protected]>
Co-authored-by: Joe Peeples <[email protected]>
Co-authored-by: natasha-moore-elastic <[email protected]>
(cherry picked from commit a108e52)
@mergify mergify bot mentioned this pull request Jan 23, 2024
Closed
mergify bot pushed a commit that referenced this pull request Jan 23, 2024
@kevinlog @mergify
[EDR Workflows] Correct bugs in Execute action API docs (#4236)
6af81da 
* [EDR Workflows] Correct bugs in Execute action API docs

* Update docs/management/api/execute-api.asciidoc

Co-authored-by: Joe Peeples <[email protected]>

* Update docs/management/api/execute-api.asciidoc

* Update docs/management/api/execute-api.asciidoc

* Applies review feedback

---------

Co-authored-by: natasha-moore-elastic <[email protected]>
Co-authored-by: Joe Peeples <[email protected]>
Co-authored-by: natasha-moore-elastic <[email protected]>
(cherry picked from commit a108e52)
@mergify mergify bot mentioned this pull request Jan 23, 2024
Closed
natasha-moore-elastic added a commit that referenced this pull request Jan 23, 2024
@natasha-moore-elastic
[8.12] [EDR Workflows] Correct bugs in Execute action API docs (backp…
761c6fc 
…ort #4236)
@natasha-moore-elastic natasha-moore-elastic mentioned this pull request Jan 23, 2024
Merged
natasha-moore-elastic added a commit that referenced this pull request Jan 24, 2024
@natasha-moore-elastic
[8.12] [EDR Workflows] Correct bugs in Execute action API docs (backp…
c329b7b 
…ort #4236) (#4656)
mergify bot pushed a commit that referenced this pull request Jan 24, 2024
@natasha-moore-elastic @mergify
[8.12] [EDR Workflows] Correct bugs in Execute action API docs (backp…
68baabc 
…ort #4236) (#4656)

(cherry picked from commit c329b7b)
natasha-moore-elastic added a commit that referenced this pull request Jan 24, 2024
@mergify @natasha-moore-elastic
[8.12] [EDR Workflows] Correct bugs in Execute action API docs (backp…
c7fdc66 
…ort #4236) (#4656) (#4664)

(cherry picked from commit c329b7b)

Co-authored-by: natasha-moore-elastic <[email protected]>
acorretti pushed a commit that referenced this pull request Nov 19, 2024
@natasha-moore-elastic
[8.12] [EDR Workflows] Correct bugs in Execute action API docs (backp…
9a5b631 
…ort #4236)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@natasha-moore-elastic natasha-moore-elastic natasha-moore-elastic left review comments

@dasansol92 dasansol92 dasansol92 left review comments

@ashokaditya ashokaditya ashokaditya left review comments

@joepeeples joepeeples joepeeples approved these changes

Assignees
No one assigned
Labels
API Team: EDR Workflows Formerly Defend Workflows, Onboarding and Lifecycle Management v8.11.0 v8.12.0 v8.13.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@kevinlog @natasha-moore-elastic @dasansol92 @ashokaditya @joepeeples