@apistudio/apim-cli/node_modules/@apic/studio-client-model/src/api-authoring/interfaces/api-policy-handler.interface.ts

CLI for API Management Products

/**
 * Copyright IBM Corp. 2024, 2025
 */
import { Metadata } from '../../common/models/base-asset.model.js';
import { FileAccessType } from './api-spec-handler.interface.js';

export interface IApiPolicyHandler {
  /**
   * Update policy sequence array in the given apiFile
   * @param metadata The metadata of scope.
   * @param apiFile FileHandle or VCSFileInfo in which the newly created scope would be referenced
   */
  updatePolicySequence(
    metadata: Metadata,
    apiFile: FileAccessType,
  ): Promise<void>;
  deletePolicySequence(apiFile: FileAccessType): Promise<void>;
}