Uploaded image for project: 'Fuse Tooling'
  1. Fuse Tooling
  2. FUSETOOLS-767

Camel endpoint documentation uses wrong names

    XMLWordPrintable

Details

    • Documentation
    • Resolution: Done
    • Major
    • 7.1.0
    • None
    • None
    • None

    Description

      The documentation for the http scheme doesn't correctly document the headers of interest (I imagine other scheme's documentation may have the same problem). This is actually a problem with the on-line documentation for that scheme as well so perhaps that's where this originates from:

      http://camel.apache.org/http.html

      If you look at the "Message Headers" section the rows in the table give names like "Exchange.HTTP_QUERY". Those in the IDE's documentation remove "Exchange." so say just "HTTP_QUERY" but this is referring to a constant on the Exchange class, not the value of that constant which makes that bit of documentation mis-leading and not at all useful.

      E.g.
      Exchange.HTTP_QUERY="CamelHttpQuery"
      and the header that needs to be set is on an Exchange object "CamelHttpQuery", not "HTTP_QUERY".

      You really have to combine the documentation with the javadoc of the Exchange class. The real values can be seen:
      http://camel.apache.org/maven/current/camel-core/apidocs/constant-values.html#org.apache.camel.Exchange.BREADCRUMB_ID

      Attachments

        Activity

          People

            jmurphey_jira Jane Murphey (Inactive)
            jastrachan_jira James Strachan (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: