Merge pull request #700 from obeli-sk/webapi-err

refactor(webapi)!: Change the top-level error variant serialization back to `err`

Author: tomasol

assets/schemas/openapi.json

@@ -2542,10 +2542,10 @@
             "type": "object",
             "description": "Error result (WIT result's error variant)",
             "required": [
-              "error"
+              "err"
             ],
             "properties": {
-              "error": {
+              "err": {
                 "type": [
                   "object",
                   "null"

src/command/integration_tests.rs

@@ -2189,7 +2189,7 @@ async fn activity_js_fetch_denied() {
         .await;
     assert_eq!(resp.status().as_u16(), 201);
     let body: Value = resp.json().await.unwrap();
-    let err = body["error"].as_str().expect("expected error field");
+    let err = body["err"].as_str().expect("expected err field");
     assert!(
         err.contains("HttpRequestDenied"),
         "Expected error to contain 'HttpRequestDenied', got: {err}"
@@ -2255,8 +2255,8 @@ async fn activity_js_throw_null_void_err() {
         .await;
     assert_eq!(resp.status().as_u16(), 201);
     let body: Value = resp.json().await.unwrap();
-    // `throw null` with void err channel → Err(None) → {"error": null}
-    assert_eq!(body, json!({ "error": null }));
+    // `throw null` with void err channel → Err(None) → {"err": null}
+    assert_eq!(body, json!({ "err": null }));
     server.shutdown().await;
 }
 
@@ -2271,7 +2271,7 @@ async fn activity_js_variant_err_throw() {
         .await;
     assert_eq!(resp.status().as_u16(), 201);
     let body: Value = resp.json().await.unwrap();
-    assert_eq!(body, json!({ "error": "not_found" }));
+    assert_eq!(body, json!({ "err": "not_found" }));
     server.shutdown().await;
 }
 
@@ -2301,15 +2301,15 @@ async fn workflow_js_rich_return_type() {
         .await;
     assert_eq!(resp.status().as_u16(), 201);
     let body: Value = resp.json().await.unwrap();
-    assert_eq!(body, json!({ "error": "not_found" }));
+    assert_eq!(body, json!({ "err": "not_found" }));
 
     // err: null (void err channel — result<string>)
     let resp = server
         .submit_follow("testing:integration/workflow-throw-null.throw-null", vec![])
         .await;
     assert_eq!(resp.status().as_u16(), 201);
     let body: Value = resp.json().await.unwrap();
-    assert_eq!(body, json!({ "error": null }));
+    assert_eq!(body, json!({ "err": null }));
     server.shutdown().await;
 }
 
@@ -3220,7 +3220,7 @@ async fn activity_exec_void_err() {
         .await;
     assert_eq!(resp.status().as_u16(), 201);
     let body: Value = resp.json().await.unwrap();
-    assert_eq!(body, json!({ "error": null }));
+    assert_eq!(body, json!({ "err": null }));
     server.shutdown().await;
 }
 
@@ -3261,7 +3261,7 @@ async fn activity_exec_error_exit() {
         .await;
     assert_eq!(resp.status().as_u16(), 201);
     let body: Value = resp.json().await.unwrap();
-    assert_eq!(body, json!({ "error": "something went wrong" }));
+    assert_eq!(body, json!({ "err": "something went wrong" }));
     server.shutdown().await;
 }
 

src/server/web_api_server.rs

@@ -1428,7 +1428,7 @@ enum RetVal {
     Ok(Option<WastVal>),
     /// Error result (WIT result's error variant)
     #[schema(value_type = Option<Object>)]
-    Error(Option<WastVal>),
+    Err(Option<WastVal>),
     /// Execution failed
     #[schema(value_type = Object)]
     ExecutionFailure(FinishedExecutionFailure),
@@ -1440,7 +1440,7 @@ impl From<SupportedFunctionReturnValue> for RetVal {
                 RetVal::Ok(val_with_type.map(|it| it.value))
             }
             SupportedFunctionReturnValue::Err(val_with_type) => {
-                RetVal::Error(val_with_type.map(|it| it.value))
+                RetVal::Err(val_with_type.map(|it| it.value))
             }
             SupportedFunctionReturnValue::ExecutionFailure(err) => RetVal::ExecutionFailure(err),
         }