Interface ISpecExplorer

src/core/interfaces/ISpecService.ts:140–193

 * Interface for exploring and querying OpenAPI specifications
 */
export interface ISpecExplorer {
  /**
   * Initialize the spec explorer
   */
  initialize(): Promise<void>;

  /**
   * Refresh the spec explorer
   */
  refresh(): Promise<void>;

  /**
   * List all specifications in the catalog
   */
  getApiCatalog(): Promise<SpecCatalogEntry[]>;

  /**
   * Find a schema by name within a specification
   */
  findSchemaByName(
    specId: string,
    schemaName: string
  ): Promise<LoadSchemaResult | null>;

  /**
   * Find an operation by its ID within a specification
   */
  findOperationById(
    specId: string,
    operationId: string
  ): Promise<LoadOperationResult | null>;

  /**
   * Find an operation by path and method when operationId is not known
   */
  findOperationByPathAndMethod(
    specId: string,
    path: string,
    method: string
  ): Promise<LoadOperationResult | null>;

  /**
   * Search for operations across specifications
   */
  searchOperations(
    query: string,
    specId?: string
  ): Promise<LoadOperationResult[]>;

  /**
   * Search for schemas across specifications
   */
  searchSchemas(query: string, specId?: string): Promise<SpecSchemaEntry[]>;
}

/**
 * Interface for serializing operation and schema results