openapi-modifier/dist-types/src/rules/common/config.d.ts

This package allows you to automate the process of modifying OpenAPI specifications by applying a set of predefined rules

import { z } from 'zod';
export declare const patchMethodConfigSchema: z.ZodUnion<[z.ZodLiteral<"deepmerge">, z.ZodLiteral<"merge">]>;
export declare const openAPISchemaConfigSchema: z.ZodAny;
export declare const parameterInConfigSchema: z.ZodUnion<[z.ZodLiteral<"query">, z.ZodLiteral<"header">, z.ZodLiteral<"path">, z.ZodLiteral<"cookie">]>;
export declare const correctionConfigSchema: z.ZodString;
export declare const endpointParameterDescriptorConfigSchema: z.ZodObject<{
    name: z.ZodString;
    in: z.ZodUnion<[z.ZodLiteral<"query">, z.ZodLiteral<"header">, z.ZodLiteral<"path">, z.ZodLiteral<"cookie">]>;
}, "strict", z.ZodTypeAny, {
    name: string;
    in: "path" | "query" | "header" | "cookie";
}, {
    name: string;
    in: "path" | "query" | "header" | "cookie";
}>;
export declare const endpointParameterWithCorrectionDescriptorConfigSchema: z.ZodObject<{
    name: z.ZodString;
    in: z.ZodUnion<[z.ZodLiteral<"query">, z.ZodLiteral<"header">, z.ZodLiteral<"path">, z.ZodLiteral<"cookie">]>;
    correction: z.ZodOptional<z.ZodString>;
}, "strict", z.ZodTypeAny, {
    name: string;
    in: "path" | "query" | "header" | "cookie";
    correction?: string | undefined;
}, {
    name: string;
    in: "path" | "query" | "header" | "cookie";
    correction?: string | undefined;
}>;
export declare const parameterDescriptorConfigSchema: 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";
}>;
export declare const simpleComponentWithCorrectionDescriptorConfigSchema: z.ZodString;
export declare const componentWithCorrectionDescriptorConfigSchema: z.ZodObject<{
    componentName: z.ZodString;
    correction: z.ZodOptional<z.ZodString>;
}, "strict", z.ZodTypeAny, {
    componentName: string;
    correction?: string | undefined;
}, {
    componentName: string;
    correction?: string | undefined;
}>;
export declare const anyComponentWithCorrectionDescriptorConfigSchema: z.ZodUnion<[z.ZodString, z.ZodObject<{
    componentName: z.ZodString;
    correction: z.ZodOptional<z.ZodString>;
}, "strict", z.ZodTypeAny, {
    componentName: string;
    correction?: string | undefined;
}, {
    componentName: string;
    correction?: string | undefined;
}>]>;
export declare const simpleComponentDescriptorConfigSchema: z.ZodString;
export declare const componentDescriptorConfigSchema: z.ZodObject<{
    componentName: z.ZodString;
}, "strict", z.ZodTypeAny, {
    componentName: string;
}, {
    componentName: string;
}>;
export declare const anyComponentDescriptorConfigSchema: z.ZodUnion<[z.ZodString, z.ZodObject<{
    componentName: z.ZodString;
}, "strict", z.ZodTypeAny, {
    componentName: string;
}, {
    componentName: string;
}>]>;
export declare const endpointResponseDescriptorConfigSchema: z.ZodObject<{
    code: z.ZodString;
    contentType: z.ZodString;
}, "strict", z.ZodTypeAny, {
    code: string;
    contentType: string;
}, {
    code: string;
    contentType: string;
}>;
export declare const simpleEndpointDescriptorConfigSchema: z.ZodString;
export declare const endpointDescriptorConfigSchema: z.ZodObject<{
    path: z.ZodString;
    method: z.ZodString;
}, "strict", z.ZodTypeAny, {
    path: string;
    method: string;
}, {
    path: string;
    method: string;
}>;
export declare const anyEndpointDescriptorConfigSchema: z.ZodUnion<[z.ZodObject<{
    path: z.ZodString;
    method: z.ZodString;
}, "strict", z.ZodTypeAny, {
    path: string;
    method: string;
}, {
    path: string;
    method: string;
}>, z.ZodString]>;
export declare const operationIdConfigSchema: z.ZodString;