You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by "oscerd (via GitHub)" <gi...@apache.org> on 2026/09/14 12:59:09 UTC
[PR] chore: make the Kamelet descriptions I added one liners [camel-kamelets]
oscerd opened a new pull request, #3029:
URL: https://github.com/apache/camel-kamelets/pull/3029
The catalog settled on a **one line** `spec.definition.description` in #2589, with anything longer living in `docs/modules/ROOT/partials/<name>-description.adoc`. The Kamelets I added or touched recently did not follow that. This moves them across.
## What changed
Nine Kamelets, all of them mine:
```
aws-bedrock-agent-sink ceph-event-based-source couchbase-source
replace-field-action salesforce-pubsub-source sap-netweaver-sink
smpp-sink smpp-source snmp-source
```
Each keeps its first sentence as the description:
```diff
- description: |-
- Poll SNMP (Simple Network Management Protocol) capable devices, or receive SNMP traps.
-
- Set type to POLL or GET_NEXT to query the OIDs listed in the oids property on a schedule, or to TRAP to listen for traps sent to this host and port.
-
- SNMP v1 and v2c authenticate with a plaintext community string. Prefer snmpVersion 3 with authentication and privacy where the device supports it.
+ description: Poll SNMP (Simple Network Management Protocol) capable devices, or receive SNMP traps.
```
and gains a partial holding the rest.
## The partials are organised, not transcribed
Rather than dumping the removed paragraphs, each partial is broken into sections the way the existing ones are — `snmp-source` gets *Modes* and *Security*, `couchbase-source` gets *Query Modes* and *Writing the Statement*, `salesforce-pubsub-source` gets *Which API*, *Deserialization* and *Runtime Dependency*.
**Nothing is lost.** The things worth keeping all survive into the partials, and several read better with room to breathe:
- the Couchbase `META().id AS __id` requirement, including the example statement — that one is a silent-no-op trap, so it now gets a code block instead of a sentence
- the SNMP clear-text community string warning and the pointer to v3
- the Salesforce `protobuf-java` `NoClassDefFoundError`, now with the actual stack line
- the SAP NetWeaver note that the command is pinned and overwrites any inbound header
- the `replace-field-action` top-level-only limitation, with the `{"message":{"Hola":"mundo"}}` example from #462
## Verification
`script/validator` reports no errors, `script/generator` produces no further doc changes, and `mvn clean install` passes with tests from the repository root.
No template or property changes — descriptions and new documentation files only, so behaviour is untouched.
The `library/` mirrors are left to the regen bot, as with other Kamelet modifications.
---
_Claude Code on behalf of Andrea Cosentino_
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] chore: make the Kamelet descriptions I added one liners [camel-kamelets]
Posted by "oscerd (via GitHub)" <gi...@apache.org>.
oscerd merged PR #3029:
URL: https://github.com/apache/camel-kamelets/pull/3029
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@camel.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org