@redocly/cli
Version:
[@Redocly](https://redocly.com) CLI is your all-in-one API documentation utility. It builds, manages, improves, and quality-checks your API descriptions, all of which comes in handy for various phases of the API Lifecycle. Create your own rulesets to make
21 lines • 941 B
TypeScript
import type { ScorecardConfig } from '@redocly/config';
import { type Document, type Plugin, type BaseResolver } from '@redocly/openapi-core';
import type { ScorecardProblem } from '../types.js';
export type ScorecardValidationResult = {
problems: ScorecardProblem[];
achievedLevel: string;
targetLevelAchieved: boolean;
};
export type ValidateScorecardParams = {
apiPath: string;
document: Document;
externalRefResolver: BaseResolver;
scorecardConfig: ScorecardConfig;
configPath?: string;
pluginsCodeOrPlugins?: string | Plugin[];
targetLevel?: string;
metadata?: Record<string, unknown>;
verbose?: boolean;
};
export declare function validateScorecard({ apiPath, document, externalRefResolver, scorecardConfig, configPath, pluginsCodeOrPlugins, targetLevel, metadata, verbose, }: ValidateScorecardParams): Promise<ScorecardValidationResult>;
//# sourceMappingURL=validate-scorecard.d.ts.map