openapi-modifier
Version:
This package allows you to automate the process of modifying OpenAPI specifications by applying a set of predefined rules
31 lines (30 loc) • 1.56 kB
TypeScript
import { RuleMetaT } from "../../core/rules/processor-models";
export declare const messagesFactory: {
failedRun: {
emptyPipeline: string;
failedRunPipelineItem: (item: any) => string;
};
ruleNotApply: {
failedToParseDescriptor: (ruleMeta: RuleMetaT, field: string) => string;
withReason: (ruleMeta: RuleMetaT, reason: string) => string;
requiredConfigField: (ruleMeta: RuleMetaT, field: string) => string;
};
deprecated: {
endpoint: (method: string, path: string, description?: string | null | undefined) => string;
endpointParameter: (method: string, path: string, parameterName: string, parameterIn: string, description?: string | null | undefined) => string;
fieldByRef: (propertyKey: string, description?: string | null | undefined) => string;
field: (propertyKey: string, description?: string | null | undefined) => string;
component: (componentName: string, description?: string | null | undefined) => string;
};
configField: {
notUsaged: (field: string, description?: string) => string;
};
failedToResolvePath: {
conflictRef: (sourcePath: string, currentObject: {
$ref: unknown;
}, lostPath: string) => string;
conflictOneOf: (sourcePath: string, currentObject: {}, lostPath: string) => string;
conflictAnyOf: (sourcePath: string, currentObject: {}, lostPath: string) => string;
conflictAllOf: (sourcePath: string, currentObject: {}, lostPath: string) => string;
};
};