coveooss / spring-boot-parameter-store-integration

A tiny library used to integrate AWS Parameter Store in Spring Boot's powerful property injection.
MIT License
45 stars 19 forks source link

Support for Configuration Metadata #158

Open raphael-namo opened 2 years ago

raphael-namo commented 2 years ago

In IntelliJ IDEA displayed warning message like below:

ScreenShot 2022-06-09 14 54 26 7

If this library supports the Configuration Metadata, then disappear these warnings and it may help the person for using IDE by supported hint.

I think it seems to be below:

{
  "properties": [
    {
      "name": "awsParameterStorePropertySource.enabled",
      "type": "java.lang.Boolean",
      "description": "Using Spring Boot Parameter Store Integration",
      "sourceType": "com.coveo.configuration.parameterstore.ParameterStorePropertySourceConfigurationProperties"
    },
    {
      "name": "awsParameterStorePropertySource.haltBoot",
      "type": "java.lang.Boolean",
      "description": "If you want to halt the boot when a property isn't found in any of the specified regions just set to true.",
      "sourceType": "com.coveo.configuration.parameterstore.ParameterStoreSource"
    },
    {
      "name": "awsParameterStorePropertySource.multiRegion.ssmClient.regions",
      "type": "java.lang.String",
      "description": "a comma-separated string of regions from which you want to retrieve parameters. Example: us-east-1,us-east-2",
      "sourceType": "com.coveo.configuration.parameterstore.ParameterStoreSource"
    }
  ]
}

The location be under WEB-INF directory like this (example from Openapi)

ScreenShot 2022-06-09 14 57 47 8

spring-boot-parameter-store-integration:

ScreenShot 2022-06-09 14 57 58 5
fredboutin commented 2 years ago

Interesting! If you have time to do a PR I can take a look and merge it. Otherwise we might get to this at some point.