From cd907dd81a37556f4fa7d1d84bdf9a3950761583 Mon Sep 17 00:00:00 2001 From: JayaShakthi97 Date: Mon, 2 Dec 2024 10:14:05 +0530 Subject: [PATCH] Add doc comments --- .../edit/setup-guide/remote/download-step.tsx | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/features/admin.remote-userstores.v1/components/edit/setup-guide/remote/download-step.tsx b/features/admin.remote-userstores.v1/components/edit/setup-guide/remote/download-step.tsx index 731121726ff..19d6d3f3c4c 100644 --- a/features/admin.remote-userstores.v1/components/edit/setup-guide/remote/download-step.tsx +++ b/features/admin.remote-userstores.v1/components/edit/setup-guide/remote/download-step.tsx @@ -38,8 +38,14 @@ import useGetCheckSum from "../../../../api/use-get-sha-file"; * Interface for download URLs prop of the DownloadAgentStep component. */ export interface AgentDownloadInfoInterface { + /** + * The download URL of the user store agent. + */ file: string; - checkSum?: string; + /** + * The checksum file URL of the user store agent file. + */ + checkSum: string; } /** @@ -57,6 +63,9 @@ interface DownloadAgentStepPropsInterface extends IdentifiableComponentInterface } } +/** + * User store agent available operating systems. + */ enum OperatingSystem { Linux = "Linux", LinuxArm = "Linux (ARM)",