From f15a7d6a1cebee75014cca251e7020d97513da58 Mon Sep 17 00:00:00 2001 From: Stephen von Takach Date: Thu, 19 Nov 2026 13:26:23 +1100 Subject: [PATCH 1/2] fix: describe serialized model fields in OpenAPI --- spec/openapi_model_fields_spec.cr | 50 +++++++++++++++++++++++++++++++ spec/user_spec.cr | 21 +++++++++++++ src/placeos-models/driver.cr | 3 +- src/placeos-models/guest.cr | 2 +- src/placeos-models/user.cr | 2 +- src/placeos-models/user_jwt.cr | 4 +++ 6 files changed, 79 insertions(+), 3 deletions(-) create mode 100644 spec/openapi_model_fields_spec.cr diff --git a/spec/openapi_model_fields_spec.cr b/spec/openapi_model_fields_spec.cr new file mode 100644 index 00000000..2a2b7256 --- /dev/null +++ b/spec/openapi_model_fields_spec.cr @@ -0,0 +1,50 @@ +require "json-schema" +require "spec" +require "../src/placeos-models" + +module PlaceOS::Model + describe "Model OpenAPI field types" do + it "describes serialized scope strings in JWTs and API keys" do + scopes = [UserJWT::Scope::PUBLIC, UserJWT::Scope.new("custom", UserJWT::Scope::Access::Read)] + JSON.parse(scopes.to_json).should eq JSON.parse(%(["public","custom.Read"])) + + refs = JSON::Schema::Definitions.new("#/components/schemas/") + jwt_scope = JSON.parse(UserJWT.json_schema(refs: refs).to_json)["properties"]["scope"] + key_scopes = JSON.parse(ApiKey.json_schema(true, refs).to_json)["properties"]["scopes"] + string_schema = JSON.parse(%({"type":"string"})) + jwt_scope["items"].should eq string_schema + key_scopes["items"].should eq string_schema + end + + it "describes metadata entries for both User metadata views" do + refs = JSON::Schema::Definitions.new("#/components/schemas/") + {User::AdminMetadataResponse, User::PublicMetadataResponse}.each do |response| + properties = JSON.parse(response.json_schema(true, refs).to_json)["properties"] + metadata = properties["associated_metadata"] + metadata["additionalProperties"]["$ref"].should eq "#/components/schemas/PlaceOS.Model.Metadata.Interface" + end + end + + it "serializes Driver schema objects as JSON strings and preserves other JSON values" do + driver = Driver.new + driver.json_schema = JSON.parse(%({"type":"object"})) + JSON.parse(driver.to_json)["json_schema"].as_s.should eq %({"type":"object"}) + + {"[]", "true", "7", %("schema"), "null"}.each do |value| + driver.json_schema = JSON.parse(value) + JSON.parse(driver.to_json)["json_schema"].should eq JSON.parse(value) + end + end + + it "serializes Guest event metadata as an object" do + metadata = EventMetadata.new(event_id: "event-1") + metadata.render_linked_bookings = false + guest = Guest.new(email: "visitor@example.com") + guest.event_metadata = metadata.to_json + + JSON.parse(guest.to_json)["event_metadata"].should eq JSON.parse(metadata.to_json) + guest.event_metadata = nil + JSON.parse(guest.to_json)["event_metadata"]?.should be_nil + end + end +end diff --git a/spec/user_spec.cr b/spec/user_spec.cr index d5ee66dc..074c2de2 100644 --- a/spec/user_spec.cr +++ b/spec/user_spec.cr @@ -471,6 +471,27 @@ module PlaceOS::Model end end + it "preserves the metadata payload in typed response views" do + user = Generator.user.save! + empty_payload = JSON.parse(user.to_public_metadata_struct.to_json) + empty_payload["associated_metadata"].as_h.should be_empty + + metadata = Generator.metadata(name: "profile", parent: user, modifier: user) + metadata.details = JSON.parse(%([null,{"active":true}])) + metadata.save! + + {user.to_admin_metadata_struct, user.to_public_metadata_struct}.each do |response| + payload = JSON.parse(response.to_json) + payload["associated_metadata"].as_h.keys.should eq ["profile"] + payload["associated_metadata"]["profile"]["details"].should eq metadata.details + + payload.as_h["extra"] = JSON.parse(%({"value":null})) + parsed = response.class.from_json(payload.to_json) + JSON.parse(parsed.to_json)["associated_metadata"].should eq payload["associated_metadata"] + JSON.parse(parsed.to_json)["extra"].should eq payload["extra"] + end + end + describe "#subsystem_access" do Spec.before_each do History.clear diff --git a/src/placeos-models/driver.cr b/src/placeos-models/driver.cr index 0ba4bfb0..80ebb282 100644 --- a/src/placeos-models/driver.cr +++ b/src/placeos-models/driver.cr @@ -22,7 +22,8 @@ module PlaceOS::Model attribute name : String, sanitize: :text, es_subfield: "keyword" attribute description : String = "", sanitize: :common - attribute json_schema : JSON::Any = JSON::Any.new({} of String => JSON::Any), converter: JSON::Any::StringConverter, es_type: "text" + attribute json_schema : JSON::Any = JSON::Any.new({} of String => JSON::Any), converter: JSON::Any::StringConverter, es_type: "text", + description: "Schema data. JSON objects are encoded as JSON strings in responses." attribute default_uri : String? attribute default_port : Int32? diff --git a/src/placeos-models/guest.cr b/src/placeos-models/guest.cr index b1072f3c..d0ffd9eb 100644 --- a/src/placeos-models/guest.cr +++ b/src/placeos-models/guest.cr @@ -24,7 +24,7 @@ module PlaceOS::Model attribute visit_expected : Bool?, persistence: false, show: true, ignore_deserialize: true attribute booking : Booking?, persistence: false, show: true, ignore_deserialize: true attribute event : PlaceCalendar::Event?, persistence: false, show: true, ignore_deserialize: true - attribute event_metadata : String?, persistence: false, converter: String::RawConverter, show: true, ignore_deserialize: true + attribute event_metadata : String?, persistence: false, converter: String::RawConverter, type: "object", show: true, ignore_deserialize: true attribute booking_rep : Booking? = nil, persistence: false, show: true, json_key: "booking", ignore_deserialize: true diff --git a/src/placeos-models/user.cr b/src/placeos-models/user.cr index 3e02983c..c7e2f553 100644 --- a/src/placeos-models/user.cr +++ b/src/placeos-models/user.cr @@ -314,7 +314,7 @@ module PlaceOS::Model define_to_json :admin, only: ADMIN_DATA, methods: :id define_to_json :admin_metadata, only: ADMIN_DATA, methods: [:id, :associated_metadata, :subsystem_access] - def associated_metadata + def associated_metadata : Hash(String, Model::Metadata::Interface) Model::Metadata.build_metadata(self) end diff --git a/src/placeos-models/user_jwt.cr b/src/placeos-models/user_jwt.cr index feb2fc90..2f956ba0 100644 --- a/src/placeos-models/user_jwt.cr +++ b/src/placeos-models/user_jwt.cr @@ -133,6 +133,10 @@ module PlaceOS::Model def to_json(builder : JSON::Builder) builder.string(to_s) end + + def self.json_schema(_openapi : Bool? = nil) + {type: "string"} + end end struct Metadata From 8e5781a72fadd2ecca32dd571da069cd473c6557 Mon Sep 17 00:00:00 2001 From: Stephen von Takach Date: Thu, 19 Nov 2026 13:33:08 +1100 Subject: [PATCH 2/2] test: avoid collisions between signage provider fixtures --- spec/generator.cr | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/generator.cr b/spec/generator.cr index fb81f068..df664bea 100644 --- a/spec/generator.cr +++ b/spec/generator.cr @@ -754,7 +754,7 @@ module PlaceOS::Model text_model : String? = nil, ) row = SignageAIProvider.new - row.name = name || Faker::Hacker.noun + row.name = name || "provider-#{UUID.random}" row.provider = provider row.authority_id = authority.try(&.id.as(String)) row.credentials = credentials