diff --git a/src/plugins/application_config/README.md b/src/plugins/application_config/README.md index cad28722d63e..442bd3312353 100755 --- a/src/plugins/application_config/README.md +++ b/src/plugins/application_config/README.md @@ -61,13 +61,13 @@ Let's call this plugin `MyConfigurationClientPlugin`. First, this plugin will need to implement a class `MyConfigurationClient` based on interface `ConfigurationClient` defined in the `types.ts` under directory `src/plugins/application_config/server/types.ts`. Below are the functions inside the interface. ``` - getConfig(): Promise>; + getConfig(options?: ConfigurationClientOptions): Promise>; - getEntityConfig(entity: string): Promise; + getEntityConfig(entity: string, options?: ConfigurationClientOptions): Promise; - updateEntityConfig(entity: string, newValue: string): Promise; + updateEntityConfig(entity: string, newValue: string, options?: ConfigurationClientOptions): Promise; - deleteEntityConfig(entity: string): Promise; + deleteEntityConfig(entity: string, options?: ConfigurationClientOptions): Promise; ``` Second, this plugin needs to declare `applicationConfig` as its dependency by adding it to `requiredPlugins` in its own `opensearch_dashboards.json`.