Status Codes

gcanti · gcanti · commit 05ec12448628 · 2026-01-24T07:30:37.000+01:00
diff --git a/packages/effect/HTTPAPI.md b/packages/effect/HTTPAPI.md
@@ -922,7 +922,7 @@ curl -H "X-API-Key: 1234567890" -H "X-Request-ID: 1234567890" http://localhost:3
 
 The server validates these headers against the declared schema before handling the request.
 
-### Status Codes (TODO: does this work?)
+### Status Codes
 
 By default, the success status code is `200 OK`. You can change it by annotating the schema with a custom status.
 
@@ -945,7 +945,8 @@ const Api = HttpApi.make("MyApi")
     HttpApiGroup.make("Users")
       .add(
         HttpApiEndpoint.get("getUsers", "/users", {
-          success: Schema.Array(User) // how to set the status code?
+          success: Schema.Array(User)
+            .annotate({ httpApiStatus: 206 })
         })
       )
   )

Original file line number	Diff line number	Diff line change
`@@ -922,7 +922,7 @@ curl -H "X-API-Key: 1234567890" -H "X-Request-ID: 1234567890" http://localhost:3`
`922`	`922`
`923`	`923`	`The server validates these headers against the declared schema before handling the request.`
`924`	`924`
`925`		`-### Status Codes (TODO: does this work?)`
	`925`	`+### Status Codes`
`926`	`926`
`927`	`927`	By default, the success status code is `200 OK`. You can change it by annotating the schema with a custom status.
`928`	`928`
`@@ -945,7 +945,8 @@ const Api = HttpApi.make("MyApi")`
`945`	`945`	`HttpApiGroup.make("Users")`
`946`	`946`	`.add(`
`947`	`947`	`HttpApiEndpoint.get("getUsers", "/users", {`
`948`		`- success: Schema.Array(User) // how to set the status code?`
	`948`	`+ success: Schema.Array(User)`
	`949`	`+ .annotate({ httpApiStatus: 206 })`
`949`	`950`	`})`
`950`	`951`	`)`
`951`	`952`	`)`