Skip to content

Parameterize HttpApi base errorSchema #5654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Parameterize HttpApi base errorSchema #5654

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions packages/platform/src/HttpApi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,14 +255,20 @@ const makeProto = <Id extends string, Groups extends HttpApiGroup.HttpApiGroup.A
*
* The endpoints can be implemented later using the `HttpApiBuilder.make` api.
*
* Allows a base error schema to be provided for transcoding HttpApiDecodeErrors.
* Defaults to `HttpApiDecodeError`.
*
* @since 1.0.0
* @category constructors
*/
export const make = <const Id extends string>(identifier: Id): HttpApi<Id, never, HttpApiDecodeError> =>
export const make = <const Id extends string>(
identifier: Id,
errorSchema: Schema.Schema<HttpApiDecodeError, any> = HttpApiDecodeError
): HttpApi<Id, never, HttpApiDecodeError> =>
makeProto({
identifier,
groups: new Map() as any,
errorSchema: HttpApiDecodeError,
errorSchema,
annotations: Context.empty(),
middlewares: new Set()
})
Expand Down
160 changes: 160 additions & 0 deletions packages/platform/test/OpenApi.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import type { OpenApiJsonSchema } from "@effect/platform"
import {
HttpApi,
HttpApiEndpoint,
HttpApiError,
HttpApiGroup,
HttpApiMiddleware,
HttpApiSchema,
Expand Down Expand Up @@ -206,6 +207,165 @@ describe("OpenApi", () => {
}, { additionalPropertiesStrategy: "allow" })
})

it("custom HttpApiDecodeError", () => {
const MyCustomHttpApiDecodeError = HttpApiError.HttpApiDecodeError.annotations({
identifier: "MyCustomApiDecodeError"
})

const api = HttpApi.make("api", MyCustomHttpApiDecodeError).add(
HttpApiGroup.make("group").add(
HttpApiEndpoint.get("get", "/").addSuccess(Schema.String)
)
)

expectSpec(api, {
"components": {
"schemas": {
"Issue": {
"additionalProperties": false,
"description": "Represents an error encountered while parsing a value to match the schema",
"properties": {
"_tag": {
"description": "The tag identifying the type of parse issue",
"enum": [
"Pointer",
"Unexpected",
"Missing",
"Composite",
"Refinement",
"Transformation",
"Type",
"Forbidden"
],
"type": "string"
},
"message": {
"description": "A descriptive message explaining the issue",
"type": "string"
},
"path": {
"description": "The path to the property where the issue occurred",
"items": {
"$ref": "#/components/schemas/PropertyKey"
},
"type": "array"
}
},
"required": [
"_tag",
"path",
"message"
],
"type": "object"
},
"MyCustomApiDecodeError": {
"additionalProperties": false,
"description": "The request did not match the expected schema",
"properties": {
"_tag": {
"enum": [
"HttpApiDecodeError"
],
"type": "string"
},
"issues": {
"items": {
"$ref": "#/components/schemas/Issue"
},
"type": "array"
},
"message": {
"type": "string"
}
},
"required": [
"issues",
"message",
"_tag"
],
"type": "object"
},
"PropertyKey": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"additionalProperties": false,
"description": "an object to be decoded into a globally shared symbol",
"properties": {
"_tag": {
"enum": [
"symbol"
],
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"_tag",
"key"
],
"type": "object"
}
]
}
},
"securitySchemes": {}
},
"info": {
"title": "Api",
"version": "0.0.1"
},
"openapi": "3.1.0",
"paths": {
"/": {
"get": {
"operationId": "group.get",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"description": "a string"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MyCustomApiDecodeError"
}
}
},
"description": "The request did not match the expected schema"
}
},
"security": [],
"tags": [
"group"
]
}
}
},
"security": [],
"tags": [
{
"name": "group"
}
]
})
})

it("addHttpApi", () => {
const anotherApi = HttpApi.make("api").add(
HttpApiGroup.make("group").add(
Expand Down