From d6a4e2b4703ea99b8aaaf7914309c74fef627eb4 Mon Sep 17 00:00:00 2001 From: Quadman Date: Wed, 3 Apr 2024 20:08:45 +0200 Subject: [PATCH] Update getAllTeams parameter name to 'limit' Signed-off-by: Quadman --- .changeset/brown-beers-share.md | 2 +- plugins/azure-devops-backend/api-report.md | 2 +- plugins/azure-devops-backend/src/api/AzureDevOpsApi.ts | 4 ++-- .../src/api/PullRequestsDashboardProvider.ts | 8 ++++---- plugins/azure-devops-backend/src/service/router.ts | 8 ++------ plugins/azure-devops/api-report.md | 4 ++-- plugins/azure-devops/src/api/AzureDevOpsApi.ts | 2 +- plugins/azure-devops/src/api/AzureDevOpsClient.ts | 6 +++--- 8 files changed, 16 insertions(+), 20 deletions(-) diff --git a/.changeset/brown-beers-share.md b/.changeset/brown-beers-share.md index 4ca548ebb4..425cba62f6 100644 --- a/.changeset/brown-beers-share.md +++ b/.changeset/brown-beers-share.md @@ -3,4 +3,4 @@ '@backstage/plugin-azure-devops': patch --- -`getAllTeams` now accepts an optional `teamsLimit` parameter which can be used to return more than the default limit of 100 teams from the Azure DevOps API +`getAllTeams` now accepts an optional `limit` parameter which can be used to return more than the default limit of 100 teams from the Azure DevOps API diff --git a/plugins/azure-devops-backend/api-report.md b/plugins/azure-devops-backend/api-report.md index ae78098400..41eee642c7 100644 --- a/plugins/azure-devops-backend/api-report.md +++ b/plugins/azure-devops-backend/api-report.md @@ -56,7 +56,7 @@ export class AzureDevOpsApi { }, ): AzureDevOpsApi; // (undocumented) - getAllTeams(teamsLimit?: number): Promise; + getAllTeams(limit?: number): Promise; // (undocumented) getBuildDefinitions( projectName: string, diff --git a/plugins/azure-devops-backend/src/api/AzureDevOpsApi.ts b/plugins/azure-devops-backend/src/api/AzureDevOpsApi.ts index 08fa157204..bd07a248b8 100644 --- a/plugins/azure-devops-backend/src/api/AzureDevOpsApi.ts +++ b/plugins/azure-devops-backend/src/api/AzureDevOpsApi.ts @@ -397,7 +397,7 @@ export class AzureDevOpsApi { .filter((policy): policy is Policy => Boolean(policy)); } - public async getAllTeams(teamsLimit?: number): Promise { + public async getAllTeams(limit?: number): Promise { this.logger?.debug('Getting all teams.'); const webApi = await this.getWebApi(); @@ -405,7 +405,7 @@ export class AzureDevOpsApi { const webApiTeams: WebApiTeam[] = await client.getAllTeams( undefined, - teamsLimit, + limit, undefined, undefined, ); diff --git a/plugins/azure-devops-backend/src/api/PullRequestsDashboardProvider.ts b/plugins/azure-devops-backend/src/api/PullRequestsDashboardProvider.ts index 9d927cdfa1..dd34bd4329 100644 --- a/plugins/azure-devops-backend/src/api/PullRequestsDashboardProvider.ts +++ b/plugins/azure-devops-backend/src/api/PullRequestsDashboardProvider.ts @@ -45,10 +45,10 @@ export class PullRequestsDashboardProvider { return provider; } - public async readTeams(teamsLimit?: number): Promise { + public async readTeams(limit?: number): Promise { this.logger.info('Reading teams.'); - let teams = await this.azureDevOpsApi.getAllTeams(teamsLimit); + let teams = await this.azureDevOpsApi.getAllTeams(limit); // This is used to filter out the default Azure Devops project teams. teams = teams.filter(team => @@ -137,9 +137,9 @@ export class PullRequestsDashboardProvider { ); } - public async getAllTeams(teamsLimit?: number): Promise { + public async getAllTeams(limit?: number): Promise { if (!this.teams.size) { - const maxTeams = teamsLimit ?? DEFAULT_TEAMS_LIMIT; + const maxTeams = limit ?? DEFAULT_TEAMS_LIMIT; await this.readTeams(maxTeams); } diff --git a/plugins/azure-devops-backend/src/service/router.ts b/plugins/azure-devops-backend/src/service/router.ts index dd41cf636f..73204193f2 100644 --- a/plugins/azure-devops-backend/src/service/router.ts +++ b/plugins/azure-devops-backend/src/service/router.ts @@ -274,12 +274,8 @@ export async function createRouter( }); router.get('/all-teams', async (req, res) => { - const teamsLimit = req.query.teamsLimit - ? Number(req.query.teamsLimit) - : undefined; - const allTeams = await pullRequestsDashboardProvider.getAllTeams( - teamsLimit, - ); + const limit = req.query.limit ? Number(req.query.limit) : undefined; + const allTeams = await pullRequestsDashboardProvider.getAllTeams(limit); res.status(200).json(allTeams); }); diff --git a/plugins/azure-devops/api-report.md b/plugins/azure-devops/api-report.md index e470d255d6..4c91fba9e3 100644 --- a/plugins/azure-devops/api-report.md +++ b/plugins/azure-devops/api-report.md @@ -65,7 +65,7 @@ export type AssignedToUserFilter = BaseFilter & // @public (undocumented) export interface AzureDevOpsApi { // (undocumented) - getAllTeams(teamsLimit?: number): Promise; + getAllTeams(limit?: number): Promise; // (undocumented) getBuildRuns( projectName: string, @@ -127,7 +127,7 @@ export const azureDevOpsApiRef: ApiRef; export class AzureDevOpsClient implements AzureDevOpsApi { constructor(options: { discoveryApi: DiscoveryApi; fetchApi: FetchApi }); // (undocumented) - getAllTeams(teamsLimit?: number): Promise; + getAllTeams(limit?: number): Promise; // (undocumented) getBuildRuns( projectName: string, diff --git a/plugins/azure-devops/src/api/AzureDevOpsApi.ts b/plugins/azure-devops/src/api/AzureDevOpsApi.ts index 6f839d824d..9f9ff1209f 100644 --- a/plugins/azure-devops/src/api/AzureDevOpsApi.ts +++ b/plugins/azure-devops/src/api/AzureDevOpsApi.ts @@ -67,7 +67,7 @@ export interface AzureDevOpsApi { teamsLimit?: number, ): Promise; - getAllTeams(teamsLimit?: number): Promise; + getAllTeams(limit?: number): Promise; getUserTeamIds(userId: string): Promise; diff --git a/plugins/azure-devops/src/api/AzureDevOpsClient.ts b/plugins/azure-devops/src/api/AzureDevOpsClient.ts index 8b0bf50523..ce823def06 100644 --- a/plugins/azure-devops/src/api/AzureDevOpsClient.ts +++ b/plugins/azure-devops/src/api/AzureDevOpsClient.ts @@ -135,10 +135,10 @@ export class AzureDevOpsClient implements AzureDevOpsApi { return this.get(urlSegment); } - public getAllTeams(teamsLimit?: number): Promise { + public getAllTeams(limit?: number): Promise { const queryString = new URLSearchParams(); - if (teamsLimit) { - queryString.append('teamsLimit', teamsLimit.toString()); + if (limit) { + queryString.append('limit', limit.toString()); } let urlSegment = 'all-teams'; if (queryString.toString()) {