Clean up README files, fix typos and broken links

This commit is contained in:
Artem Bilan
2024-03-20 15:57:35 -04:00
parent 1611f9475c
commit 77112eb8a1
49 changed files with 330 additions and 346 deletions

View File

@@ -1,8 +1,8 @@
# Aggregator Function
= Aggregator Function
This module provides an aggregation function that can be reused and composed in other applications.
## Beans for injection
== Beans for injection
You can import the `AggregatorFunctionConfiguration` in a Spring Boot application and then inject the following bean.
@@ -12,16 +12,16 @@ You can use `aggregatorFunction` as a qualifier when injecting.
Once injected, you can use the `apply` method of the `Function` to invoke it and get the result.
## Configuration Options
== Configuration Options
For more information on the various options available, please see link:src/main/java/org/springframework/cloud/fn/aggregator/AggregatorFunctionProperties.java[AggregatorFunctionProperties.java]
A `ComponentCustomizer<AggregatorFactoryBean>` bean can be added in the target project to provide any custom options for the `AggregatorFactoryBean` configuration used by the `aggregatorFunction` definition.
## Tests
== Tests
See this link:src/test/java/org/springframework/cloud/fn/aggregator/AggregatorFunctionApplicationTests.java[test suite] for examples of how this function is used.
See this link:src/test/java/org/springframework/cloud/fn/aggregator/AbstractAggregatorFunctionTests.java[test suite] for examples of how this function is used.
## Other usage
== Other usage
See this link:../../../applications/processor/aggregator-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application.
See this https://github.com/spring-cloud/stream-applications/blob/main/applications/processor/aggregator-processor/README.adoc[README] where this function is used to create a Spring Cloud Stream application.