You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by "ammachado (via GitHub)" <gi...@apache.org> on 2026/06/17 18:50:07 UTC
[PR] CAMEL-23535: camel-api - batches 16-20: enhance class-level Javadoc for REST, tooling, properties, exchange, and root-package types [camel]
ammachado opened a new pull request, #24098:
URL: https://github.com/apache/camel/pull/24098
# Description
Continues [CAMEL-23535](https://issues.apache.org/jira/browse/CAMEL-23535). Batches 1-15 were merged in #24060 (management, threading, observability SPIs).
This PR covers batches 16-20: **26 files** in `core/camel-api` received enhanced class-level Javadoc. The changes are documentation-only; no method signatures, annotations, or production code were altered.
**Batch 16 — REST SPIs** (`spi/`)
`RestConfiguration`, `RestProducerFactory`, `RestRegistry`, `RestBindingJaxbDataFormatFactory`, `RestApiConsumerFactory`
**Batch 17 — CLI and model-dumper SPIs** (`spi/`)
`CliConnector`, `CliConnectorFactory`, `ModelToXMLDumper`, `ModelToYAMLDumper`, `ModelToJavaDumper`, `RouteTopologyDumper`
**Batch 18 — Properties, language, and resolver SPIs** (`spi/`)
`PropertiesComponent`, `PropertiesFunction`, `Language`, `LanguageResolver`, `DataFormatResolver`, `RoutesBuilderLoader`, `HeadersMapFactory`
**Batch 19 — Exchange processing SPIs** (`spi/`)
`LifecycleStrategy`, `UnitOfWork`, `UnitOfWorkFactory`, `InflightRepository`
**Batch 20 — Root-package utility and exception types** (`org.apache.camel`)
`NoSuchBeanException`, `StaticService`, `SSLContextParametersAware`, `NoFactoryAvailableException`
Each file received:
- A clear opening sentence naming its role in the Camel system
- An architecture paragraph with `{@link}` references and explanation of callers/lifecycle
- At least one user-manual `<a href>` link where a matching page exists
- `@see` tags for closely related sibling types
- Preserved `@since` tags
A post-write Opus code review surfaced 9 factual errors (wrong module names, fabricated alternative implementations, non-existent URLs); all were corrected before this PR was opened.
# Target
- [x] I checked that the commit is targeting the correct branch (Camel 4 uses the `main` branch)
# Tracking
- [x] If this is a large change, bug fix, or code improvement, I checked there is a [JIRA issue](https://issues.apache.org/jira/browse/CAMEL-23535) filed for the change (usually before you start working on it).
# Apache Camel coding standards and style
- [x] I checked that each commit in the pull request has a meaningful subject line and body.
- [x] I have run `mvn clean install -DskipTests` locally from root folder and I have committed all auto-generated changes.
_Claude Code on behalf of Adriano Machado_
--
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] CAMEL-23535: camel-api - batches 16-20: enhance class-level Javadoc for REST, tooling, properties, exchange, and root-package types [camel]
Posted by "ammachado (via GitHub)" <gi...@apache.org>.
ammachado commented on PR #24098:
URL: https://github.com/apache/camel/pull/24098#issuecomment-4738445499
Thank you for the review! Both observations addressed in cdb71dc2e3cd:
1. **`UnitOfWorkFactory` contract strength**: Softened "must extend" back to "is highly recommended to extend" and "will break" to "may break", preserving the advisory (rather than normative) wording of the original while keeping the added explanatory context.
2. **`HeadersMapFactory` dropped `@see`**: Re-added `@see org.apache.camel.impl.engine.DefaultHeadersMapFactory` alongside `@see Message` so implementors retain the pointer to the concrete default implementation.
_Claude Code on behalf of Adriano Machado_
--
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] CAMEL-23535: camel-api - batches 16-20: enhance class-level Javadoc for REST, tooling, properties, exchange, and root-package types [camel]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #24098:
URL: https://github.com/apache/camel/pull/24098#issuecomment-4738410324
<!-- ci-tested-modules -->
:test_tube: **CI tested the following changed modules:**
- `core/camel-api`
> :information_source: Dependent modules were not tested because the total number of affected modules exceeded the threshold (50). Use the `test-dependents` label to force testing all dependents.
---
:gear: [View full build and test results](https://github.com/apache/camel/actions/runs/27712127148)
--
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] CAMEL-23535: camel-api - batches 16-20: enhance class-level Javadoc for REST, tooling, properties, exchange, and root-package types [camel]
Posted by "davsclaus (via GitHub)" <gi...@apache.org>.
davsclaus merged PR #24098:
URL: https://github.com/apache/camel/pull/24098
--
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] CAMEL-23535: camel-api - batches 16-20: enhance class-level Javadoc for REST, tooling, properties, exchange, and root-package types [camel]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #24098:
URL: https://github.com/apache/camel/pull/24098#issuecomment-4738283608
:star2: Thank you for your contribution to the Apache Camel project! :star2:
:robot: CI automation will test this PR automatically.
:camel: Apache Camel Committers, please review the following items:
* First-time contributors **require MANUAL approval** for the GitHub Actions to run
* You can use the command `/component-test (camel-)component-name1 (camel-)component-name2..` to request a test from the test bot although they are normally detected and executed by CI.
* You can label PRs using `skip-tests` and `test-dependents` to fine-tune the checks executed by this PR.
* Build and test logs are available in the summary page. **Only** [Apache Camel committers](https://camel.apache.org/community/team/#committers) have access to the summary.
:warning: Be careful when sharing logs. Review their contents before sharing them publicly.
--
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