style: reorder config property

Signed-off-by: Benjamin Janssens <benji.janssens@gmail.com>
This commit is contained in:
Benjamin Janssens
2024-10-15 15:14:41 +02:00
parent d583c32a21
commit a8ba324217
2 changed files with 11 additions and 11 deletions
@@ -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.
+8 -8
View File
@@ -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;
};
};
};