Skip to content

chore: align catalog credential descriptors and fix metadata inconsistencies#2879

Merged
oscerd merged 1 commit into
apache:mainfrom
oscerd:quick-fix/catalog-credential-consistency
Jun 25, 2026
Merged

chore: align catalog credential descriptors and fix metadata inconsistencies#2879
oscerd merged 1 commit into
apache:mainfrom
oscerd:quick-fix/catalog-credential-consistency

Conversation

@oscerd

@oscerd oscerd commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Small, verified consistency fixes to the Kamelet catalog metadata. No runtime behaviour changes — every edit is JSON-schema metadata (credential descriptors / format / property descriptions / casing / quoting).

Changes

Credential metadata

  • JMS pooled Artemis broker password (jms-pooled-apache-artemis-sink, -source): added format: password. These were the only two password: properties in the catalog carrying the urn:camel:group:credentials descriptor without format: password; every other password property (including jms-ibm-mq) pairs both.
  • SSH private-key passphrase (scp-sink, sftp-sink, sftp-source): added format: password + urn:camel:group:credentials to privateKeyPassphrase, matching the sibling password field in the same Kamelets. A key passphrase is a secret and should be masked / vault-bindable like one.
  • Remove deprecated descriptor (crypto-encrypt-action, crypto-decrypt-action, spring-rabbitmq-sink, -source): dropped the deprecated urn:alm:descriptor:com.tectonic.ui:password x-descriptor. These properties already carry the canonical urn:camel:group:credentials, so the deprecated entry was redundant — removing it also avoids a duplicate descriptor (thanks @apupier for spotting the dup in an earlier revision of this PR).

Documentation / metadata fixes

  • scp-sink: two property descriptions referred to the "SFTP endpoint" (copy-paste from the sftp Kamelets) → corrected to "SCP endpoint".
  • aws-redshift-source / aws-redshift-sink: normalised "RedShift" → "Redshift" (the AWS product name) in descriptions.
  • aws-s3-event-based-source: quoted the camel.apache.org/provider value ("Apache Software Foundation") — the only Kamelet of 250 leaving it unquoted.

Deliberately NOT changed

oauth2ClientId in http-secured-sink/-source carries format: password. This is consistent with an established catalog convention — OAuth/cloud client IDs are masked across the catalog (azure-storage-blob ×8, google-calendar/mail/sheets, azure-datalake ×2, salesforce ×6, ms-exchange). Left as-is.

Verification

  • script/validator (re-armed in ci: validate all Kamelets (remove early break in listKamelets) #2878) over all 250 Kamelets: no errors.
  • A catalog-wide check confirms no property has duplicate x-descriptors across the 250 Kamelets.
  • All edited files parse as valid YAML.
  • ./mvnw clean install -DskipTests (full reactor): passes.
  • Per repo convention, only kamelets/ is committed; the library/camel-kamelets resource mirror is regenerated by the post-merge regen bot (cf. the "Regen for commit …" commits).

AI-generated by Claude Code on behalf of Andrea Cosentino (@oscerd).

…tencies

Metadata-only consistency fixes across the Kamelet catalog (no runtime
behaviour change):

- jms-pooled-apache-artemis-sink/-source: add missing "format: password"
  to the broker password (the only two password properties carrying the
  credentials descriptor without format: password).
- scp-sink, sftp-sink, sftp-source: mark privateKeyPassphrase as a secret
  (format: password + urn:camel:group:credentials), matching the sibling
  password property in the same Kamelets.
- crypto-encrypt-action, crypto-decrypt-action, spring-rabbitmq-sink/-source:
  migrate the deprecated urn:alm:descriptor:com.tectonic.ui:password
  descriptor to urn:camel:group:credentials.
- scp-sink: fix two property descriptions that referenced the "SFTP
  endpoint" (copy-paste) -> "SCP endpoint".
- aws-redshift-source/-sink: normalise "RedShift" -> "Redshift".
- aws-s3-event-based-source: quote the provider annotation value.

Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
@oscerd oscerd requested review from Croway and davsclaus June 25, 2026 08:13
@oscerd oscerd merged commit 8b4fcb9 into apache:main Jun 25, 2026
4 of 5 checks passed
oscerd added a commit that referenced this pull request Jun 25, 2026
#2879 converted the deprecated urn:alm:descriptor:com.tectonic.ui:password
x-descriptor to urn:camel:group:credentials on four properties that already
carried the canonical urn:camel:group:credentials descriptor, leaving a
duplicate entry (spotted by @apupier on #2881). Remove the redundant line so
each property lists the credentials descriptor once.

Affected: crypto-encrypt-action, crypto-decrypt-action, spring-rabbitmq-sink,
spring-rabbitmq-source. A catalog-wide check confirms no property has
duplicate x-descriptors.

Co-authored-by: Claude Opus 4.8 (1M context) <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants