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.

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

Document optional clear_status query parameter for Delete Workflow API #7268

Merged
merged 5 commits into from
Jun 12, 2024

Conversation

dbwiddis
Copy link
Member

Description

opensearch-project/flow-framework#719 adds a clear_status parameter to the Delete Workflow API to also delete the corresponding workflow state document.

Targeted for 2.15 release.

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@hdhalter hdhalter added the release-notes PR: Include this PR in the automated release notes label Jun 10, 2024
@hdhalter
Copy link
Contributor

@dbwiddis - Is this ready for review by the doc team?

@dbwiddis
Copy link
Member Author

@dbwiddis - Is this ready for review by the doc team?

Yep! Ship it!

@hdhalter hdhalter added the 4 - Doc review PR: Doc review in progress label Jun 10, 2024
Copy link
Collaborator

@kolchfa-aws kolchfa-aws left a comment

Choose a reason for hiding this comment

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

Thank you, @dbwiddis! A couple of comments/suggestions that should be quick to resolve.

_automating-configurations/api/delete-workflow.md Outdated Show resolved Hide resolved
_automating-configurations/api/delete-workflow.md Outdated Show resolved Hide resolved
_automating-configurations/api/delete-workflow.md Outdated Show resolved Hide resolved
@dbwiddis
Copy link
Member Author

@dbwiddis - Is this ready for review by the doc team?

For my future reference, is there something else I should do after tech review to make this more obvious? Can I change the labels myself or do some other automation-thingie to say tech is done?

@kolchfa-aws
Copy link
Collaborator

@dbwiddis I don't know if you have the ability to add the label but that's what we do on the doc team to indicate the status of the PR. You can just comment on the PR once all tech reviews are done, and we'll move it to doc review and then editorial review. Thank you!

Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@dbwiddis @kolchfa-aws Just one minor change. Thanks!


Note that deleting a workflow only deletes the stored template but does not deprovision its resources.
Note that deleting a workflow only deletes the stored template but does not deprovision its resources.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Note that deleting a workflow only deletes the stored template but does not deprovision its resources.
Note that deleting a workflow only deletes the stored template---it does not deprovision its resources.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fixed... confirming three (3) hyphens is intended here?

Copy link
Collaborator

Choose a reason for hiding this comment

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

3 hyphens is a Markdown way to specify an em dash 😄

@kolchfa-aws kolchfa-aws added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Jun 11, 2024
@kolchfa-aws kolchfa-aws merged commit f8e0fa5 into opensearch-project:main Jun 12, 2024
6 checks passed
@hdhalter hdhalter added 3 - Done Issue is done/complete and removed 5 - Editorial review PR: Editorial review in progress labels Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Done Issue is done/complete release-notes PR: Include this PR in the automated release notes v2.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants