logaritmisk/biggus-dickus
1
0
Fork 0
Code Issues 17 Pull Requests Actions Packages Projects Releases Wiki Activity

feat(api): enum-typed visibility/data_type/kind + open-map fields in OpenAPI (#24 #29)

Browse Source 
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Anders Olsson
2026-06-04 20:14:30 +02:00
parent d3c33a6c5d
commit 5a72f85989
5 changed files with 39 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
web/src/api/schema.d.ts
Vendored
+30 -7
View File
@@ -326,7 +326,9 @@ export interface components {
current_location?: string | null;
current_owner?: string | null;
/** @description Flexible field values (key -> value). */
fields: Record<string, never>;
fields: {
[key: string]: unknown;
};
id: string;
/** Format: int32 */
number_of_objects: number;
@@ -336,12 +338,21 @@ export interface components {
/** @description `YYYY-MM-DD` or null. */
recording_date?: string | null;
/** @description "draft" | "internal" | "public". */
visibility: string;
visibility: components["schemas"]["Visibility"];
};
/**
* @description The kind of authority record.
*
* NOTE: kept in sync by hand with the
* `CHECK (kind IN ('person', 'organisation', 'place'))` constraint in
* `crates/db/migrations/0002_vocabularies_authorities.sql` — add a variant in both places.
* @enum {string}
*/
AuthorityKind: "person" | "organisation" | "place";
AuthorityView: {
external_uri?: string | null;
id: string;
kind: string;
kind: components["schemas"]["AuthorityKind"];
labels: components["schemas"]["LabelView"][];
};
CreatedField: {
@@ -354,11 +365,18 @@ export interface components {
CreatedObject: {
id: string;
};
/**
* @description The stored `data_type` discriminant of a field definition — mirrors the strings from
* [`FieldType::kind_str`]. Exists so the OpenAPI schema can describe `data_type` as a
* closed string enum (consumed by the typed web client). Keep in sync with `kind_str`.
* @enum {string}
*/
DataType: "text" | "localized_text" | "integer" | "date" | "boolean" | "term" | "authority";
/** @description Field-definition descriptor for the UI to render forms. */
FieldDefinitionView: {
authority_kind?: string | null;
authority_kind?: null | components["schemas"]["AuthorityKind"];
/** @description "text" | "localized_text" | "integer" | "date" | "boolean" | "term" | "authority". */
data_type: string;
data_type: components["schemas"]["DataType"];
group?: string | null;
key: string;
labels: components["schemas"]["LabelView"][];
@@ -419,7 +437,7 @@ export interface components {
recorder?: string | null;
recording_date?: string | null;
/** @description "draft" | "internal" (public is rejected — publish via the visibility endpoint). */
visibility: string;
visibility: components["schemas"]["Visibility"];
};
/**
* @description Inventory-minimum fields for update. Visibility is intentionally absent — it changes
@@ -488,9 +506,14 @@ export interface components {
id: string;
role: string;
};
/**
* @description Publication state of a catalogue record.
* @enum {string}
*/
Visibility: "draft" | "internal" | "public";
/** @description Desired visibility for a publish/unpublish request. */
VisibilityRequest: {
visibility: string;
visibility: components["schemas"]["Visibility"];
};
VocabularyView: {
id: string;