use schema class identifier annotation for OpenApi ref identifier (#643)

* use schema class identifier annotation for openapi ref identifier

* update dependencies

Author: sukovanej

.changeset/odd-kiwis-sin.md

@@ -0,0 +1,5 @@
+---
+"effect-http": patch
+---
+
+Use an identifier annotation of a class schema as an OpenApi reference identifier.

package.json

@@ -36,7 +36,7 @@
     "@types/swagger-ui-dist": "^3.30.5",
     "@typescript-eslint/eslint-plugin": "^7.18.0",
     "@typescript-eslint/parser": "^7.18.0",
-    "@vitest/coverage-v8": "^2.0.4",
+    "@vitest/coverage-v8": "^2.0.5",
     "babel-plugin-annotate-pure-calls": "^0.4.0",
     "eslint": "^8.57.0",
     "eslint-import-resolver-typescript": "^3.6.1",
@@ -49,9 +49,9 @@
     "madge": "^7.0.0",
     "prettier": "^3.3.3",
     "rimraf": "^6.0.1",
-    "tsx": "^4.16.2",
+    "tsx": "^4.16.3",
     "typescript": "^5.5.4",
-    "vitest": "^2.0.4"
+    "vitest": "^2.0.5"
   },
   "pnpm": {
     "patchedDependencies": {

packages/effect-http-node/package.json

@@ -39,9 +39,9 @@
     "effect-http": "workspace:^"
   },
   "devDependencies": {
-    "@effect/platform": "^0.61.0",
-    "@effect/platform-bun": "^0.41.0",
-    "@effect/platform-node": "^0.56.0",
+    "@effect/platform": "^0.61.1",
+    "@effect/platform-bun": "^0.41.1",
+    "@effect/platform-node": "^0.56.1",
     "@effect/schema": "^0.70.0",
     "@types/node": "^22.0.0",
     "effect": "^3.6.0",

packages/effect-http/package.json

@@ -37,7 +37,7 @@
   },
   "devDependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
-    "@effect/platform": "^0.61.0",
+    "@effect/platform": "^0.61.1",
     "@effect/schema": "^0.70.0",
     "effect": "^3.6.0"
   }

packages/effect-http/src/internal/open-api.ts

@@ -426,6 +426,17 @@ export const openAPISchemaForAst = (
       componentSchemaCallback(identifier, ast)
       return reference(identifier)
     }
+
+    if (ast._tag === "Transformation") {
+      const identifierTo = Option.getOrUndefined(AST.getIdentifierAnnotation(ast.to))
+      const identifierFrom = Option.getOrUndefined(AST.getIdentifierAnnotation(ast.from))
+
+      if (identifierTo !== undefined && identifierFrom === undefined && componentSchemaCallback) {
+        componentSchemaCallback(identifierTo, ast.from)
+        return reference(identifierTo)
+      }
+    }
+
     return null
   }
 

packages/effect-http/test/openapi.test.ts

@@ -1432,4 +1432,61 @@ describe("component schema and reference", () => {
       }
     })
   })
+
+  it("reference with class schema", async () => {
+    class ReferencedType extends Schema.Class<ReferencedType>("ReferencedType")(
+      Schema.Struct({ something: Schema.String })
+    ) {}
+
+    const api = Api.make({ title: "test", version: "0.1" }).pipe(
+      Api.addEndpoint(
+        Api.post("getPet", "/pet").pipe(Api.setResponseBody(ReferencedType))
+      )
+    )
+    const spec = OpenApi.make(api)
+
+    const openapi = {
+      openapi: "3.0.3",
+      info: { title: "test", version: "0.1" },
+      tags: [{ "name": "default" }],
+      paths: {
+        "/pet": {
+          post: {
+            tags: ["default"],
+            operationId: "getPet",
+            responses: {
+              200: {
+                content: {
+                  "application/json": {
+                    schema: {
+                      $ref: "#/components/schemas/ReferencedType"
+                    }
+                  }
+                },
+                description: "Response 200"
+              }
+            }
+          }
+        }
+      },
+      components: {
+        schemas: {
+          ReferencedType: {
+            properties: {
+              something: {
+                description: "a string",
+                type: "string"
+              }
+            },
+            required: ["something"],
+            type: "object"
+          }
+        }
+      }
+    }
+    expect(spec).toStrictEqual(openapi)
+
+    // @ts-expect-error
+    SwaggerParser.validate(spec)
+  })
 })