From d6dc1c9b57f436ce2608460b60035e129a86f4c8 Mon Sep 17 00:00:00 2001 From: Anders Olsson Date: Fri, 5 Jun 2026 15:32:48 +0200 Subject: [PATCH] feat(api): field-level set_fields 422 body (#28); enum-type SearchHitView.visibility (#38) Co-Authored-By: Claude Sonnet 4.6 --- crates/api/src/admin_objects.rs | 68 +++++++++++++++++++++++-------- crates/api/src/admin_search.rs | 1 + crates/api/src/openapi.rs | 1 + crates/api/tests/admin_objects.rs | 46 +++++++++++++++++++++ web/src/api/schema.d.ts | 15 +++++-- web/src/test/fixtures.ts | 2 +- 6 files changed, 111 insertions(+), 22 deletions(-) diff --git a/crates/api/src/admin_objects.rs b/crates/api/src/admin_objects.rs index 72ea003..c053d85 100644 --- a/crates/api/src/admin_objects.rs +++ b/crates/api/src/admin_objects.rs @@ -510,6 +510,15 @@ pub(crate) async fn create_field_definition( } } +/// Field-level rejection detail for `set_fields`, so the UI can highlight the field. +#[derive(Serialize, ToSchema)] +pub(crate) struct FieldErrorView { + /// The flexible-field key that was rejected. + pub field: String, + /// Machine code: "unknown" | "type_mismatch" | "unresolved". + pub code: String, +} + /// Replace an object's flexible-field values (validated against the registry). /// /// **Replace semantics:** the body is the *complete* desired field set. Omitting a key @@ -525,7 +534,7 @@ pub(crate) async fn create_field_definition( (status = 401), (status = 403), (status = 404, description = "Object not found"), - (status = 422, description = "Unknown field, type mismatch, or unresolved reference") + (status = 422, body = FieldErrorView, description = "A field was rejected") ) )] pub(crate) async fn set_fields( @@ -533,34 +542,57 @@ pub(crate) async fn set_fields( State(state): State, Path(id): Path, Json(values): Json>, -) -> Result { - let object_id = id.parse::().map_err(|_| StatusCode::NOT_FOUND)?; +) -> axum::response::Response { + use axum::response::IntoResponse; - let mut tx = state - .db - .pool() - .begin() - .await - .map_err(|_| StatusCode::INTERNAL_SERVER_ERROR)?; + let Ok(object_id) = id.parse::() else { + return StatusCode::NOT_FOUND.into_response(); + }; + + let mut tx = match state.db.pool().begin().await { + Ok(tx) => tx, + Err(_) => return StatusCode::INTERNAL_SERVER_ERROR.into_response(), + }; let result = db::catalog::set_object_fields(&mut tx, actor(&auth.user), object_id, &values).await; match result { Ok(()) => { - tx.commit() - .await - .map_err(|_| StatusCode::INTERNAL_SERVER_ERROR)?; + if tx.commit().await.is_err() { + return StatusCode::INTERNAL_SERVER_ERROR.into_response(); + } reindex(&state, object_id).await; - Ok(StatusCode::NO_CONTENT) + StatusCode::NO_CONTENT.into_response() } - Err(db::catalog::FieldError::ObjectNotFound) => Err(StatusCode::NOT_FOUND), - Err(db::catalog::FieldError::Db(_)) => Err(StatusCode::INTERNAL_SERVER_ERROR), - Err(db::catalog::FieldError::UnknownField(_)) => Err(StatusCode::UNPROCESSABLE_ENTITY), - Err(db::catalog::FieldError::TypeMismatch { .. }) => Err(StatusCode::UNPROCESSABLE_ENTITY), - Err(db::catalog::FieldError::Unresolved { .. }) => Err(StatusCode::UNPROCESSABLE_ENTITY), + Err(db::catalog::FieldError::ObjectNotFound) => StatusCode::NOT_FOUND.into_response(), + Err(db::catalog::FieldError::Db(_)) => StatusCode::INTERNAL_SERVER_ERROR.into_response(), + Err(db::catalog::FieldError::UnknownField(field)) => ( + StatusCode::UNPROCESSABLE_ENTITY, + Json(FieldErrorView { + field, + code: "unknown".to_owned(), + }), + ) + .into_response(), + Err(db::catalog::FieldError::TypeMismatch { field, .. }) => ( + StatusCode::UNPROCESSABLE_ENTITY, + Json(FieldErrorView { + field, + code: "type_mismatch".to_owned(), + }), + ) + .into_response(), + Err(db::catalog::FieldError::Unresolved { field, .. }) => ( + StatusCode::UNPROCESSABLE_ENTITY, + Json(FieldErrorView { + field, + code: "unresolved".to_owned(), + }), + ) + .into_response(), } } diff --git a/crates/api/src/admin_search.rs b/crates/api/src/admin_search.rs index 2245f9c..fc03aa0 100644 --- a/crates/api/src/admin_search.rs +++ b/crates/api/src/admin_search.rs @@ -28,6 +28,7 @@ pub(crate) struct SearchHitView { pub object_number: String, pub object_name: String, pub brief_description: Option, + #[schema(value_type = domain::Visibility)] pub visibility: String, pub snippet: Option, } diff --git a/crates/api/src/openapi.rs b/crates/api/src/openapi.rs index c176145..b625cba 100644 --- a/crates/api/src/openapi.rs +++ b/crates/api/src/openapi.rs @@ -53,6 +53,7 @@ use crate::{ admin_objects::FieldDefinitionView, admin_objects::NewFieldDefinitionRequest, admin_objects::CreatedField, + admin_objects::FieldErrorView, admin_vocab::VocabularyView, admin_vocab::NewVocabularyRequest, admin_vocab::NewTermRequest, diff --git a/crates/api/tests/admin_objects.rs b/crates/api/tests/admin_objects.rs index fe6a677..aa098f5 100644 --- a/crates/api/tests/admin_objects.rs +++ b/crates/api/tests/admin_objects.rs @@ -434,6 +434,52 @@ async fn set_fields_and_list_field_definitions(pool: PgPool) { assert_eq!(bad.status(), StatusCode::UNPROCESSABLE_ENTITY); } +#[sqlx::test(migrations = "../db/migrations")] +async fn set_fields_unknown_field_returns_field_detail(pool: PgPool) { + migrate_sessions(&db::Db::from_pool(pool.clone())) + .await + .unwrap(); + + seed_user(&pool, "ed@example.com", "pw-editor-123", Role::Editor).await; + + let db = db::Db::from_pool(pool.clone()); + let mut tx = db.pool().begin().await.unwrap(); + + let id = catalog::create_object( + &mut tx, + AuditActor::System, + &obj("A-1", "amphora", Visibility::Draft), + ) + .await + .unwrap(); + + tx.commit().await.unwrap(); + + let app = build_app(state(pool)); + let cookie = login(&app, "ed@example.com", "pw-editor-123").await; + + let resp = app + .oneshot( + Request::builder() + .method("PUT") + .uri(format!("/api/admin/objects/{id}/fields")) + .header(header::COOKIE, &cookie) + .header(header::CONTENT_TYPE, "application/json") + .body(Body::from(r#"{"definitely_not_a_field":"x"}"#)) + .unwrap(), + ) + .await + .unwrap(); + + assert_eq!(resp.status(), StatusCode::UNPROCESSABLE_ENTITY); + + let body: serde_json::Value = + serde_json::from_slice(&resp.into_body().collect().await.unwrap().to_bytes()).unwrap(); + + assert_eq!(body["field"], "definitely_not_a_field"); + assert_eq!(body["code"], "unknown"); +} + #[sqlx::test(migrations = "../db/migrations")] async fn create_requires_auth(pool: PgPool) { migrate_sessions(&db::Db::from_pool(pool.clone())) diff --git a/web/src/api/schema.d.ts b/web/src/api/schema.d.ts index 3fc7b8e..4e49a0d 100644 --- a/web/src/api/schema.d.ts +++ b/web/src/api/schema.d.ts @@ -408,6 +408,13 @@ export interface components { required: boolean; vocabulary_id?: string | null; }; + /** @description Field-level rejection detail for `set_fields`, so the UI can highlight the field. */ + FieldErrorView: { + /** @description Machine code: "unknown" | "type_mismatch" | "unresolved". */ + code: string; + /** @description The flexible-field key that was rejected. */ + field: string; + }; LabelInput: { label: string; lang: string; @@ -513,7 +520,7 @@ export interface components { object_name: string; object_number: string; snippet?: string | null; - visibility: string; + visibility: components["schemas"]["Visibility"]; }; SearchResultsView: { /** @description Meilisearch's estimate of the total number of matches. */ @@ -1038,12 +1045,14 @@ export interface operations { }; content?: never; }; - /** @description Unknown field, type mismatch, or unresolved reference */ + /** @description A field was rejected */ 422: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["FieldErrorView"]; + }; }; }; }; diff --git a/web/src/test/fixtures.ts b/web/src/test/fixtures.ts index 1fcd269..3c34bc7 100644 --- a/web/src/test/fixtures.ts +++ b/web/src/test/fixtures.ts @@ -79,7 +79,7 @@ export const searchHits: SearchHitView[] = [ object_number: `N-${i + 2}`, object_name: `Object ${i + 2}`, brief_description: null, - visibility: "internal", + visibility: "internal" as const, snippet: null, })), ];