From a8ba32421770740252cafaf2cb8464c5a04672c0 Mon Sep 17 00:00:00 2001 From: Benjamin Janssens Date: Tue, 15 Oct 2024 15:14:41 +0200 Subject: [PATCH] style: reorder config property Signed-off-by: Benjamin Janssens --- docs/integrations/bitbucketCloud/discovery.md | 6 +++--- .../config.d.ts | 16 ++++++++-------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/integrations/bitbucketCloud/discovery.md b/docs/integrations/bitbucketCloud/discovery.md index c533f61a2a..d623a5d47c 100644 --- a/docs/integrations/bitbucketCloud/discovery.md +++ b/docs/integrations/bitbucketCloud/discovery.md @@ -146,13 +146,13 @@ catalog: filters: # optional projectKey: '^apis-.*$' # optional; RegExp repoSlug: '^service-.*$' # optional; RegExp + level: workspace # default value schedule: # same options as in SchedulerServiceTaskScheduleDefinition # supports cron, ISO duration, "human duration" as used in code frequency: { minutes: 30 } # supports ISO duration, "human duration" as used in code timeout: { minutes: 3 } workspace: workspace-name - level: workspace # default value ``` > **Note:** It is possible but certainly not recommended to skip the provider ID level. @@ -169,6 +169,8 @@ catalog: Regular expression used to filter results based on the project key. - **`repoSlug`** _(optional)_: Regular expression used to filter results based on the repo slug. +- **`level`** _(optional)_: + `'workspace'` (default) or `'project'`. At what level discovery should take place, affecting Bitbucket Cloud API limits. - **`schedule`**: - **`frequency`**: How often you want the task to run. The system does its best to avoid overlapping invocations. @@ -181,7 +183,5 @@ catalog: - **`workspace`**: Name of your organization account/workspace. If you want to add multiple workspaces, you need to add one provider config each. -- **`level`** _(optional)_: - `'workspace'` (default) or `'project'`. At what level discovery should take place, affecting Bitbucket Cloud API limits. > **Note:** By default, discovery will take place at the `workspace` level. While being the most efficient in terms of API calls to Bitbucket Cloud, discovery at the workspace level is limited to 900 repositories per workspace. If your workspace consists of more than 900 repositories, you should switch to discovery at the `project` level, shifting the limit to 900 repositories per project. diff --git a/plugins/catalog-backend-module-bitbucket-cloud/config.d.ts b/plugins/catalog-backend-module-bitbucket-cloud/config.d.ts index a56d3cd87a..d216efbd8c 100644 --- a/plugins/catalog-backend-module-bitbucket-cloud/config.d.ts +++ b/plugins/catalog-backend-module-bitbucket-cloud/config.d.ts @@ -55,10 +55,6 @@ export interface Config { */ projectKey?: string; }; - /** - * (Optional) TaskScheduleDefinition for the discovery. - */ - schedule?: SchedulerServiceTaskScheduleDefinitionConfig; /** * (Optional) At what level discovery should take place, affecting Bitbucket Cloud API limits. * @@ -67,6 +63,10 @@ export interface Config { * - `project`: 1 API call per project, limited to 900 repositories per project. */ level?: 'workspace' | 'project'; + /** + * (Optional) TaskScheduleDefinition for the discovery. + */ + schedule?: SchedulerServiceTaskScheduleDefinitionConfig; } | { [name: string]: { @@ -96,10 +96,6 @@ export interface Config { */ projectKey?: string; }; - /** - * (Optional) TaskScheduleDefinition for the discovery. - */ - schedule?: SchedulerServiceTaskScheduleDefinitionConfig; /** * (Optional) At what level discovery should take place, affecting Bitbucket Cloud API limits. * @@ -108,6 +104,10 @@ export interface Config { * - `project`: 1 API call per project, limited to 900 repositories per project. */ level?: 'workspace' | 'project'; + /** + * (Optional) TaskScheduleDefinition for the discovery. + */ + schedule?: SchedulerServiceTaskScheduleDefinitionConfig; }; }; };