fix: make 'configPath' optional (#343)

* fix: make 'configPath' optional * chore: self mutation Signed-off-by: github-actions <github-actions@github.com> * sync tasks.json * chore: self mutation Signed-off-by: github-actions <github-actions@github.com> --------- Signed-off-by: github-actions <github-actions@github.com> Co-authored-by: github-actions <github-actions@github.com>
awslabs · Jun 9, 2023 · 689c795 · 689c795
1 parent f5247d7
commit 689c795
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 11 deletions.
diff --git a/API.md b/API.md
diff --git a/src/config/configurator.ts b/src/config/configurator.ts
@@ -189,17 +189,35 @@ class ConfiguratorAspect implements cdk.IAspect {
 }
 
 export interface GetEnvConfigProps {
-  readonly configPath: string;
+  /**
+   * Relative path to config file. Defaults to './ddk.json'
+   */
+  readonly configPath?: string;
+  /**
+   * Environment identifier
+   */
   readonly environmentId: string;
 }
 
 export interface GetTagsProps {
+  /**
+   * Relative path to config file. Defaults to './ddk.json'
+   */
   readonly configPath: string;
+  /**
+   * Environment identifier
+   */
   readonly environmentId?: string;
 }
 
 export interface GetEnvironmentProps {
+  /**
+   * Relative path to config file. Defaults to './ddk.json'
+   */
   readonly configPath: string;
+  /**
+   * Environment identifier.
+   */
   readonly environmentId?: string;
 }