openapi-modifier
Version:
This package allows you to automate the process of modifying OpenAPI specifications by applying a set of predefined rules
72 lines (71 loc) • 2.29 kB
TypeScript
import { RuleProcessorT } from '../../core/rules/processor-models';
import { z } from 'zod';
declare const configSchema: z.ZodObject<{
ignoreComponents: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodObject<{
componentName: z.ZodString;
}, "strict", z.ZodTypeAny, {
componentName: string;
}, {
componentName: string;
}>]>, "many">>;
ignoreEndpoints: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodObject<{
path: z.ZodString;
method: z.ZodString;
}, "strict", z.ZodTypeAny, {
path: string;
method: string;
}, {
path: string;
method: string;
}>, z.ZodString]>, "many">>;
ignoreEndpointParameters: z.ZodOptional<z.ZodArray<z.ZodObject<{
path: z.ZodString;
method: z.ZodString;
name: z.ZodString;
in: z.ZodUnion<[z.ZodLiteral<"query">, z.ZodLiteral<"header">, z.ZodLiteral<"path">, z.ZodLiteral<"cookie">]>;
}, "strict", z.ZodTypeAny, {
name: string;
path: string;
method: string;
in: "path" | "query" | "header" | "cookie";
}, {
name: string;
path: string;
method: string;
in: "path" | "query" | "header" | "cookie";
}>, "many">>;
showDeprecatedDescriptions: z.ZodOptional<z.ZodBoolean>;
}, "strict", z.ZodTypeAny, {
ignoreComponents?: (string | {
componentName: string;
})[] | undefined;
ignoreEndpoints?: (string | {
path: string;
method: string;
})[] | undefined;
ignoreEndpointParameters?: {
name: string;
path: string;
method: string;
in: "path" | "query" | "header" | "cookie";
}[] | undefined;
showDeprecatedDescriptions?: boolean | undefined;
}, {
ignoreComponents?: (string | {
componentName: string;
})[] | undefined;
ignoreEndpoints?: (string | {
path: string;
method: string;
})[] | undefined;
ignoreEndpointParameters?: {
name: string;
path: string;
method: string;
in: "path" | "query" | "header" | "cookie";
}[] | undefined;
showDeprecatedDescriptions?: boolean | undefined;
}>;
declare const processor: RuleProcessorT<typeof configSchema>;
export default processor;
export { configSchema };