Limitation with scope Parameter in Jobs Endpoint

[Nikolsonn]

Description

Recently, our project started using Gitbeaker, and we’ve encountered a limitation with one of the endpoints.
GET /projects/:id/pipelines/:pipeline_id/jobs
According to the documentation, the scope parameter should accept either a string or an array of strings. However, in the current implementation, it only works with a single string value.

This restriction impacts efficiency—especially when filtering jobs by multiple statuses. In my case, I need to filter by 5 different statuses to find jobs that did not pass (don't have status success), so I can re-run them. Supporting an array for scope would significantly reduce the number of requests needed in such scenarios.

I’m happy to look into implementing a fix, but I wanted to open a discussion first to confirm the best approach.

Thanks in advance for your time and feedback!

Checklist

• I have checked that this is not a duplicate issue.
• I have read the documentation.

[jdalrymple]

If i remember correctly, I think you should be able to update the type and test it out. Under the hood we do handle passing in array values so it should* work already:

Basically:

  all<E extends boolean = false, P extends PaginationTypes = 'offset'>(
    projectId: string | number,
    {
      pipelineId,
      ...options
    }: { pipelineId?: number; scope?: JobScope | JobScope[]; includeRetried?: boolean } & BaseRequestOptions<E> &
      PaginationRequestOptions<P> = {} as any,
  ): Promise<GitlabAPIResponse<JobSchema[], C, E, P>> {
    const url = pipelineId
      ? endpoint`projects/${projectId}/pipelines/${pipelineId}/jobs`
      : endpoint`projects/${projectId}/jobs`;

    return RequestHelper.get<JobSchema[]>()(this, url, options);
  }

[Nikolsonn]

According to the documentation, each status should be specified as a separate scope parameter, for example: ?scope[]=pending&scope[]=running. However, your approach would generate ?scope[]=pending,running instead, if I understand correctly.

[jdalrymple]

Not quite, the change i made updates the typing to allow you to pass a list of "JobScopes" as a value to scope.

When the RequestHelper handles that input, it should*** format the sent array as scope[]=value1&scope[]=value2 already, but youd have to double check by testing it. The Gitlab API has a tendency of not being consistent with their array formatting.

[jdalrymple]

@Nikolsonn just following up on this one, did it work out okay?