spree_api 6.0.0 → 6.0.2

data/lib/typelizer/open_enums.rb

@@ -22,7 +22,7 @@ module Typelizer
     CLOSED_TYPE_NAMES = %w[CountryCode CurrencyCode LocaleCode WeightUnit DimensionUnit].freeze
 
     CLOSED_LIST_NAMES = %w[
-      ApiKeyType CaptureMethod CatalogAssignableType CatalogPriceSource ClaimResolution
+      AdminUserStatus ApiKeyType CaptureMethod CatalogAssignableType CatalogPriceSource ClaimResolution
       CollectionRuleMatchPolicy CollectionSortOrder CommissionKind CompanyInvitationStatus CompanyKind
       ConsentSource DataRequestKind DeliveryStatus DeliveryZoneMemberType DiscountKind DocumentNumberFormat
       EmailFont EmailTemplateKind FileUploadVisibility FulfillmentType MatchPolicy MediaType OptionTypeKind
@@ -34,6 +34,25 @@ module Typelizer
       TaxRemittance UnitSystem
     ].freeze
 
+    # Open lists whose values are suggestions rather than built-ins an
+    # extension adds to, described as such wherever the list is published.
+    DESCRIPTIONS = {
+      'TimeZone' => 'Common IANA time zones; any other IANA time zone identifier is accepted too.'
+    }.freeze
+
+    # @param name [String, nil] a list's `enum_type_name`
+    # @return [String, nil] what the list's values are, when they are not built-ins
+    def self.description(name)
+      DESCRIPTIONS[name]
+    end
+
+    # @param schema [Hash] the schema of any value in the list
+    # @param values [Array<String>] the values to suggest
+    # @return [Hash] a schema suggesting the values while accepting any other
+    def self.open_schema(schema, values)
+      { anyOf: [schema.merge(enum: values), schema] }
+    end
+
     # @param name [String, nil] a list's `enum_type_name`
     # @return [Boolean] whether the list is closed: no value outside it is valid
     def self.closed?(name)
@@ -63,7 +82,7 @@ module Typelizer
         return super unless property.enum_type_name && property.enum.is_a?(Array) && !property.multi
         return super if OpenEnums.closed?(property.enum_type_name)
 
-        open = { anyOf: [{ type: :string, enum: property.enum.compact }, { type: :string }] }
+        open = OpenEnums.open_schema({ type: :string }, property.enum.compact)
         # OpenAPI 3.0 ignores `nullable` beside `anyOf`, which is where
         # Typelizer puts it, so the free-string branch carries it instead.
         if property.nullable && !v31?(openapi_version)
@@ -72,7 +91,7 @@ module Typelizer
           apply_nullable(open, property, openapi_version: openapi_version)
         end
         apply_metadata(open, property)
-        open[:description] ||= OPEN_ENUM_DESCRIPTION
+        open[:description] ||= OpenEnums.description(property.enum_type_name) || OPEN_ENUM_DESCRIPTION
         open
       end
     end