jdalrymple/gitbeaker

View on GitHub
packages/core/src/resources/SearchAdmin.ts

Summary

Maintainability
A
0 mins
Test Coverage
import { BaseResource } from '@gitbeaker/requester-utils';
import { RequestHelper, endpoint } from '../infrastructure';
import type {
  GitlabAPIResponse,
  PaginationRequestOptions,
  PaginationTypes,
  ShowExpanded,
  Sudo,
} from '../infrastructure';

export interface SearchMigrationSchema extends Record<string, unknown> {
  version: number;
  name: string;
  started_at: string;
  completed_at: string;
  completed: boolean;
  obsolete: boolean;
  migration_state: {
    task_id: string | null;
    pause_indexing?: boolean;
    slice?: number;
    max_slices?: number;
    retry_attempt?: number;
    permutation_idx?: number;
    documents_remaining?: number;
    documents_remaining_for_permutation?: number;
  };
}

export class SearchAdmin<C extends boolean = false> extends BaseResource<C> {
  all<E extends boolean = false, P extends PaginationTypes = 'offset'>(
    options?: Sudo & ShowExpanded<E> & PaginationRequestOptions<P>,
  ): Promise<GitlabAPIResponse<SearchMigrationSchema, C, E, void>> {
    return RequestHelper.get<SearchMigrationSchema>()(this, 'admin/search/migrations', options);
  }

  show<E extends boolean = false, P extends PaginationTypes = 'offset'>(
    versionOrName: string,
    options?: Sudo & ShowExpanded<E> & PaginationRequestOptions<P>,
  ): Promise<GitlabAPIResponse<SearchMigrationSchema, C, E, void>> {
    return RequestHelper.get<SearchMigrationSchema>()(
      this,
      endpoint`admin/search/migrations/${versionOrName}`,
      options,
    );
  }
}