Improve error metadata for Actuator

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json

@@ -1,4 +1,5 @@
-{"properties": [
+{
+  "properties": [
     {
       "name": "management.endpoint.configprops.keys-to-sanitize",
       "defaultValue": [
@@ -21,16 +22,6 @@
         "vcap_services"
       ]
     },
-  {
-    "name": "management.endpoint.trace.filter.enabled",
-    "type": "java.lang.Boolean",
-    "description": "Whether to enable the trace servlet filter.",
-    "defaultValue": true,
-    "deprecation": {
-      "replacement": "management.trace.filter.enabled",
-      "level": "error"
-    }
-  },
     {
       "name": "management.endpoints.enabled-by-default",
       "type": "java.lang.Boolean",
@@ -223,7 +214,15 @@
       "type": "java.lang.Boolean",
       "description": "Mark if the endpoint exposes sensitive information.",
       "deprecation": {
-      "reason": "The \"actuator\" endpoint is no longer available.",
+        "reason": "The \"actuator\" endpoint is no longer available.","level": "error"
+      }
+    },
+    {
+      "name": "endpoints.auditevents.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Enable the endpoint.",
+      "deprecation": {
+        "replacement": "management.endpoint.auditevents.enabled",
         "level": "error"
       }
     },
@@ -232,7 +231,7 @@
       "type": "java.lang.String",
       "description": "Endpoint URL path.",
       "deprecation": {
-      "reason": "Endpoint path is no longer customizable.",
+        "replacement": "management.endpoints.web. path -mapping.auditevents",
         "level": "error"
       }
     },
@@ -250,7 +249,15 @@
       "type": "java.lang.String",
       "description": "Endpoint identifier. With HTTP monitoring the identifier of the endpoint is mapped\n to a URL (e.g. 'foo' is mapped to '/foo').",
       "deprecation": {
-      "reason": "Endpoint identifier is no longer customizable.",
+        "reason": "Endpoint identifier is no longer customizable.","level": "error"
+      }
+    },
+    {
+      "name": "endpoints.autoconfig.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Enable the endpoint.",
+      "deprecation": {
+        "replacement": "management.endpoint.conditions.enabled",
         "level": "error"
       }
     },
@@ -259,7 +266,7 @@
       "type": "java.lang.String",
       "description": "Endpoint URL path.",
       "deprecation": {
-      "reason": "Endpoint path is no longer customizable.",
+        "replacement": "management.endpoints.web. path -mapping.conditions",
         "level": "error"
       }
     },
@@ -272,6 +279,15 @@
         "level": "error"
       }
     },
+    {
+      "name": "endpoints.beans.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Enable the endpoint.",
+      "deprecation": {
+        "replacement": "management.endpoint.beans.enabled",
+        "level": "error"
+      }
+    },
     {
       "name": "endpoints.beans.id",
       "type": "java.lang.String",
@@ -286,7 +302,7 @@
       "type": "java.lang.String",
       "description": "Endpoint URL path.",
       "deprecation": {
-      "reason": "Endpoint path is no longer customizable.",
+        "replacement": "management.endpoints.web. path -mapping.beans",
         "level": "error"
       }
     },
@@ -299,6 +315,15 @@
         "level": "error"
       }
     },
+    {
+      "name": "endpoints.configprops.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Enable the endpoint.",
+      "deprecation": {
+        "replacement": "management.endpoint.configprops.enabled",
+        "level": "error"
+      }
+    },
     {
       "name": "endpoints.configprops.id",
       "type": "java.lang.String",
@@ -308,12 +333,21 @@
         "level": "error"
       }
     },
+    {
+      "name": "endpoints.configprops.keys-to-sanitize",
+      "type": "java.lang.String[]",
+      "description": "Keys that should be sanitized. Keys can be simple strings that the property ends with or regex expressions.",
+      "deprecation": {
+        "replacement": "management.endpoint.configprops.keys-to-sanitize",
+        "level": "error"
+      }
+    },
     {
       "name": "endpoints.configprops.path",
       "type": "java.lang.String",
       "description": "Endpoint URL path.",
       "deprecation": {
-      "reason": "Endpoint path is no longer customizable.",
+        "replacement": "management.endpoints.web. path -mapping.configprops",
         "level": "error"
       }
     },
@@ -441,7 +475,7 @@
       "type": "java.lang.String",
       "description": "Endpoint URL path.",
       "deprecation": {
-      "reason": "Endpoint path is no longer customizable.",
+        "replacement": "management.endpoints.web. path -mapping.dump",
         "level": "error"
       }
     },
@@ -464,6 +498,15 @@
         "level": "error"
       }
     },
+    {
+      "name": "endpoints.env.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Enable the endpoint.",
+      "deprecation": {
+        "replacement": "management.endpoint.env.enabled",
+        "level": "error"
+      }
+    },
     {
       "name": "endpoints.env.id",
       "type": "java.lang.String",
@@ -473,12 +516,21 @@
         "level": "error"
       }
     },
+    {
+      "name": "endpoints.env.keys-to-sanitize",
+      "type": "java.lang.String[]",
+      "description": "Keys that should be sanitized. Keys can be simple strings that the property ends with or regex expressions.",
+      "deprecation": {
+        "replacement": "management.endpoint.env.keys-to-sanitize",
+        "level": "error"
+      }
+    },
     {
       "name": "endpoints.env.path",
       "type": "java.lang.String",
       "description": "Endpoint URL path.",
       "deprecation": {
-      "reason": "Endpoint path is no longer customizable.",
+        "replacement": "management.endpoints.web. path -mapping.env",
         "level": "error"
       }
     },
@@ -491,12 +543,29 @@
         "level": "error"
       }
     },
+    {
+      "name": "endpoints.flyway.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Enable the endpoint.",
+      "deprecation": {
+        "replacement": "management.endpoint.flyway.enabled",
+        "level": "error"
+      }
+    },
     {
       "name": "endpoints.flyway.id",
       "type": "java.lang.String",
       "description": "Endpoint identifier. With HTTP monitoring the identifier of the endpoint is mapped\n to a URL (e.g. 'foo' is mapped to '/foo').",
       "deprecation": {
-      "reason": "Endpoint identifier is no longer customizable.",
+        "reason": "Endpoint identifier is no longer customizable.","level": "error"
+      }
+    },
+    {
+      "name": "endpoints.flyway.path",
+      "type": "java.lang.String",
+      "description": "Endpoint URL path.",
+      "deprecation": {
+        "replacement": "management.endpoints.web.path-mapping.flyway",
         "level": "error"
       }
     },
@@ -509,6 +578,15 @@
         "level": "error"
       }
     },
+    {
+      "name": "endpoints.health.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Enable the endpoint.",
+      "deprecation": {
+        "replacement": "management.endpoint.health.enabled",
+        "level": "error"
+      }
+    },
     {
       "name": "endpoints.health.id",
       "type": "java.lang.String",
@@ -532,7 +610,7 @@
       "type": "java.lang.String",
       "description": "Endpoint URL path.",
       "deprecation": {
-      "reason": "Endpoint path is no longer customizable.",
+        "replacement": "management.endpoints.web. path -mapping.health",
         "level": "error"
       }
     },
@@ -551,7 +629,15 @@
       "description": "Time to live for cached result, in milliseconds.",
       "defaultValue": 1000,
       "deprecation": {
-      "replacement": "management.endpoint.health.cache.time-to-live",
+        "replacement": "management.endpoint.health.cache.time-to-live","level": "error"
+      }
+    },
+    {
+      "name": "endpoints.heapdump.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Enable the endpoint.",
+      "deprecation": {
+        "replacement": "management.endpoint.heapdump.enabled",
         "level": "error"
       }
     },
@@ -560,7 +646,7 @@
       "type": "java.lang.String",
       "description": "Endpoint URL path.",
       "deprecation": {
-      "reason": "Endpoint path is no longer customizable.",
+        "replacement": "management.endpoints.web. path -mapping.heapdump",
         "level": "error"
       }
     },
@@ -579,7 +665,15 @@
       "description": "Whether to enable hypermedia support for endpoints.",
       "defaultValue": false,
       "deprecation": {
-      "reason": "Hypermedia support in the Actuator is no longer available.",
+        "reason": "Hypermedia support in the Actuator is no longer available.","level": "error"
+      }
+    },
+    {
+      "name": "endpoints.info.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Enable the endpoint.",
+      "deprecation": {
+        "replacement": "management.endpoint.info.enabled",
         "level": "error"
       }
     },
@@ -597,7 +691,7 @@
       "type": "java.lang.String",
       "description": "Endpoint URL path.",
       "deprecation": {
-      "reason": "Endpoint path is no longer customizable.",
+        "replacement": "management.endpoints.web. path -mapping.info",
         "level": "error"
       }
     },
@@ -675,6 +769,15 @@
         "level": "error"
       }
     },
+    {
+      "name": "endpoints.liquibase.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Enable the endpoint.",
+      "deprecation": {
+        "replacement": "management.endpoint.liquibase.enabled",
+        "level": "error"
+      }
+    },
     {
       "name": "endpoints.liquibase.id",
       "type": "java.lang.String",
@@ -684,6 +787,15 @@
         "level": "error"
       }
     },
+    {
+      "name": "endpoints.liquibase.path",
+      "type": "java.lang.String",
+      "description": "Endpoint URL path.",
+      "deprecation": {
+        "replacement": "management.endpoints.web.path-mapping.liquibase",
+        "level": "error"
+      }
+    },
     {
       "name": "endpoints.liquibase.sensitive",
       "type": "java.lang.Boolean",
@@ -693,12 +805,30 @@
         "level": "error"
       }
     },
+    {
+      "name": "endpoints.logfile.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Enable the endpoint.",
+      "deprecation": {
+        "replacement": "management.endpoint.logfile.enabled",
+        "level": "error"
+      }
+    },
+    {
+      "name": "endpoints.logfile.external-file",
+      "type": "java.io.File",
+      "description": "External Logfile to be accessed. Can be used if the logfile is written by output\n redirect and not by the logging-system itself.",
+      "deprecation": {
+        "replacement": "management.endpoint.logfile.external-file",
+        "level": "error"
+      }
+    },
     {
       "name": "endpoints.logfile.path",
       "type": "java.lang.String",
       "description": "Endpoint URL path.",
       "deprecation": {
-      "reason": "Endpoint path is no longer customizable.",
+        "replacement": "management.endpoints.web. path -mapping.logfile",
         "level": "error"
       }
     },
@@ -711,6 +841,15 @@
         "level": "error"
       }
     },
+    {
+      "name": "endpoints.loggers.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Enable the endpoint.",
+      "deprecation": {
+        "replacement": "management.endpoint.loggers.enabled",
+        "level": "error"
+      }
+    },
     {
       "name": "endpoints.loggers.id",
       "type": "java.lang.String",
@@ -725,7 +864,7 @@
       "type": "java.lang.String",
       "description": "Endpoint URL path.",
       "deprecation": {
-      "reason": "Endpoint path is no longer customizable.",
+        "replacement": "management.endpoints.web. path -mapping.loggers",
         "level": "error"
       }
     },
@@ -738,6 +877,15 @@
         "level": "error"
       }
     },
+    {
+      "name": "endpoints.mappings.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Enable the endpoint.",
+      "deprecation": {
+        "replacement": "management.endpoint.mappings.enabled",
+        "level": "error"
+      }
+    },
     {
       "name": "endpoints.mappings.id",
       "type": "java.lang.String",
@@ -752,7 +900,7 @@
       "type": "java.lang.String",
       "description": "Endpoint URL path.",
       "deprecation": {
-      "reason": "Endpoint path is no longer customizable.",
+        "replacement": "management.endpoints.web. path -mapping.mappings",
         "level": "error"
       }
     },
@@ -773,6 +921,15 @@
         "level": "error"
       }
     },
+    {
+      "name": "endpoints.metrics.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Enable the endpoint.",
+      "deprecation": {
+        "replacement": "management.endpoint.metrics.enabled",
+        "level": "error"
+      }
+    },
     {
       "name": "endpoints.metrics.filter.enabled",
       "type": "java.lang.Boolean",
@@ -805,7 +962,7 @@
       "type": "java.lang.String",
       "description": "Endpoint URL path.",
       "deprecation": {
-      "reason": "Endpoint path is no longer customizable.",
+        "replacement": "management.endpoints.web. path -mapping.metrics",
         "level": "error"
       }
     },
@@ -827,6 +984,15 @@
         "level": "error"
       }
     },
+    {
+      "name": "endpoints.shutdown.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Enable the endpoint.",
+      "deprecation": {
+        "replacement": "management.endpoint.shutdown.enabled",
+        "level": "error"
+      }
+    },
     {
       "name": "endpoints.shutdown.id",
       "type": "java.lang.String",
@@ -841,7 +1007,7 @@
       "type": "java.lang.String",
       "description": "Endpoint URL path.",
       "deprecation": {
-      "reason": "Endpoint path is no longer customizable.",
+        "replacement": "management.endpoints.web. path -mapping.shutdown",
         "level": "error"
       }
     },
@@ -854,6 +1020,25 @@
         "level": "error"
       }
     },
+    {
+      "name": "endpoints.trace.filter.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Enable the trace servlet filter.",
+      "defaultValue": true,
+      "deprecation": {
+        "replacement": "management.trace.filter.enabled",
+        "level": "error"
+      }
+    },
+    {
+      "name": "endpoints.trace.enabled",
+      "type": "java.lang.Boolean",
+      "description": "Enable the endpoint.",
+      "deprecation": {
+        "replacement": "management.endpoint.trace.enabled",
+        "level": "error"
+      }
+    },
     {
       "name": "endpoints.trace.id",
       "type": "java.lang.String",
@@ -868,7 +1053,7 @@
       "type": "java.lang.String",
       "description": "Endpoint URL path.",
       "deprecation": {
-      "reason": "Endpoint path is no longer customizable.",
+        "replacement": "management.endpoints.web. path -mapping.trace",
         "level": "error"
       }
     },
@@ -890,6 +1075,44 @@
         "level": "error"
       }
     },
+    {
+      "name": "management.add-application-context-header",
+      "type": "java.lang.Boolean",
+      "description": "Add the \"X-Application-Context\" HTTP header in each response.",
+      "defaultValue": true,
+      "deprecation": {
+        "replacement": "management.server.add-application-context-header",
+        "level": "error"
+      }
+    },
+    {
+      "name": "management.address",
+      "type": "java.net.InetAddress",
+      "description": "Network address that the management endpoints should bind to.",
+      "deprecation": {
+        "replacement": "management.server.address",
+        "level": "error"
+      }
+    },
+    {
+      "name": "management.context-path",
+      "type": "java.lang.String",
+      "description": "Management endpoint context-path.",
+      "defaultValue": "",
+      "deprecation": {
+        "replacement": "management.server.context-path",
+        "level": "error"
+      }
+    },
+    {
+      "name": "management.port",
+      "type": "java.lang.Integer",
+      "description": "Management endpoint HTTP port. Use the same port as the application by default.",
+      "deprecation": {
+        "replacement": "management.server.port",
+        "level": "error"
+      }
+    },
     {
       "name": "management.security.enabled",
       "type": "java.lang.Boolean",
@@ -1102,7 +1325,125 @@
       "description": "Telnet port.",
       "defaultValue": 5000,
       "deprecation": {
-      "reason": "CRaSH support is no longer available.",
+        "reason": "CRaSH support is no longer available.","level": "error"
+      }
+    },
+    {
+      "name": "management.ssl.ciphers",
+      "type": "java.lang.String[]",
+      "deprecation": {
+        "replacement": "management.server.ssl.ciphers",
+        "level": "error"
+      }
+    },
+    {
+      "name": "management.ssl.client-auth",
+      "deprecation": {
+        "replacement": "management.server.ssl.client-auth",
+        "level": "error"
+      }
+    },
+    {
+      "name": "management.ssl.enabled",
+      "type": "java.lang.Boolean",
+      "deprecation": {
+        "replacement": "management.server.ssl.enabled",
+        "level": "error"
+      }
+    },
+    {
+      "name": "management.ssl.enabled-protocols",
+      "type": "java.lang.String[]",
+      "deprecation": {
+        "replacement": "management.server.ssl.enabled-protocols",
+        "level": "error"
+      }
+    },
+    {
+      "name": "management.ssl.key-alias",
+      "type": "java.lang.String",
+      "deprecation": {
+        "replacement": "management.server.ssl.key-alias",
+        "level": "error"
+      }
+    },
+    {
+      "name": "management.ssl.key-password",
+      "type": "java.lang.String",
+      "deprecation": {
+        "replacement": "management.server.ssl.key-password",
+        "level": "error"
+      }
+    },
+    {
+      "name": "management.ssl.key-store",
+      "type": "java.lang.String",
+      "deprecation": {
+        "replacement": "management.server.ssl.key-store",
+        "level": "error"
+      }
+    },
+    {
+      "name": "management.ssl.key-store-password",
+      "type": "java.lang.String",
+      "deprecation": {
+        "replacement": "management.server.ssl.key-store-password",
+        "level": "error"
+      }
+    },
+    {
+      "name": "management.ssl.key-store-provider",
+      "type": "java.lang.String",
+      "deprecation": {
+        "replacement": "management.server.ssl.key-store-provider",
+        "level": "error"
+      }
+    },
+    {
+      "name": "management.ssl.key-store-type",
+      "type": "java.lang.String",
+      "deprecation": {
+        "replacement": "management.server.ssl.key-store-type",
+        "level": "error"
+      }
+    },
+    {
+      "name": "management.ssl.protocol",
+      "type": "java.lang.String",
+      "deprecation": {
+        "replacement": "management.server.ssl.protocol",
+        "level": "error"
+      }
+    },
+    {
+      "name": "management.ssl.trust-store",
+      "type": "java.lang.String",
+      "deprecation": {
+        "replacement": "management.server.ssl.trust-store",
+        "level": "error"
+      }
+    },
+    {
+      "name": "management.ssl.trust-store-password",
+      "type": "java.lang.String",
+      "deprecation": {
+        "replacement": "management.server.ssl.trust-store-password",
+        "level": "error"
+      }
+    },
+    {
+      "name": "management.ssl.trust-store-provider",
+      "type": "java.lang.String",
+      "deprecation": {
+        "replacement": "management.server.ssl.trust-store-provider",
+        "level": "error"
+      }
+    },
+    {
+      "name": "management.ssl.trust-store-type",
+      "type": "java.lang.String",
+      "deprecation": {
+        "replacement": "management.server.ssl.trust-store-type",
         "level": "error"
       }
     },
@@ -1210,7 +1551,8 @@
         "level": "error"
       }
     }
-],"hints": [
+  ],
+  "hints": [
     {
       "name": "management.endpoints.web.path-mapping.keys",
       "values": [
@@ -1345,5 +1687,6 @@
         }
       ]
     }
-]}
+  ]
+}