apache / apache/camel-kamelets

Kamelet Catalog Website - Add some more information

Open
#328 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
71
Forks
88
Avg merge
1d 13h
Merged PRs (30d)
70

Description

1)
It would be good to declare for sources what the output is

For example for chuck norris the output is text/plain
https://github.com/apache/camel-kamelets/blob/main/chuck-norris-source.kamelet.yaml#L25

And for many other sources it would be application/json

2)
And for sinks its the opposite, eg to list what the expected input type is
It may be that if there is no specific content-type declared then we would not really know. So maybe we should go over all the existing Kamelets and ensure they have IN and OUT types declared.

In this sink you can only see from the description that it expects the input to be a json array
https://github.com/apache/camel-kamelets/blob/main/cassandra-sink.kamelet.yaml#L27

3)
And it would be good if we can have examples on the input and output type also, like we can have for input parameters.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the referenced chuck-norris-source.kamelet.yaml and cassandra-sink.kamelet.yaml entries, then inspect how the Kamelet Catalog Website reads and displays their metadata. Define how source outputs, sink inputs, and input/output examples should appear, and verify the catalog consistently exposes this information for existing Kamelets.

Written by the indexing model from the issue text.

Assessment

Tech stack
yaml
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.