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

Missing javadoc on rest-dsl model

    Details

    • Type: Task
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 2.19.0
    • Fix Version/s: 2.19.0
    • Component/s: camel-core
    • Labels:
      None
    • Estimated Complexity:
      Unknown

      Description

      We get a warning such as

      [INFO] --- camel-eip-documentation-enricher-maven-plugin:2.19.0-SNAPSHOT:eip-documentation-enricher (eip-documentation-enricher) @ camel-blueprint ---
      [INFO] Found 221 models to use when enriching the XSD schema
      [WARNING] Cannot find documentation for name: method in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
      [WARNING] Cannot find documentation for name: uri in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
      [WARNING] Cannot find documentation for name: consumes in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
      [WARNING] Cannot find documentation for name: produces in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
      [WARNING] Cannot find documentation for name: bindingMode in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
      [WARNING] Cannot find documentation for name: skipBindingOnErrorCode in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
      [WARNING] Cannot find documentation for name: enableCORS in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
      [WARNING] Cannot find documentation for name: routeId in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
      [WARNING] Cannot find documentation for name: apiDocs in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/delete.json
      [WARNING] Cannot find documentation for name: consumes in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
      [WARNING] Cannot find documentation for name: produces in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
      [WARNING] Cannot find documentation for name: bindingMode in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
      [WARNING] Cannot find documentation for name: skipBindingOnErrorCode in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
      [WARNING] Cannot find documentation for name: enableCORS in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
      [WARNING] Cannot find documentation for name: component in json schema: /Users/davsclaus/workspace/camel/components/camel-blueprint/target/../../../camel-core/target/classes/org/apache/camel/model/rest/restBinding.json
      

      The same would building platforms/camel-catalog warn about later on.

      We need to ensure the model is fully documented before a release

        Attachments

          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: