From 29bd6feca67f279c6b95f5d02280be27062aad10 Mon Sep 17 00:00:00 2001
From: Arjun Porwal <porwalarjun95@gmail.com>
Date: Fri, 10 Jan 2025 15:31:47 +0530
Subject: [PATCH] feat: added missing types description

---
 packages/apps-config/src/endpoints/types.ts | 33 +++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/packages/apps-config/src/endpoints/types.ts b/packages/apps-config/src/endpoints/types.ts
index 280f3a2b648c..ad82ad25afe8 100644
--- a/packages/apps-config/src/endpoints/types.ts
+++ b/packages/apps-config/src/endpoints/types.ts
@@ -8,14 +8,35 @@ import type { Option } from '../settings/types.js';
 
 interface BaseOption {
   dnslink?: string;
+  /**
+   * Genesis hash for chain
+   */
   genesisHash?: HexString;
+  /**
+   * Homepage Url
+   */
   homepage?: string;
+  /**
+   * Parachain Id of chain
+   */
   paraId?: number;
+  /**
+   * Summary about chain
+   */
   summary?: string;
   teleport?: number[];
   ui: {
+    /**
+     * Color for chain
+     */
     color?: string;
+    /**
+     * Identicon type i.e. polkadot, beachball, ethereum etc
+     */
     identityIcon?: IconTheme;
+    /**
+     * Logo component for chain
+     */
     logo?: string;
   }
 }
@@ -28,10 +49,22 @@ export interface EndpointOption extends BaseOption {
    * Declares whether the given endpoint is the People chain used to store identity information.
    */
   isPeople?: boolean;
+  /**
+   * Checks whether one of the given provider is reachable or not. If set to true, it hides the chain from explorer.
+   */
   isUnreachable?: boolean;
+  /**
+   * Declares list of all linked chains. However, It is applicable for relay chains only.
+   */
   linked?: EndpointOption[];
   info?: string;
+  /**
+   * Declares the list of all RPC providers
+   */
   providers: Record<string, `${'wss://' | 'light://substrate-connect/'}${string}`>;
+  /**
+   * Declares chain name
+   */
   text: string;
   /**
    * Declares whether or not the endpoint is a relay chain.