@lucidcms/core/dist/libs/http/openapi/index.d.mts

The core of the Lucid CMS. It's responsible for spinning up the API and serving the CMS.

import { OpenAPIV3, OpenAPIV3_1 } from "../../../node_modules/openapi-types/dist/index.mjs";

//#region src/libs/http/openapi/index.d.ts
declare const openAPI: {
  parameters: (props: {
    headers?: {
      csrf?: boolean;
      authorization?: boolean;
      idempotencyKey?: boolean;
    };
    params?: import("zod").ZodType;
    query?: import("zod").ZodType;
  }) => (OpenAPIV3.ParameterObject | OpenAPIV3_1.ReferenceObject)[];
  requestBody: (schema: import("zod").ZodType) => OpenAPIV3.RequestBodyObject;
  responses: (config?: {
    schema?: unknown;
    paginated?: boolean;
    noProperties?: boolean;
  }) => Record<string, OpenAPIV3.ReferenceObject | Omit<OpenAPIV3.ResponseObject, "headers" | "links" | "context">>;
  defaultErrorResponse: {
    readonly type: "object";
    readonly description: string;
    readonly properties: {
      readonly status: {
        readonly type: "number";
        readonly nullable: true;
      };
      readonly code: {
        readonly type: "string";
        readonly nullable: true;
      };
      readonly key: {
        readonly type: "string";
        readonly nullable: true;
      };
      readonly name: {
        readonly type: "string";
        readonly nullable: true;
      };
      readonly message: {
        readonly type: "string";
        readonly nullable: true;
      };
      readonly errors: {
        readonly type: "object";
        readonly nullable: true;
        readonly additionalProperties: true;
      };
    };
    readonly additionalProperties: true;
  };
};
//#endregion
export { openAPI as default };
//# sourceMappingURL=index.d.mts.map