From 3904948d3ec47e59f158c2afbc4af11b96cd8daf Mon Sep 17 00:00:00 2001 From: Chris Bono Date: Wed, 13 Nov 2024 23:26:48 -0600 Subject: [PATCH] Add description to additional metadata fields This commit adds a description for the observations and reflection enabled properties. Signed-off-by: Chris Bono --- .../antora/modules/ROOT/partials/_configprops.adoc | 5 +++-- .../additional-spring-configuration-metadata.json | 11 ++++++++--- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/spring-grpc-docs/src/main/antora/modules/ROOT/partials/_configprops.adoc b/spring-grpc-docs/src/main/antora/modules/ROOT/partials/_configprops.adoc index 1c7f5a4..14b3463 100644 --- a/spring-grpc-docs/src/main/antora/modules/ROOT/partials/_configprops.adoc +++ b/spring-grpc-docs/src/main/antora/modules/ROOT/partials/_configprops.adoc @@ -27,12 +27,13 @@ |spring.grpc.server.keep-alive.timeout | `+++20s+++` | Maximum time to wait for read activity after sending a keep alive ping. If sender does not receive an acknowledgment within this time, it will close the connection (default 20s). |spring.grpc.server.max-inbound-message-size | `+++4194304B+++` | Maximum message size allowed to be received by the server (default 4MiB). |spring.grpc.server.max-inbound-metadata-size | `+++8192B+++` | Maximum metadata size allowed to be received by the server (default 8KiB). +|spring.grpc.server.observations.enabled | `+++true+++` | Whether to enable Observations on the server. |spring.grpc.server.port | `+++9090+++` | Server port to listen on. When the value is 0, a random available port is selected. The default is 9090. -|spring.grpc.server.reflection.enabled | `+++true+++` | +|spring.grpc.server.reflection.enabled | `+++true+++` | Whether to enable Reflection on the gRPC server. |spring.grpc.server.shutdown-grace-period | `+++30s+++` | Maximum time to wait for the server to gracefully shutdown. When the value is negative, the server waits forever. When the value is 0, the server will force shutdown immediately. The default is 30 seconds. |spring.grpc.server.ssl.bundle | | SSL bundle name. |spring.grpc.server.ssl.client-auth | | Client authentication mode. |spring.grpc.server.ssl.enabled | | Whether to enable SSL support. Enabled automatically if "bundle" is provided unless specified otherwise. |spring.grpc.server.ssl.secure | `+++true+++` | Flag to indicate that client authentication is secure (i.e. certificates are checked). Do not set this to false in production. -|=== \ No newline at end of file +|=== diff --git a/spring-grpc-spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/spring-grpc-spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json index ab35a37..156af1b 100644 --- a/spring-grpc-spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json +++ b/spring-grpc-spring-boot-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -7,11 +7,16 @@ }, { "name": "spring.grpc.server.reflection.enabled", - "defaultValue": "true" + "type": "java.lang.Boolean", + "description": "Whether to enable Reflection on the gRPC server.", + "defaultValue": true }, { - "name": "spring.grpc.server.observation.enabled", - "defaultValue": "true" + "name": "spring.grpc.server.observations.enabled", + "type": "java.lang.Boolean", + "description": "Whether to enable Observations on the server.", + "defaultValue": true + } ] }