@scalar/openapi-types/dist/schemas/3.1/unprocessed/openapi-object.js

Modern OpenAPI types

import { z } from "zod";
import { OpenApiObjectSchema as OriginalOpenApiObjectSchema } from "../processed/openapi-object.js";
import { ComponentsObjectSchema } from "./components-object.js";
import { ExternalDocumentationObjectSchema } from "./external-documentation-object.js";
import { InfoObjectSchema } from "./info-object.js";
import { PathsObjectSchema } from "./paths-object.js";
import { SecurityRequirementObjectSchema } from "./security-requirement-object.js";
import { ServerObjectSchema } from "./server-object.js";
import { TagObjectSchema } from "./tag-object.js";
import { WebhooksObjectSchema } from "./webhooks-object.js";
const OpenApiObjectSchema = OriginalOpenApiObjectSchema.extend({
  /**
   * REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required.
   */
  info: InfoObjectSchema,
  /**
   * An array of Server Objects, which provide connectivity information to a target server. If the servers field is
   * not provided, or is an empty array, the default value would be a Server Object with a url value of /.
   */
  servers: z.array(ServerObjectSchema).optional(),
  /**
   * The available paths and operations for the API.
   */
  paths: PathsObjectSchema.optional(),
  /**
   * The incoming webhooks that MAY be received as part of this API and that the API consumer MAY choose to implement.
   * Closely related to the callbacks feature, this section describes requests initiated other than by an API call,
   * for example by an out of band registration. The key name is a unique string to refer to each webhook, while the
   * (optionally referenced) Path Item Object describes a request that may be initiated by the API provider and the
   * expected responses. An example is available.
   */
  webhooks: WebhooksObjectSchema.optional(),
  /**
   * An element to hold various Objects for the OpenAPI Description.
   */
  components: ComponentsObjectSchema.optional(),
  /**
   * A declaration of which security mechanisms can be used across the API. The list of values includes alternative
   * Security Requirement Objects that can be used. Only one of the Security Requirement Objects need to be satisfied
   * to authorize a request. Individual operations can override this definition. The list can be incomplete, up to
   * being empty or absent. To make security explicitly optional, an empty security requirement ({}) can be included
   * in the array.
   */
  security: z.array(SecurityRequirementObjectSchema).optional(),
  /**
   * A list of tags used by the OpenAPI Description with additional metadata. The order of the tags can be used to
   * reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared.
   * The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list
   * MUST be unique.
   */
  tags: z.array(TagObjectSchema).optional(),
  /**
   * Additional external documentation.
   */
  externalDocs: ExternalDocumentationObjectSchema.optional()
});
export {
  OpenApiObjectSchema
};
//# sourceMappingURL=openapi-object.js.map