Repository navigation
CAMEL-24961: Catalog body types for the core components and languages - #28276
Conversation
…s, and the body it leaves after a step A @BodyTypes annotation on the endpoint, data format or language class says the body per side (consumerOut, consumerReply, producerIn, producerOut, marshal, unmarshal and expression in and out): its carriers (null, text, bytes, stream, file, value, map, list, pojo, unchanged, any, unknown), the Java type when it is always the same, the format, the options it depends on, the body for other option values, and a description. The package plugin writes it as a bodyTypes section of the catalog JSON and checks that each side fits the kind and that the options it names exist. A subclass declares its own. The first slice: file, direct, seda, timer, cron, kamelet, http, https, rest-openapi, xslt, sql and the json data format (jackson), read from the code that sets the body and checked against the body types the message history records when routes run. camel_catalog_doc returns them. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…tp, jms, kafka, aws2-sqs, the csv, jacksonXml and yaml data formats, and the languages The second slice of the catalog body types: - components: platform-http, rest (and the rest-openapi consumer), ftp, ftps, sftp, jms, activemq, activemq6, amqp, kafka, aws2-sqs, log, mock, scheduler, quartz; - data formats: csv, jacksonXml, snakeYaml; - languages: simple, constant, jsonpath, xpath, groovy, jq. Each value is read from the code that sets the body, and checked against the body types the message history recorded when the tests of the modules and reference routes ran (the ftp integration tests included). camel_catalog_doc gives the body types a line per side, and its answer is cut at 18000 characters instead of 16000, so the four sides of the jms components leave the options a limit asks for room. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
paho-mqtt5: the consumer gives the payload as a byte array, the producer sends what converts to one and leaves the body unchanged. mongodb: the consumer gives a Document (or null for a change without its full document with changeStreams); the producer takes a document or a query, and leaves a body by operation: a Document or null for a find of one, a List for findAll, findDistinct and aggregate, a Long for count, the result of the driver for the other writes. Read from the code that sets the body, and checked against a mosquitto and a mongodb container started with camel infra. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…ts an option value without carriers
From the review of PR 28241:
- An iterator is read once and has no size and no index, so tooling that
reads list as a List accepts ${body.size()} or ${body[0]} on it, which fail
at runtime. The new iterator carrier names it: sql with outputType=StreamList
gives an iterator, not a list.
- A @BodyType.When with no carriers (carrier = {}) wrote "carriers": [] into
the catalog. The build now rejects it, as it does a side without carriers.
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…MEL-24961-catalog-body-types-2 Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
… camel_catalog_doc says unknown for no carriers From the review of PR 28242: - The csv data format with lazyLoad=true gives an iterator, with the iterator carrier of PR 28241, not a list. - camel_catalog_doc says unknown for a body without carriers, instead of failing. The build rejects it now, but a catalog read from elsewhere may have one. - Sqs2Endpoint imports org.apache.camel.spi.* already: only the import of the nested BodyType.Carrier stays. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…types of the catalog instead of their own tables The YAML validator's body walks read what a component or a data format does with the body from the catalog, instead of from tables in their source: - the consumer a route starts with (consumerOut): the file as read, text, bytes or data, instead of the file consumer only; - the body after a to: (producerOut): unchanged for log and mock and now for a file write, the response of the http producer as bytes or a stream; - the producers that need text (producerIn), instead of file, ftp, ftps and sftp only; - the body after an unmarshal (unmarshalOut), instead of the json, jacksonXml, yaml and csv table and the options that make something else; - the consumers that reply with text (consumerReply), instead of platform-http; - the consumers that give no body, instead of timer, quartz, scheduler and cron. A side holds for a step only when the step decides every option it depends on: an option the component can also be configured with (the valueDeserializer of kafka) counts only when the endpoint sets it, and a placeholder value is not known. The catalog of an older Camel version has no body types, so the validator's own catalog stands in for it. After a step that fails at runtime the walk stops, so a file write that keeps the body is reported once. The rules about HTTP methods, REST bindings and EIPs stay in the validator; the EIPs get body types with CAMEL-25928. The same reports as before on 1204 human-written route files (the Camel repository, the examples, kamelets, camel-k and camel-kit) and on 1209 model-written ones (the r17 benchmark series), and the doc examples of the validator tests still validate. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…docling, milvus, qdrant, ai-tool and ibm-watson-language The AI components declare the body they need and the body they leave, per operation where the operation decides it. The answer of openai and langchain4j-chat is text, also when it is asked for JSON, so the YAML validator now reports a field read on it that has no unmarshal before. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
… endpoint count for its body types The operation of openai is in the path (openai:embeddings), so the validator reads the path options with the syntax of the component, as the catalog parses an endpoint. A path the catalog cannot read, such as a toD with an expression, says nothing about its options. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…pe for a value its option cannot have A byOption value must be one of the enum of its option, or true or false for a boolean, ignoring case as tooling compares it with the endpoint: a misspelled operation such as embedding for embeddings would never hold. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
The attribute holds an array, and the catalog JSON and BodyTypeModel call the same field carriers. The Javadoc of BodyTypeModel.isUnknown() says that a side with no carriers is unknown too. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…MEL-24961-catalog-body-types-2
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…AMEL-24961-catalog-body-types-3
…AMEL-24961-catalog-body-types-ai # Conflicts: # tooling/maven/camel-package-maven-plugin/src/main/java/org/apache/camel/maven/packaging/BodyTypesHelper.java
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
The body types of aws2-s3, azure-storage-blob, azure-files, dropbox, google-storage, ibm-cos and minio, read from the code and checked at runtime against LocalStack S3 (aws2-s3, and ibm-cos and minio through their S3 API) and Azurite (azure-storage-blob). The pages of aws2-s3, google-storage and minio said getObject returns an S3Object, a Blob or a MinioObject: it returns the content of the object. The validator calls a body the file as read (a GenericFile) only when the file is its only carrier, not for a blob that is a stream or a file. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…e data format and language schemas Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…-types' into feature/CAMEL-24961-catalog-body-types-2
…AMEL-24961-catalog-body-types-3
…AMEL-24961-catalog-body-types-ai
…AMEL-24961-catalog-body-types-storage
…n read as a list, as the carriers do Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
The body types of aws2-sns, aws2-kinesis, aws2-kinesis-firehose, google-pubsub, azure-servicebus, azure-eventhubs and azure-storage-queue, read from the code and checked at runtime against LocalStack (SNS and Kinesis), the Pub/Sub emulator and Azurite (queues). aws2-sqs sends bytes, a stream or a file as text as well, and sendBatchMessage takes a SendMessageBatchRequest too, which its producer side now says. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…AMEL-24961-catalog-body-types-3
…ature/CAMEL-24961-catalog-body-types-messaging
…AMEL-24961-catalog-body-types-ai
…AMEL-24961-catalog-body-types-storage
The body types of bean, class, browse, controlbus, dataformat, dataset, dataset-test, dynamic-router, dynamic-router-control, event, exec, knative, language, once, ref, rest-api, saga, stream, stub, validator, wasm and xslt-saxon, and of the bean, header, exchangeProperty, variable, ref, file, tokenize and xtokenize languages, read from the code and checked at runtime with camel run (knative over a local environment file). The xpath and jq languages read the source option instead of the body when it is set, which their expressionIn now says, as tokenize and xtokenize do. The component docs of stream, exec, language, once, browse and dataset said things about the body that the code does not do. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
|
🌟 Thank you for your contribution to the Apache Camel project! 🌟 🐫 Apache Camel Committers, please review the following items:
|
gnodet-bot
left a comment
There was a problem hiding this comment.
All 6 documentation fixes verified against source code and official documentation:
browse-component.adoc—getBody()→getBody(String.class): correct — the variable is typedString, sogetBody(String.class)is the type-safe Camel idiom.dataset-component.adoc—defaultHeadersdescribed as "default message body" → "default message headers": correct — the property isMap<String,Object>for headers.language-component.adoc—${body} * 2}→body * 2: correct —${body}is Simple language syntax, not Groovy; also fixes the trailing mismatched}.language-component.adoc— addedallowTemplateFromHeader=true: correct — required when providing a script via theCamelLanguageScriptheader (security default isfalse).once-component.adoc—body=file.data.json→body=file:data.json: correct —file:is the documented URI scheme prefix per thebodyparameter description.stream-component.adoc—header→stream: correct —StreamProducer.javaconfirmsexchange.getIn().getHeader("stream").
The @BodyTypes annotation additions and JSON catalog changes are consistent metadata enhancements.
This review was generated by an AI agent, Hermès on behalf of @gnodet.
…feature/CAMEL-24961-catalog-body-types-core
…as the other components do Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
ref, dataformat, the language component and the ref language said unknown for the body they take. The bodies a step needs now have one word for whatever the body is, any, and the build refuses unknown there: unknown stays for the body after a step. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
gnodet-bot
left a comment
There was a problem hiding this comment.
Following up on my earlier review — the documentation fixes from the previous SHA are all present and verified in the new commit.
This PR's new commits add @BodyTypes annotations to the core component and language endpoint classes, with matching JSON catalog regeneration. I've verified the following:
- Carrier semantics: no production code uses
Carrier.UNKNOWNon input sides (producerIn,consumerIn,expressionIn) orCarrier.ANYon output sides (producerOut,consumerOut,expressionOut). The oneUNKNOWN-on-input occurrence is inSomeEndpointWithBadBodyTypes.java— a negative test confirming the validator rejects it correctly. - Annotation ↔ JSON consistency: spot-checked
StreamEndpoint(complexbyOption/dependsOn/javaType),KnativeEndpoint,ControlBusEndpoint. Java annotations and generated JSON are in sync. dependsOnoption names: all validated against component option names (groupLines,readLine,body,batchSize,binding,consumerComponentName,headerName,failOnNullBody,source,useJsonBody,output). All exist.BodyType.javaJavadoc:UNKNOWNcarrier doc updated identically in bothtooling/spi-annotations(source) andcore/camel-api(generated copy). The added sentence correctly states the carrier constraint.- File pairing: all 20 components/languages have changes in both the component-local generated JSON and the catalog copy — no orphans.
LGTM.
This review was generated by an AI agent, Hermès on behalf of @gnodet.
…atalog-body-types-3 Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…AMEL-24961-catalog-body-types-ai
…atalog-body-types-ai # Conflicts: # docs/user-manual/modules/ROOT/pages/camel-jbang-validation.adoc # dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/main/java/org/apache/camel/dsl/yaml/validator/CatalogBodyTypes.java # dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
…AMEL-24961-catalog-body-types-storage
…atalog-body-types-storage # Conflicts: # dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
…ature/CAMEL-24961-catalog-body-types-messaging
…atalog-body-types-messaging # Conflicts: # dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
…feature/CAMEL-24961-catalog-body-types-core
…atalog-body-types-core # Conflicts: # dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
Stacked on #28275. This is the core group of the catalog body types (CAMEL-24961): the core components without body types so far, knative, and the core languages.
What the catalog says now
any: the first parameter of the method gets it, converted to its typeunknown: what the method returns, null too; unchanged after a void methodanyunchangedany; the expression as text for the language commandunchanged;text(or unchanged) for status and stats; the result of the expression for the language commandany: as the data format named in the path takes itunknownunknown: what the DataSet bean createsany, compared with the DataSetunchangedany, compared with the expected bodiesunchangedanyunknown: what the recipient ends with; a text when no subscription matchesanytext) for subscribe and update,truefor unsubscribe,textfor list and statisticspojo); a List with batchSizeany: the standard input, when it converts to a streampojo)bytesor no body; the parsed data field of a structured eventtext,bytes,streamorfilebytes, or nullany: as the language reads it; the script never comes from the bodyunknown: the result of the script;unchangedwith transform=false; astreamwith binary=trueunknown: as the endpoint in the registryanyunknownanyunchangedtext; a List with groupLines;byteswith readLine=falsetext,bytes,stream,fileor no bodyunchangedanyunknown: unchanged for InOnly or without a consumertext,bytes,stream,fileor a DOMunchangedtext,bytes,stream,fileor no body, as the standard inputbytes: the standard outputmethod)any: the first parameter of the methodunknown: what the method returns; null for a void methodunknown: the value as it isanyunknownany, as simpleunknown: text, a Long for file:size and file:modifiedtext,bytes,streamorfileiteratorof texttext,bytes,stream,fileor a DOMiteratorof XML textThe xpath and jq languages read the
sourceoption instead of the body when it is set, so their input side now depends on it, as for tokenize and xtokenize.The bodies a step needs have one word for whatever the body is:
any. The build now refusesunknownon those sides;unknownstays for the body after a step.Checked at runtime. Routes run with
camel runlogged the class of the body after each step:Docs fixed. These pages said things about the body that the code does not do:
appendNewLine);streamheader, notheader.allowTemplateFromHeader=true;body=file:data.json(it saidfile.data.json, which is the literal text).defaultHeadersis the headers, not the body.Measured.
Tests
TextBodyFlowTest.testTheBodyOfCoreComponents:Claude Code on behalf of davsclaus
🤖 Generated with Claude Code