Update getAllTeams parameter name to 'limit'

Signed-off-by: Quadman <QuadmanSWE@gmail.com>
This commit is contained in:
Quadman
2024-04-03 20:08:45 +02:00
parent 637c1eacf0
commit d6a4e2b470
8 changed files with 16 additions and 20 deletions
+1 -1
View File
@@ -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
+1 -1
View File
@@ -56,7 +56,7 @@ export class AzureDevOpsApi {
},
): AzureDevOpsApi;
// (undocumented)
getAllTeams(teamsLimit?: number): Promise<Team[]>;
getAllTeams(limit?: number): Promise<Team[]>;
// (undocumented)
getBuildDefinitions(
projectName: string,
@@ -397,7 +397,7 @@ export class AzureDevOpsApi {
.filter((policy): policy is Policy => Boolean(policy));
}
public async getAllTeams(teamsLimit?: number): Promise<Team[]> {
public async getAllTeams(limit?: number): Promise<Team[]> {
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,
);
@@ -45,10 +45,10 @@ export class PullRequestsDashboardProvider {
return provider;
}
public async readTeams(teamsLimit?: number): Promise<void> {
public async readTeams(limit?: number): Promise<void> {
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<Team[]> {
public async getAllTeams(limit?: number): Promise<Team[]> {
if (!this.teams.size) {
const maxTeams = teamsLimit ?? DEFAULT_TEAMS_LIMIT;
const maxTeams = limit ?? DEFAULT_TEAMS_LIMIT;
await this.readTeams(maxTeams);
}
@@ -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);
});
+2 -2
View File
@@ -65,7 +65,7 @@ export type AssignedToUserFilter = BaseFilter &
// @public (undocumented)
export interface AzureDevOpsApi {
// (undocumented)
getAllTeams(teamsLimit?: number): Promise<Team[]>;
getAllTeams(limit?: number): Promise<Team[]>;
// (undocumented)
getBuildRuns(
projectName: string,
@@ -127,7 +127,7 @@ export const azureDevOpsApiRef: ApiRef<AzureDevOpsApi>;
export class AzureDevOpsClient implements AzureDevOpsApi {
constructor(options: { discoveryApi: DiscoveryApi; fetchApi: FetchApi });
// (undocumented)
getAllTeams(teamsLimit?: number): Promise<Team[]>;
getAllTeams(limit?: number): Promise<Team[]>;
// (undocumented)
getBuildRuns(
projectName: string,
@@ -67,7 +67,7 @@ export interface AzureDevOpsApi {
teamsLimit?: number,
): Promise<DashboardPullRequest[]>;
getAllTeams(teamsLimit?: number): Promise<Team[]>;
getAllTeams(limit?: number): Promise<Team[]>;
getUserTeamIds(userId: string): Promise<string[]>;
@@ -135,10 +135,10 @@ export class AzureDevOpsClient implements AzureDevOpsApi {
return this.get<DashboardPullRequest[]>(urlSegment);
}
public getAllTeams(teamsLimit?: number): Promise<Team[]> {
public getAllTeams(limit?: number): Promise<Team[]> {
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()) {