You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@camel.apache.org by "Claus Ibsen (Jira)" <ji...@apache.org> on 2022/09/03 11:01:00 UTC

[jira] [Updated] (CAMEL-17620) Document data type in body from the endpoints of each component

     [ https://issues.apache.org/jira/browse/CAMEL-17620?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Claus Ibsen updated CAMEL-17620:
--------------------------------
    Fix Version/s: 3.x

> Document data type in body from the endpoints of each component
> ---------------------------------------------------------------
>
>                 Key: CAMEL-17620
>                 URL: https://issues.apache.org/jira/browse/CAMEL-17620
>             Project: Camel
>          Issue Type: Task
>          Components: documentation
>    Affects Versions: 3.15.0
>            Reporter: Tadayoshi Sato
>            Priority: Major
>             Fix For: 3.x
>
>
> I sometimes see users complaining that it is not clear about what data type they can expect from an endpoint for further processing in the route.
> The endpoint parameters are well documented already but the data type each endpoint should return is rarely documented, for example:
> https://camel.apache.org/components/3.15.x/twitter-search-component.html
> It would be great if we can find some way to automate the documentation of the data type an endpoint returns, or at least document them manually.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)