Skip to content

CAMEL-24961: Catalog body types for eleven more AWS components - #28314

Merged
davsclaus merged 70 commits into
mainfrom
feature/CAMEL-24961-catalog-body-types-aws-2
Oct 24, 2026
Merged

davsclaus merged 70 commits into
mainfrom
feature/CAMEL-24961-catalog-body-types-aws-2

Conversation

@davsclaus

@davsclaus davsclaus commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Stacked on #28309. This group covers eleven more AWS components of the catalog body types (CAMEL-24961): aws2-ddb, aws2-ddbstream, aws2-cw, aws2-ec2, aws2-eventbridge, aws2-lambda, aws2-sts, aws2-ses, aws-secrets-manager, aws2-kms and aws2-iam.

What the catalog says now

Component Consumer Producer input Producer output
aws2-ddb any: the item, the key and the statement are headers unchanged for every operation: the result is in headers
aws2-ddbstream the Record of the AWS SDK, one per change
aws2-cw any: putMetricData sends a MetricDatum or a List of them, else the metric comes from headers unchanged for putMetricData, the default; the response of the SDK for listMetrics, describeAlarms and describeAlarmsForMetric
aws2-ec2 any: the inputs are headers; the request of the SDK with pojoRequest=true the response of the SDK per operation; unchanged for rebootInstances
aws2-eventbridge the event as JSON text, the envelope of EventBridge any; text, bytes, a stream or a file for putEvent, the detail of the event the response of the SDK
aws2-lambda any; text, bytes, a stream or a file for invokeFunction, the default; bytes, a stream, a file or no body for createFunction and updateFunction, the zip the response of the SDK; the payload of the response as text for invokeFunction
aws2-sts any: the inputs are headers; the request of the SDK with pojoRequest=true the response of the SDK
aws2-ses text, bytes, a stream or a file: the text of the mail unchanged
aws-secrets-manager any; text, bytes, a stream or a file for createSecret, updateSecret and putSecretValue, the value of the secret the secret as text for getSecret, or no body for a binary secret; a List of the values for batchGetSecret; the response of the SDK for the others
aws2-kms any: the inputs are headers; the request of the SDK with pojoRequest=true the response of the SDK
aws2-iam any: the inputs are headers; the request of the SDK with pojoRequest=true the response of the SDK

Checked at runtime. Routes run with camel run against the AWS emulator of camel infra run aws logged the class of the body after each step, with text, bytes, streams, files, Maps, Lists, POJOs and no body:

  • aws2-ddb: every operation tried keeps the body, a Map and a List too, and puts its result in headers; the DescribeTable headers are a TableStatus enum and an Instant.
  • aws2-ddbstream: a table with a stream gives one Record per INSERT and MODIFY; Jackson cannot marshal a Record.
  • aws2-cw: putMetricData keeps the body; a List of anything but MetricDatum fails with a ClassCastException.
  • aws2-ec2: every operation gives its response, except rebootInstances, which keeps the body; with pojoRequest=true another body than the request fails.
  • aws2-eventbridge:
    • putEvent sends the body as the detail: a plain text detail and a Map (its toString()) are rejected as MalformedDetail, and the exchange does not fail;
    • the consumer gives the envelope of each event as JSON text.
  • aws2-lambda:
    • createFunction takes the zip as a file, bytes or a stream, or no body with the zip file header; a String is a broken zip, and a Map fails with a NullPointerException;
    • invokeFunction gives the payload of the response as text, also when the function fails, and fails without a body.
  • aws2-sts: each operation gives its response; assumeRole was run with a role aws2-iam made.
  • aws2-ses: every body is sent as the text of the mail, a Map as its toString(), and the body is kept; a jakarta.mail Message is sent as a raw mail.
  • aws-secrets-manager:
    • text, bytes, a stream and a file are stored as their text, and a Map as its toString();
    • getSecret gives the secret as text, and no body for a binary secret unless binaryPayload=true;
    • batchGetSecret gives a List of the values.
  • aws2-kms and aws2-iam: each operation gives its response; the 29 IAM operations of users, groups, roles, policies, instance profiles and access keys were run.

Choices

  • pojoRequest is named only where the input side is any. Every AWS option is a component option as well, so a side that names an option is not known for a step that leaves it out: on aws-secrets-manager, aws2-lambda and aws2-eventbridge it would turn off the check of the text body of createSecret, invokeFunction and putEvent.
  • Where every operation gives the response of the SDK (aws2-sts, aws2-kms, aws2-iam, aws2-eventbridge), the output side is one pojo, and the description names the response class.
  • aws2-lambda (31 operations) and aws2-iam (33) say what most operations do, with an option value only for the operations that read or give another body (second commit, after the review). One option value per operation would take their camel_catalog_doc answers over the cap of 18 000 characters.

Bugs found and filed, one per component:

  • CAMEL-26030, aws2-ddb: the catalog gives wrong types for the TableStatus, CreationDate, ConsumedCapacity, LastEvaluatedKey and BatchResponse headers; CamelAwsDdbNextToken is not in the catalog; the table name and the capacities DescribeTable sets are read by the next aws2-ddb step.
  • CAMEL-26031, aws2-cw: a List body of anything but MetricDatum fails with a bare ClassCastException; a Date in CamelAwsCwMetricTimestamp, as the catalog says, is ignored; an upper-case unit is sent as "null".
  • CAMEL-26032, aws2-ec2: no operation fails with a NullPointerException; the docs' instance type t2.micro fails to convert; a text CamelAwsEC2InstancesIds header is dropped, so stopInstances stops nothing.
  • CAMEL-26033, aws2-lambda: invokeFunction without a body, and createFunction with a Map, fail with a NullPointerException; the body wins over the zip file header.
  • CAMEL-26034, aws2-eventbridge: a rejected event does not fail the exchange; no body fails with a bare RuntimeException; the consumer integration test is disabled, but the consumer works against the emulator.
  • CAMEL-26035, aws2-ses: the Java example of the docs uses a class that does not exist, and sets the To header to a List, which is sent as "[to@example.com]".
  • CAMEL-26036 (Major), aws-secrets-manager: with binaryPayload=true the binary stored is the Base64 text of the value; getSecret with binaryPayload=true of a string secret fails with a NullPointerException; batchGetSecret gives null for a binary secret and drops the errors; no operation fails with a NullPointerException.
  • CAMEL-26037, aws2-iam: the CamelAwsIAMAccessKeyStatus values must be Active or Inactive, but the header doc says active and inactive.
  • CAMEL-26038, aws2-sts: the docs name one of the three operations and a client option that does not exist, and the assumeRole integration test is disabled, though assumeRole works against the emulator.
  • CAMEL-26039 (Major), camel-jbang (CLI validator): a YAML route with the short form - to: aws-secrets-manager:sm?... is reported for setting a header of that component ("is not set by timer"); the long form to: {uri: ...} is not.

Docs fixed

  • aws2-eventbridge: the putEvent examples send a JSON object as the detail, and the text says what the body is before and after the call.

Measured.

Tests

  • TextBodyFlowTest.testTheBodyOfAwsServices:
    • reported: a Map sent to aws2-ses, to createSecret, to invokeFunction, to createFunction and to putEvent; a field read after getSecret, after invokeFunction and after the eventbridge consumer;
    • not reported: a field read after aws2-ddb (the body is kept) and after the ddbstream consumer (a POJO), and a Map sent to aws2-iam.
  • These pass:
    • the 292 tests of camel-yaml-dsl-validator;
    • the 265 validator and catalog doc tests of camel-jbang-core;
    • the builds of camel-yaml-dsl-maven-plugin and camel-yaml-dsl-deserializers.
  • The answers of camel_catalog_doc stay under 18 000 characters: aws2-iam, the largest, is 17 875.

Claude Code on behalf of davsclaus

🤖 Generated with Claude Code

davsclaus and others added 30 commits October 21, 2026 13:58
…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>
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-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>
…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>
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>
… and infinispan

The body types of jira, github2, pqc, dns, caffeine-cache,
caffeine-loadcache, infinispan and infinispan-embedded, the most used
components in the route files that had none yet. pqc, dns, caffeine and
infinispan-embedded were checked at runtime with camel run; jira and
github2 were read from the code.

The validator now takes an option a body depends on as unknown also when
another option of the step names a body, such as xslt with output=bytes
and a resultHandlerFactory, as the BodyType javadoc says.

The component docs of jira, github2, dns and infinispan 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>
davsclaus and others added 3 commits October 23, 2026 11:42
The description of the CamelSmppEncoding header changed with the body
types of smpp, and the endpoint DSL holds a copy of it.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Signed-off-by: Claus Ibsen <claus.ibsen@gmail.com>
…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
…atalog-body-types-storage

# Conflicts:
#	dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
…atalog-body-types-messaging

# Conflicts:
#	dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
…atalog-body-types-core

# Conflicts:
#	dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
…atalog-body-types-transformation

# Conflicts:
#	dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
…atalog-body-types-dataformats-text

# Conflicts:
#	dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
…' into feature/CAMEL-24961-catalog-body-types-dataformats-binary
…atalog-body-types-dataformats-binary

# Conflicts:
#	dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
…atalog-body-types-most-used-2

# Conflicts:
#	dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
@davsclaus
davsclaus changed the base branch from feature/CAMEL-24961-catalog-body-types-most-used-2 to main October 24, 2026 08:02
…atalog-body-types-aws-2

# Conflicts:
#	dsl/camel-yaml-dsl/camel-yaml-dsl-validator/src/test/java/org/apache/camel/dsl/yaml/validator/TextBodyFlowTest.java
@davsclaus davsclaus added the enhancement New feature or request label Oct 24, 2026
@davsclaus
davsclaus merged commit 21b6915 into main Oct 24, 2026
2 of 7 checks passed
@davsclaus
davsclaus deleted the feature/CAMEL-24961-catalog-body-types-aws-2 branch October 24, 2026 08:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants