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 detail to pipeline file specification #77

Closed
simonl2002 opened this issue Apr 16, 2024 · 0 comments · Fixed by #85
Closed

Add detail to pipeline file specification #77

simonl2002 opened this issue Apr 16, 2024 · 0 comments · Fixed by #85
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@simonl2002
Copy link
Member

The pipeline specification documentation only gives basic information about fields.

For instance the pipeline id field. Only has the following information:

Data Type: String
Required: Yes
Default: None
<SNIP>

If you look that the code you'll see that there are only certain characters allowed and there's a length limit.
https://github.com/ConduitIO/conduit/blob/cea8874345beed93ff10634ede6401a2c56a1afb/pkg/pipeline/service.go#L30-L36

We should just have this info in the spec so someone doesn't need to go to the code to look it up.

@simonl2002 simonl2002 added the documentation Improvements or additions to documentation label Apr 16, 2024
@lovromazgon lovromazgon moved this from Triage to Todo in Conduit Main Apr 23, 2024
@maha-hajja maha-hajja self-assigned this May 1, 2024
@maha-hajja maha-hajja moved this from Todo to In Review in Conduit Main May 1, 2024
@github-project-automation github-project-automation bot moved this from In Review to Done in Conduit Main May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants