add documentation, remove unused export

jsr.json

@@ -1,6 +1,6 @@
 {
   "name": "@camflan/valibot-openapi-generator",
-  "version": "2024.12.12",
+  "version": "2024.12.13",
   "exports": {
     ".": "./mod.ts"
   }

mod.ts

@@ -1,3 +1,2 @@
 export { describeRoute } from "./src/route.ts";
 export { getOpenAPISpecs } from "./src/openapi.ts";
-export { resolver as schemaResolver } from "./src/valibot.ts";

package.json

@@ -1,6 +1,6 @@
 {
   "name": "valibot-openapi-generator",
-  "version": "2024.12.12",
+  "version": "2024.12.13",
   "description": "",
   "type": "module",
   "sideEffects": false,

src/openapi.ts

@@ -13,6 +13,11 @@ import type {
 const DEFAULT_TITLE = "Valibot schema documentation";
 const DEFAULT_DESCRIPTION = "Development documentation";
 
+/** getOpenAPISpecs
+ * Combines DescribedRoutes into a single OpenAPI document.
+ *
+ * @returns OpenAPIV3.Document
+ */
 export async function getOpenAPISpecs(
   routes: DescribedRoute[],
   {

src/route.ts

@@ -24,6 +24,12 @@ type HandleSchemaOptions = {
   config: OpenAPIRouteHandlerConfig;
 };
 
+/** describeRoute
+ * Creates a route description that will be used by getOpenAPISpecs to combine
+ * into a single OpenAPI spec document.
+ *
+ * @returns DescribedRoute - Route description for getOpenAPISpecs
+ */
 export function describeRoute(
   path: string,
   { method, ...specs }: DescribeRouteOptions,