@zudojs/openapi 1.3.0 → 1.5.0

package/dist/openApiSchema/schemaInput.type.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Schema-bearing inputs a route or operation may declare.
+ */
+import type { OpenAPIHeader, OpenAPIReference, OpenAPISchema } from "../openApiTypes/openApiTypes.core.js";
+import type { SchemaInputOptions } from "./schemaInput.core.js";
+/**
+ * A schema a route may declare: a `@zudojs/schema` schema (anything carrying
+ * a string `_type`, converted with `convertSchema` for the document's
+ * version), or an OpenAPI Schema / Reference Object used as-is.
+ */
+export type OpenAPISchemaInput = OpenAPISchema | OpenAPIReference | {
+    readonly _type: string;
+};
+/**
+ * A request body declared by schema rather than as a raw Request Body Object.
+ */
+export interface OpenAPIRouteBody {
+    /** The body's schema. */
+    readonly schema: OpenAPISchemaInput;
+    /** Media type(s) the body is accepted as. Default: `application/json`. */
+    readonly contentType?: string | readonly string[];
+    /** Whether the body is required. Default: `true`. */
+    readonly required?: boolean;
+    readonly description?: string;
+    readonly example?: unknown;
+}
+/**
+ * A response declared by schema rather than as a raw Response Object.
+ *
+ * An entry in `responses` is read as this shape when it has a `schema` key;
+ * otherwise it is an OpenAPI Response Object and passes through unchanged.
+ */
+export interface OpenAPIRouteResponse {
+    /** The response body's schema. */
+    readonly schema: OpenAPISchemaInput;
+    /** Default: the status code's reason phrase, e.g. "Not Found". */
+    readonly description?: string;
+    /** Media type(s) the body is sent as. Default: `application/json`. */
+    readonly contentType?: string | readonly string[];
+    readonly headers?: Readonly<Record<string, OpenAPIHeader>>;
+    readonly example?: unknown;
+}
+/**
+ * Options for converting a route into an operation: the version declared
+ * schemas are converted for, and a sink for what they could not express.
+ */
+export type RouteConversionOptions = SchemaInputOptions;
+//# sourceMappingURL=schemaInput.type.d.ts.map

package/dist/openApiSchema/schemaInput.type.js

@@ -0,0 +1,5 @@
+/**
+ * Schema-bearing inputs a route or operation may declare.
+ */
+export {};
+//# sourceMappingURL=schemaInput.type.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zudojs/openapi",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "OpenAPI 3.0 and 3.1 specification generation, validation, and serialization for Zudojs applications.",
   "license": "MIT",
   "author": {
@@ -26,13 +26,14 @@
     "!dist/.tsbuildinfo"
   ],
   "dependencies": {
-    "@zudojs/constants": "1.1.0",
-    "@zudojs/errors": "1.1.0"
+    "@zudojs/constants": "1.1.2",
+    "@zudojs/errors": "1.3.0"
   },
   "devDependencies": {
-    "@types/node": "^26.4.1",
+    "@types/node": "^26.6.2",
+    "@zudojs/schema": "1.2.0",
     "typescript": "7.0.2",
-    "vitest": "^4.1.11"
+    "vitest": "^5.0.1"
   },
   "engines": {
     "node": ">=24.0.0"
@@ -46,7 +47,7 @@
     "swagger",
     "api-docs"
   ],
-  "homepage": "https://github.com/oyinlola-tech/zudo#readme",
+  "homepage": "https://zudojs.oyinlola.site/docs/packages-openapi",
   "bugs": {
     "url": "https://github.com/oyinlola-tech/zudo/issues"
   },