[
https://issues.apache.org/jira/browse/CAMEL-25736?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Claus Ibsen reassigned CAMEL-25736:
-----------------------------------
Assignee: Claus Ibsen
> YAML examples for the components, data formats and languages whose docs have
> none, so the AI tools have samples
> ---------------------------------------------------------------------------------------------------------------
>
> Key: CAMEL-25736
> URL: https://issues.apache.org/jira/browse/CAMEL-25736
> Project: Camel
> Issue Type: Improvement
> Components: camel-jbang, documentation
> Reporter: Claus Ibsen
> Assignee: Claus Ibsen
> Priority: Major
> Fix For: 4.24.0
>
>
> {{camel_catalog_sample}} returns the YAML examples of the documentation that
> validate, for the AI tools (camel-jbang-mcp, {{camel ask}}). Checked through
> the MCP server on Oct 17, with CAMEL-25719 and CAMEL-25735:
> * components: 294 of 413 return a sample of their own
> * data formats: 42 of 56
> * languages: 25 of 29
> * the 18 top-level entries of the YAML DSL: all
> h3. 1. YAML that is in the docs, but not read
> * 14 YAML route blocks with a delimiter longer than {{----}} (3 pages:
> ibm-watson-discovery, ibm-watson-language, spiffe). AsciiDoc allows it; the
> extractor only reads {{----}}.
> * 39 YAML route blocks that start with a comment line (20 pages, such as jms,
> netty, exec, google-mail, keycloak, kubernetes-events, mina-sftp,
> langchain4j-agent, dataset). The extractor skips a block that does not start
> with {{- }}.
> Fix in {{CatalogSamples}} (and the sample generator for the EIP and manual
> pages).
> h3. 2. Pages with no YAML example
> *Data formats (14)*, Java or XML examples only, except fhir with none: asn1,
> barcode, bindyCsv, bindyFixed, bindyKvp, crypto, fhirJson, fhirXml, flatpack,
> fory, jaxb, jsonApi, mimeMultipart, parquetAvro
> *Languages (4)*: file, js, openfeature, python
> *Components with Java or XML examples only (88)*: alibaba-eventbridge,
> alibaba-fc, alibaba-kms, alibaba-mns, alibaba-oss, alibaba-ots, alibaba-sls,
> alibaba-sms, amqp, as2, aws-bedrock-agent, aws-bedrock-agent-runtime,
> aws2-ddb, aws2-ddbstream, aws2-textract, aws2-transcribe, aws2-translate,
> caffeine-loadcache, citrus, clickhouse, clickup, coap, coap+tcp, coaps,
> coaps+tcp, cometd, cometds, consul, controlbus, cql, disruptor-vm, drill,
> duckdb, ehcache, fhir, ftps, google-bigquery, google-bigquery-sql,
> google-calendar, google-calendar-stream, google-drive, google-mail-stream,
> google-sheets, google-sheets-stream, jira, kudu, langchain4j-ingest, ldap,
> ldif, milo-browse, milo-client, milo-server, milvus, mllp, mock, neo4j, opa,
> openfeature, openfga, openstack-cinder, openstack-glance, openstack-keystone,
> openstack-neutron, openstack-nova, openstack-swift, pgevent, plc4x, pulsar,
> qdrant, quickfix, rest-postman, scp, servicenow, smb, spring-jdbc,
> spring-ldap, spring-redis, sql-stored, stax, stitch, twilio, typesafe-ai,
> vertx, webhook, whatsapp, wordpress, workday, zendesk
> *Components with no example at all (27)*: aws-cloudtrail, aws-config,
> chatscript, cm-sms, hazelcast-set, ignite-cache, ignite-compute,
> ignite-events, ignite-idgen, ignite-messaging, ignite-queue, ignite-set, jmx,
> kubernetes-cronjob, kubernetes-custom-resources, pinecone, rest-api, saga,
> spring-event, stub, tahu-edge, tahu-host, twitter-directmessage,
> twitter-search, twitter-timeline, validator, weaviate
> h3. Approach
> Write each example in the canonical YAML DSL, mostly from the Java or XML
> example already on the page, and check it with {{camel run}} where the
> component can run without an external system. Go in batches, most used first:
> jaxb, bindy, crypto and flatpack; mock, controlbus, validator, stub, saga,
> rest-api, jmx; amqp, ftps, scp, smb, sql-stored, spring-jdbc, ldap, consul,
> ehcache, caffeine-loadcache.
> _Claude Code on behalf of davsclaus_
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
