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

Add documentation for spring/blueprint only types that are in the generated xml dsl

    XMLWordPrintableJSON

    Details

    • Estimated Complexity:
      Unknown

      Description

      Now that we have eip documentation enriched using the maven plugin. We should see if we cannot grab the additional documentation for the spring / blueprint types such as <camelContext> and others.

      eg today the generated xsd contains

        <xs:complexType name="camelContextFactoryBean">
          <xs:complexContent>
            <xs:extension base="tns:abstractCamelContextFactoryBean">
              <xs:sequence>
                <xs:element minOccurs="0" ref="tns:properties"/>
                <xs:element minOccurs="0" ref="tns:propertyPlaceholder"/>
                <xs:element maxOccurs="unbounded" minOccurs="0" name="package" type="xs:string"/>
                <xs:element minOccurs="0" ref="tns:packageScan"/>
                <xs:element minOccurs="0" ref="tns:contextScan"/>
                <xs:element minOccurs="0" ref="tns:streamCaching"/>
                <xs:element minOccurs="0" ref="tns:jmxAgent"/>
                <xs:choice maxOccurs="unbounded" minOccurs="0">
                  <xs:element ref="tns:template"/>
                  <xs:element ref="tns:consumerTemplate"/>
                  <xs:element ref="tns:proxy"/>
                  <xs:element ref="tns:export"/>
                  <xs:element ref="tns:errorHandler"/>
                </xs:choice>
                <xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:routeBuilder"/>
                <xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:routeContextRef"/>
                <xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:restContextRef"/>
                <xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:threadPoolProfile"/>
                <xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:threadPool"/>
                <xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:endpoint"/>
                <xs:element minOccurs="0" ref="tns:dataFormats"/>
                <xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:redeliveryPolicyProfile"/>
                <xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:onException"/>
                <xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:onCompletion"/>
                <xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:intercept"/>
                <xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:interceptFrom"/>
                <xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:interceptSendToEndpoint"/>
                <xs:element minOccurs="0" ref="tns:restConfiguration"/>
                <xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:rest"/>
                <xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:route"/>
              </xs:sequence>
              <xs:attribute name="depends-on" type="xs:string"/>
              <xs:attribute name="trace" type="xs:string"/>
              <xs:attribute name="messageHistory" type="xs:string"/>
              <xs:attribute name="streamCache" type="xs:string"/>
              <xs:attribute name="delayer" type="xs:string"/>
              <xs:attribute name="handleFault" type="xs:string"/>
              <xs:attribute name="errorHandlerRef" type="xs:string"/>
              <xs:attribute name="autoStartup" type="xs:string"/>
              <xs:attribute name="shutdownEager" type="xs:string"/>
              <xs:attribute name="useMDCLogging" type="xs:string"/>
              <xs:attribute name="useBreadcrumb" type="xs:string"/>
              <xs:attribute name="allowUseOriginalMessage" type="xs:string"/>
              <xs:attribute name="runtimeEndpointRegistryEnabled" type="xs:string"/>
              <xs:attribute name="managementNamePattern" type="xs:string"/>
              <xs:attribute name="threadNamePattern" type="xs:string"/>
              <xs:attribute name="shutdownRoute" type="tns:shutdownRoute"/>
              <xs:attribute name="shutdownRunningTask" type="tns:shutdownRunningTask"/>
              <xs:attribute name="lazyLoadTypeConverters" type="xs:boolean"/>
              <xs:attribute name="typeConverterStatisticsEnabled" type="xs:boolean"/>
            </xs:extension>
          </xs:complexContent>
        </xs:complexType>
      

      We may need to let the apt plugin run on camel-spring to generate json schema files for those extra JAXB annotated classes so we can grab the documentation like we do for EIPs

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                davsclaus Claus Ibsen
                Reporter:
                davsclaus Claus Ibsen
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: