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

[DOC] Use case parameter is not documented on Flow Framework Create Workflow API #8167

Closed
1 of 4 tasks
dbwiddis opened this issue Sep 4, 2024 · 0 comments · Fixed by #8171
Closed
1 of 4 tasks

[DOC] Use case parameter is not documented on Flow Framework Create Workflow API #8167

dbwiddis opened this issue Sep 4, 2024 · 0 comments · Fixed by #8171
Assignees
@dbwiddis
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. 2 - In progress Issue/PR: The issue or PR is in progress. v-All This issue is valid for all versions through 1.3

Comments

@dbwiddis
Copy link
Member

dbwiddis commented Sep 4, 2024 •
edited
Loading

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request.

Flow Framework Create Workflow API does not mention the use_case parameter: https://opensearch.org/docs/latest/automating-configurations/api/create-workflow/

There's an entire page devoted to it here: https://opensearch.org/docs/latest/automating-configurations/workflow-templates/

We should document the api parameter and refer to that page.

Version: List the OpenSearch version to which this issue applies, e.g. 2.14, 2.12--2.14, or all.

Introduced 2.13 with GA.

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
@dbwiddis dbwiddis self-assigned this Sep 4, 2024
This was referenced Sep 4, 2024
Closed
Merged
@Naarcha-AWS Naarcha-AWS added 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. v-All This issue is valid for all versions through 1.3 2 - In progress Issue/PR: The issue or PR is in progress. and removed untriaged labels Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dbwiddis dbwiddis

Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. 2 - In progress Issue/PR: The issue or PR is in progress. v-All This issue is valid for all versions through 1.3
Projects
None yet
Milestone
No milestone
2 participants
@dbwiddis @Naarcha-AWS