Link to function catalog docs for config props (#526)
Prior to this commit, each app documented its available config props in its README.adoc. Now that the functions have been moved to the function catalog, these inline docs are replaced w/ a link to the respective function catalog docs. See #524
This commit is contained in:
Chris Bono
@@ -15,102 +15,8 @@ Otherwise(including a deserialization error), the input payload is left as is -
|
||||
|
||||
== Options
|
||||
|
||||
//tag::configuration-properties[]
|
||||
Properties grouped by prefix:
|
||||
|
||||
|
||||
=== aggregator
|
||||
|
||||
$$aggregation$$:: $$SpEL expression for aggregation strategy. Default is collection of payloads.$$ *($$Expression$$, default: `$$<none>$$`)*
|
||||
$$correlation$$:: $$SpEL expression for correlation key. Default to correlationId header.$$ *($$Expression$$, default: `$$<none>$$`)*
|
||||
$$group-timeout$$:: $$SpEL expression for timeout to expiring uncompleted groups.$$ *($$Expression$$, default: `$$<none>$$`)*
|
||||
$$message-store-entity$$:: $$Persistence message store entity: table prefix in RDBMS, collection name in MongoDb, etc.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$message-store-type$$:: $$Message store type.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$release$$:: $$SpEL expression for release strategy. Default is based on the sequenceSize header.$$ *($$Expression$$, default: `$$<none>$$`)*
|
||||
|
||||
=== spring.data.mongodb
|
||||
|
||||
$$additional-hosts$$:: $$Additional server hosts. Cannot be set with URI or if 'host' is not specified. Additional hosts will use the default mongo port of 27017. If you want to use a different port you can use the "host:port" syntax.$$ *($$List<String>$$, default: `$$<none>$$`)*
|
||||
$$authentication-database$$:: $$Authentication database name.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$auto-index-creation$$:: $$Whether to enable auto-index creation.$$ *($$Boolean$$, default: `$$<none>$$`)*
|
||||
$$database$$:: $$Database name. Overrides database in URI.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$field-naming-strategy$$:: $$Fully qualified name of the FieldNamingStrategy to use.$$ *($$Class<?>$$, default: `$$<none>$$`)*
|
||||
$$host$$:: $$Mongo server host. Cannot be set with URI.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$password$$:: $$Login password of the mongo server. Cannot be set with URI.$$ *($$Character[]$$, default: `$$<none>$$`)*
|
||||
$$port$$:: $$Mongo server port. Cannot be set with URI.$$ *($$Integer$$, default: `$$<none>$$`)*
|
||||
$$replica-set-name$$:: $$Required replica set name for the cluster. Cannot be set with URI.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$uri$$:: $$Mongo database URI. Overrides host, port, username, and password.$$ *($$String$$, default: `$$mongodb://localhost/test$$`)*
|
||||
$$username$$:: $$Login user of the mongo server. Cannot be set with URI.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$uuid-representation$$:: $$Representation to use when converting a UUID to a BSON binary value.$$ *($$UuidRepresentation$$, default: `$$java-legacy$$`, possible values: `UNSPECIFIED`,`STANDARD`,`C_SHARP_LEGACY`,`JAVA_LEGACY`,`PYTHON_LEGACY`)*
|
||||
|
||||
=== spring.data.mongodb.gridfs
|
||||
|
||||
$$bucket$$:: $$GridFS bucket name.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$database$$:: $$GridFS database name.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
|
||||
=== spring.data.mongodb.ssl
|
||||
|
||||
$$bundle$$:: $$SSL bundle name.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$enabled$$:: $$Whether to enable SSL support. Enabled automatically if "bundle" is provided unless specified otherwise.$$ *($$Boolean$$, default: `$$<none>$$`)*
|
||||
|
||||
=== spring.data.redis
|
||||
|
||||
$$client-name$$:: $$Client name to be set on connections with CLIENT SETNAME.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$client-type$$:: $$Type of client to use. By default, auto-detected according to the classpath.$$ *($$ClientType$$, default: `$$<none>$$`, possible values: `LETTUCE`,`JEDIS`)*
|
||||
$$connect-timeout$$:: $$Connection timeout.$$ *($$Duration$$, default: `$$<none>$$`)*
|
||||
$$database$$:: $$Database index used by the connection factory.$$ *($$Integer$$, default: `$$0$$`)*
|
||||
$$host$$:: $$Redis server host.$$ *($$String$$, default: `$$localhost$$`)*
|
||||
$$password$$:: $$Login password of the redis server.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$port$$:: $$Redis server port.$$ *($$Integer$$, default: `$$6379$$`)*
|
||||
$$timeout$$:: $$Read timeout.$$ *($$Duration$$, default: `$$<none>$$`)*
|
||||
$$url$$:: $$Connection URL. Overrides host, port, username, and password. Example: redis://user:password@example.com:6379$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$username$$:: $$Login username of the redis server.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
|
||||
=== spring.data.redis.cluster
|
||||
|
||||
$$max-redirects$$:: $$Maximum number of redirects to follow when executing commands across the cluster.$$ *($$Integer$$, default: `$$<none>$$`)*
|
||||
$$nodes$$:: $$Comma-separated list of "host:port" pairs to bootstrap from. This represents an "initial" list of cluster nodes and is required to have at least one entry.$$ *($$List<String>$$, default: `$$<none>$$`)*
|
||||
|
||||
=== spring.data.redis.jedis.pool
|
||||
|
||||
$$enabled$$:: $$Whether to enable the pool. Enabled automatically if "commons-pool2" is available. With Jedis, pooling is implicitly enabled in sentinel mode and this setting only applies to single node setup.$$ *($$Boolean$$, default: `$$<none>$$`)*
|
||||
$$max-active$$:: $$Maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit.$$ *($$Integer$$, default: `$$8$$`)*
|
||||
$$max-idle$$:: $$Maximum number of "idle" connections in the pool. Use a negative value to indicate an unlimited number of idle connections.$$ *($$Integer$$, default: `$$8$$`)*
|
||||
$$max-wait$$:: $$Maximum amount of time a connection allocation should block before throwing an exception when the pool is exhausted. Use a negative value to block indefinitely.$$ *($$Duration$$, default: `$$-1ms$$`)*
|
||||
$$min-idle$$:: $$Target for the minimum number of idle connections to maintain in the pool. This setting only has an effect if both it and time between eviction runs are positive.$$ *($$Integer$$, default: `$$0$$`)*
|
||||
$$time-between-eviction-runs$$:: $$Time between runs of the idle object evictor thread. When positive, the idle object evictor thread starts, otherwise no idle object eviction is performed.$$ *($$Duration$$, default: `$$<none>$$`)*
|
||||
|
||||
=== spring.data.redis.lettuce.pool
|
||||
|
||||
$$enabled$$:: $$Whether to enable the pool. Enabled automatically if "commons-pool2" is available. With Jedis, pooling is implicitly enabled in sentinel mode and this setting only applies to single node setup.$$ *($$Boolean$$, default: `$$<none>$$`)*
|
||||
$$max-active$$:: $$Maximum number of connections that can be allocated by the pool at a given time. Use a negative value for no limit.$$ *($$Integer$$, default: `$$8$$`)*
|
||||
$$max-idle$$:: $$Maximum number of "idle" connections in the pool. Use a negative value to indicate an unlimited number of idle connections.$$ *($$Integer$$, default: `$$8$$`)*
|
||||
$$max-wait$$:: $$Maximum amount of time a connection allocation should block before throwing an exception when the pool is exhausted. Use a negative value to block indefinitely.$$ *($$Duration$$, default: `$$-1ms$$`)*
|
||||
$$min-idle$$:: $$Target for the minimum number of idle connections to maintain in the pool. This setting only has an effect if both it and time between eviction runs are positive.$$ *($$Integer$$, default: `$$0$$`)*
|
||||
$$time-between-eviction-runs$$:: $$Time between runs of the idle object evictor thread. When positive, the idle object evictor thread starts, otherwise no idle object eviction is performed.$$ *($$Duration$$, default: `$$<none>$$`)*
|
||||
|
||||
=== spring.data.redis.lettuce
|
||||
|
||||
$$shutdown-timeout$$:: $$Shutdown timeout.$$ *($$Duration$$, default: `$$100ms$$`)*
|
||||
|
||||
=== spring.data.redis.sentinel
|
||||
|
||||
$$master$$:: $$Name of the Redis server.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$nodes$$:: $$Comma-separated list of "host:port" pairs.$$ *($$List<String>$$, default: `$$<none>$$`)*
|
||||
$$password$$:: $$Password for authenticating with sentinel(s).$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$username$$:: $$Login username for authenticating with sentinel(s).$$ *($$String$$, default: `$$<none>$$`)*
|
||||
|
||||
=== spring.data.redis.ssl
|
||||
|
||||
$$bundle$$:: $$SSL bundle name.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$enabled$$:: $$Whether to enable SSL support. Enabled automatically if "bundle" is provided unless specified otherwise.$$ *($$Boolean$$, default: `$$<none>$$`)*
|
||||
|
||||
=== spring.datasource
|
||||
|
||||
$$driver-class-name$$:: $$Fully qualified name of the JDBC driver. Auto-detected based on the URL by default.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$password$$:: $$Login password of the database.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$url$$:: $$JDBC URL of the database.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$username$$:: $$Login username of the database.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
//tag::configuration-properties[link-to-catalog=true]
|
||||
https://github.com/spring-cloud/spring-functions-catalog/tree/main/function/spring-aggregator-function#configuration-options[See Spring Functions Catalog for configuration options].
|
||||
//end::configuration-properties[]
|
||||
|
||||
//end::ref-doc[]
|
||||
|
||||
@@ -15,8 +15,8 @@ If the incoming type is `byte[]` and the content type is set to `text/plain` or
|
||||
|
||||
== Options
|
||||
|
||||
//tag::configuration-properties[]
|
||||
$$filter.function.expression$$:: $$Boolean SpEL expression to apply against request message to filter.$$ *($$Expression$$, default: `$$<none>$$`)*
|
||||
//tag::configuration-properties[link-to-catalog=true]
|
||||
https://github.com/spring-cloud/spring-functions-catalog/tree/main/function/spring-filter-function#configuration-options[See Spring Functions Catalog for configuration options].
|
||||
//end::configuration-properties[]
|
||||
|
||||
//end::ref-doc[]
|
||||
|
||||
@@ -10,9 +10,8 @@ For example `--headers='foo=payload.someProperty \n bar=payload.otherProperty'`.
|
||||
|
||||
The **$$header-enricher$$** $$processor$$ has the following options:
|
||||
|
||||
//tag::configuration-properties[]
|
||||
$$header.enricher.headers$$:: $$\n separated properties representing headers in which values are SpEL expressions, e.g foo='bar' \n baz=payload.baz.$$ *($$Properties$$, default: `$$<none>$$`)*
|
||||
$$header.enricher.overwrite$$:: $$set to true to overwrite any existing message headers.$$ *($$Boolean$$, default: `$$false$$`)*
|
||||
//tag::configuration-properties[link-to-catalog=true]
|
||||
https://github.com/spring-cloud/spring-functions-catalog/tree/main/function/spring-header-enricher-function#configuration-options[See Spring Functions Catalog for configuration options].
|
||||
//end::configuration-properties[]
|
||||
|
||||
//end::ref-doc[]
|
||||
|
||||
@@ -9,9 +9,8 @@ The names of headers to remove are presented as a comma or space separated list.
|
||||
|
||||
The **$$header-filter$$** $$processor$$ has the following options:
|
||||
|
||||
//tag::configuration-properties[]
|
||||
$$header.filter.delete-all$$:: $$Indicates the need to remove all headers.$$ *($$Boolean$$, default: `$$false$$`)*
|
||||
$$header.filter.remove$$:: $$Remove all headers named. A comma, space separated list of header names. The names may contain patterns.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
//tag::configuration-properties[link-to-catalog=true]
|
||||
https://github.com/spring-cloud/spring-functions-catalog/tree/main/function/spring-header-filter-function#configuration-options[See Spring Functions Catalog for configuration options].
|
||||
//end::configuration-properties[]
|
||||
|
||||
//end::ref-doc[]
|
||||
|
||||
@@ -40,26 +40,8 @@ Note that ResponseEntity (referenced by the expression `#root`) cannot be deseri
|
||||
|
||||
The **$$http-request$$** $$processor$$ has the following options:
|
||||
|
||||
== Options
|
||||
|
||||
//tag::configuration-properties[]
|
||||
Properties grouped by prefix:
|
||||
|
||||
|
||||
=== http.request
|
||||
|
||||
$$body-expression$$:: $$A SpEL expression to derive the request body from the incoming message.$$ *($$Expression$$, default: `$$<none>$$`)*
|
||||
$$expected-response-type$$:: $$The type used to interpret the response.$$ *($$Class<?>$$, default: `$$<none>$$`)*
|
||||
$$headers-expression$$:: $$A SpEL expression used to derive the http headers map to use.$$ *($$Expression$$, default: `$$<none>$$`)*
|
||||
$$http-method-expression$$:: $$A SpEL expression to derive the request method from the incoming message.$$ *($$Expression$$, default: `$$<none>$$`)*
|
||||
$$reply-expression$$:: $$A SpEL expression used to compute the final result, applied against the whole http {@link ResponseEntity}.$$ *($$Expression$$, default: `$$<none>$$`)*
|
||||
$$timeout$$:: $$Request timeout in milliseconds.$$ *($$Long$$, default: `$$30000$$`)*
|
||||
$$url-expression$$:: $$A SpEL expression against incoming message to determine the URL to use.$$ *($$Expression$$, default: `$$<none>$$`)*
|
||||
|
||||
=== spring.codec
|
||||
|
||||
$$log-request-details$$:: $$Whether to log form data at DEBUG level, and headers at TRACE level.$$ *($$Boolean$$, default: `$$false$$`)*
|
||||
$$max-in-memory-size$$:: $$Limit on the number of bytes that can be buffered whenever the input stream needs to be aggregated. This applies only to the auto-configured WebFlux server and WebClient instances. By default this is not set, in which case individual codec defaults apply. Most codecs are limited to 256K by default.$$ *($$DataSize$$, default: `$$<none>$$`)*
|
||||
//tag::configuration-properties[link-to-catalog=true]
|
||||
https://github.com/spring-cloud/spring-functions-catalog/tree/main/function/spring-http-request-function#configuration-options[See Spring Functions Catalog for configuration options].
|
||||
//end::configuration-properties[]
|
||||
|
||||
//end::ref-doc[]
|
||||
|
||||
@@ -16,13 +16,8 @@ If the incoming type is `byte[]` and the content type is set to `text/plain` or
|
||||
|
||||
== Options
|
||||
|
||||
//tag::configuration-properties[]
|
||||
$$splitter.apply-sequence$$:: $$Add correlation/sequence information in headers to facilitate later aggregation.$$ *($$Boolean$$, default: `$$true$$`)*
|
||||
$$splitter.charset$$:: $$The charset to use when converting bytes in text-based files to String.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$splitter.delimiters$$:: $$When expression is null, delimiters to use when tokenizing {@link String} payloads.$$ *($$String$$, default: `$$<none>$$`)*
|
||||
$$splitter.expression$$:: $$A SpEL expression for splitting payloads.$$ *($$Expression$$, default: `$$<none>$$`)*
|
||||
$$splitter.file-markers$$:: $$Set to true or false to use a {@code FileSplitter} (to split text-based files by line) that includes (or not) beginning/end of file markers.$$ *($$Boolean$$, default: `$$<none>$$`)*
|
||||
$$splitter.markers-json$$:: $$When 'fileMarkers == true', specify if they should be produced as FileSplitter.FileMarker objects or JSON.$$ *($$Boolean$$, default: `$$true$$`)*
|
||||
//tag::configuration-properties[link-to-catalog=true]
|
||||
https://github.com/spring-cloud/spring-functions-catalog/tree/main/function/spring-splitter-function#configuration-options[See Spring Functions Catalog for configuration options].
|
||||
//end::configuration-properties[]
|
||||
|
||||
//end::ref-doc[]
|
||||
|
||||
@@ -20,8 +20,6 @@ The incoming message can contain any type of payload.
|
||||
|
||||
== Options
|
||||
|
||||
//tag::configuration-properties[]
|
||||
$$spel.function.expression$$:: $$A SpEL expression to apply.$$ *($$Expression$$, default: `$$<none>$$`)*
|
||||
//end::configuration-properties[]
|
||||
https://github.com/spring-cloud/spring-functions-catalog/tree/main/function/spring-spel-function#configuration-options[See function catalog for configuration options]
|
||||
|
||||
//end::ref-doc[]
|
||||
|
||||
@@ -25,20 +25,6 @@ Response is an array of `locations` that encode the location's WOEID and some ot
|
||||
|
||||
== Options
|
||||
|
||||
//tag::configuration-properties[]
|
||||
Properties grouped by prefix:
|
||||
|
||||
|
||||
=== twitter.trend.closest
|
||||
|
||||
$$lat$$:: $$If provided with a long parameter the available trend locations will be sorted by distance, nearest to the furthest, to the co-ordinate pair. The valid ranges for longitude is -180.0 to +180.0 (West is negative, East is positive) inclusive.$$ *($$Expression$$, default: `$$<none>$$`)*
|
||||
$$lon$$:: $$If provided with a lat parameter the available trend locations will be sorted by distance, nearest to the furthest, to the co-ordinate pair. The valid ranges for longitude is -180.0 to +180.0 (West is negative, East is positive) inclusive.$$ *($$Expression$$, default: `$$<none>$$`)*
|
||||
|
||||
=== twitter.trend
|
||||
|
||||
$$location-id$$:: $$The Yahoo! Where On Earth ID of the location to return trending information for. Global information is available by using 1 as the WOEID.$$ *($$Expression$$, default: `$$<none>$$`)*
|
||||
$$trend-query-type$$:: $$<documentation missing>$$ *($$TrendQueryType$$, default: `$$<none>$$`, possible values: `trend`,`trendLocation`)*
|
||||
//end::configuration-properties[]
|
||||
https://github.com/spring-cloud/spring-functions-catalog/tree/main/function/spring-twitter-function#12-configuration-options[See function catalog for configuration options]
|
||||
|
||||
//end::ref-doc[]
|
||||
|
||||
|
||||
Reference in New Issue
Block a user