feat/chore: add ports_acked to deployment metadata + add comments to …

…metadata fields
hopinc · Dec 11, 2023 · 5b5251a · 5b5251a
1 parent 2d5ecb3
commit 5b5251a
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/src/rest/types/ignite.ts b/src/rest/types/ignite.ts
@@ -322,10 +322,26 @@ export interface BuildSettings {
  * @public
  */
 export interface DeploymentMetadata {
+	/**
+	 * Ports that have been found by container's runtime.
+	 */
 	container_port_mappings: Record<Id<'container'>, string[]>;
+	/**
+	 * Whether a user has ignored the onboarding process.
+	 */
 	ignored_boarding?: boolean;
+	/**
+	 * Whether the deployment was created from a preset.
+	 */
 	created_from_preset?: string;
+	/**
+	 * Whether a gateway has been created for the deployment.
+	 */
 	created_first_gateway?: boolean;
+	/**
+	 * Whether a user has acknowledged the ports that have been found by container's runtime.
+	 */
+	ports_acked?: string[];
 }
 
 /**