Uploaded image for project: 'Camel'
  1. Camel
  2. CAMEL-17620

Document data type in body from the endpoints of each component

    XMLWordPrintableJSON

Details

    • Task
    • Status: Open
    • Major
    • Resolution: Unresolved
    • 3.15.0
    • 3.x
    • documentation
    • None
    • Unknown

    Description

      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.

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              tadayosi Tadayoshi Sato
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated: