From ebd0cdaf8f1053dacf3594787f6985582351475f Mon Sep 17 00:00:00 2001 From: TANGUY Antoine Date: Wed, 5 Apr 2023 13:28:19 +0200 Subject: [PATCH] chore: refactor declaration file Signed-off-by: TANGUY Antoine --- docs/integrations/github/discovery.md | 2 +- plugins/catalog-backend-module-github/config.d.ts | 12 ++++++++++-- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/integrations/github/discovery.md b/docs/integrations/github/discovery.md index e5acc60646..7d637838b4 100644 --- a/docs/integrations/github/discovery.md +++ b/docs/integrations/github/discovery.md @@ -202,7 +202,7 @@ This provider supports multiple organizations via unique provider IDs. An array of strings used to filter out results based on their associated GitHub topics. If configured, all repositories _except_ those with one (or more) topics(s) present in the exclusion filter will be ingested. - **`visibility`** _(optional)_: - An array of strings used to filter results based on their visibility. Available options are `private`, `internal`, `private`. If configured (non empty), only repositories with visibility present in the filter will be ingested + An array of strings used to filter results based on their visibility. Available options are `private`, `internal`, `public`. If configured (non empty), only repositories with visibility present in the filter will be ingested - **`host`** _(optional)_: The hostname of your GitHub Enterprise instance. It must match a host defined in [integrations.github](locations.md). - **`organization`**: diff --git a/plugins/catalog-backend-module-github/config.d.ts b/plugins/catalog-backend-module-github/config.d.ts index 37852223c1..5a699e745f 100644 --- a/plugins/catalog-backend-module-github/config.d.ts +++ b/plugins/catalog-backend-module-github/config.d.ts @@ -84,11 +84,11 @@ export interface Config { */ repository?: string; /** - * (Optional) GitHub topic-based filters. + * (Optional) Allow Forks to be evaluated. */ allowForks?: boolean; /** - * (Optional) Allow Forks to be evaluated. + * (Optional) GitHub topic-based filters. */ topic?: { /** @@ -108,6 +108,10 @@ export interface Config { */ exclude?: string[]; }; + /** + * (Optional) GitHub repository visibility filter. + */ + visibility?: Array<'private' | 'internal' | 'public'>; }; /** * (Optional) TaskScheduleDefinition for the refresh. @@ -169,6 +173,10 @@ export interface Config { */ exclude?: string[]; }; + /** + * (Optional) GitHub repository visibility filter. + */ + visibility?: Array<'private' | 'internal' | 'public'>; }; /** * (Optional) TaskScheduleDefinition for the refresh.