diff --git a/lib/changelog.types.ts b/lib/changelog.types.ts index e20fe88..45c6778 100644 --- a/lib/changelog.types.ts +++ b/lib/changelog.types.ts @@ -1,21 +1,25 @@ /** * Configuration to retrieve changelogs from UpdateHive. - * - * @param connection - * API_KEY: API_KEY to access UpdateHive public REST API. - * url: Override the default URL to UpdateHive API. - * - * @param changelogs - * product: Product ID to retrieve changelogs for. - * onlyLast: Retrieve only the last changelog. */ export type UpdateHiveConfig = { connection: { + /** + * API_KEY to access UpdateHive public REST API. + */ API_KEY: string; + /** + * Override the default URL to UpdateHive API. + */ url?: string; }; changelogs: { + /** + * Product ID to retrieve changelogs for. + */ product: string; + /** + * Retrieve only the last changelog. + */ onlyLast?: boolean; }; };