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

Add Flow Mode schema YAML #5863

Closed
wants to merge 1 commit into from
Closed

Conversation

thampiotr
Copy link
Contributor

@thampiotr thampiotr commented Nov 27, 2023

WIP / draft

PR Description

This adds a YAML representation of all possible components, their arguments, and their exports that are supported by the agent. This can be useful for all sorts of automation:

Notes to the Reviewer

Still WIP:

  • Need to fix some names not matching our docs - should we fix docs or add special cases for name mappings?
  • Some of this could be ported into River repository - decide what
  • Further check this is correct, looking at docs etc. Sometimes docs are not correct though. They should probably be corrected in separate PRs?
  • If Add auto-generated connected components in documentation #5791 is merged, rebase main and use the schema instead of metadata package.

PR Checklist

  • CHANGELOG.md updated
  • Documentation added
  • Tests updated
  • Config converters updated

Sorry, something went wrong.

Comment on lines +107 to +108
} else if fieldType.String() == "time.Duration" {
return "duration"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Example of how a different name can be used in YAML schema so that it matches our docs better.

Copy link
Contributor

This PR has not had any activity in the past 30 days, so the needs-attention label has been added to it.
If you do not have enough time to follow up on this PR or you think it's no longer relevant, consider closing it.
The needs-attention label signals to maintainers that something has fallen through the cracks. No action is needed by you; your PR will be kept open and you do not have to respond to this comment. The label will be removed the next time this job runs if there is new activity.
Thank you for your contributions!

@github-actions github-actions bot added the needs-attention An issue or PR has been sitting around and needs attention. label Dec 29, 2023
@thampiotr
Copy link
Contributor Author

This is not currently worked on. Closing for now, we may bring it back in the future.

@thampiotr thampiotr closed this Jan 8, 2024
@github-actions github-actions bot added the frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. label Feb 21, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 21, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
frozen-due-to-age Locked due to a period of inactivity. Please open new issues or PRs if more discussion is needed. needs-attention An issue or PR has been sitting around and needs attention.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant