Skip to content
HotelPlatform.io

Configuration Changelog

1.8.0

Rolls the published reference forward from 1.0.11 and bundles every change made since then (1.0.12 to 1.8.0). Most of the generated diff below comes from a schema refactor in 1.1.0: the flat oneOf was replaced by a discriminated base type. That refactor does not change the request envelope (apiVersion, kind, meta and spec were already required), and every existing kind is kept. The changes that do affect the wire format are listed below.

Breaking changes

  • PMS kinds: spec.mapId has been removed. The new optional spec.paymentMapId references a paymentMethodMap configuration, so it has a different meaning. Anything that sets mapId on a PMS configuration must be migrated.
  • checkin24-7 and planyo: spec.hotelId, spec.startTime and spec.endTime are now required.
  • kitTerminal and timTerminal: spec.terminalId is now required.
  • Each kind's kind value is documented in camelCase (e.g. dormaKaba, hs3), which matches the discriminator mapping. Earlier versions of the reference listed PascalCase values per kind, which contradicted that mapping.
  • All error responses use RFC 9457 ProblemDetails (application/problem+json).

New kinds

  • paymentMethodMap maps raw payment-brand strings to the universal PaymentMethod enum and to an adapter-specific code.
  • serviceZoneMap resolves booked services to access-control door zones. PMS kinds (except casablanca and sihot) reference it via the optional spec.serviceZoneMapId.
  • conditionFilter, adyen, ohip and casablanca.

Changed

  • PMS kinds have an optional spec.hotelId (required for checkin24-7 and planyo). checkin24-7 and planyo also have an optional spec.webhookUrl.
  • Payment terminals: ZVT, TIM and KIT have new connection fields (currency, password, debug, debugLevel).
  • tesaApi has an optional spec.pinLength.
  • Secrets are declared write-only.
  • GET /configurations accepts the filter and page query parameters.
  • Single-resource responses include links.self.
  • DELETE /configurations/{configurationId} documents 404 and 409.
  • PUT /configurations/{configurationId} replaces the whole configuration; it does not merge.

Changes since 1.0.11. Operations: 0 added, 5 changed, 0 removed · 16 breaking changes

Detected breaking changes

16 breaking changes in 4 operations
  • GET /configurations
    • the 'data/items/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response's property type/format changed from ''/'' to 'object'/'' for status '200'
  • GET /configurations/{configurationId}
    • the 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response's property type/format changed from ''/'' to 'object'/'' for status '200'
  • POST /configurations
    • added the new required request property 'apiVersion'
    • added the new required request property 'kind'
    • added the new required request property 'meta'
    • added the new required request property 'spec'
    • removed '#/components/schemas/AccessControlDefaultConfiguration, #/components/schemas/AccessControlUnitMapConfiguration, #/components/schemas/AccessControlFaker, #/components/schemas/ControllerConfiguration, #/components/schemas/DormaKabaConfiguration, #/components/schemas/HaefeleConfiguration, #/components/schemas/MesserschmittConfiguration, #/components/schemas/MesserschmittEntryApiConfiguration, #/components/schemas/MesserschmittIfcConfiguration, #/components/schemas/OnityConfiguration, #/components/schemas/OsAccessApiConfiguration, #/components/schemas/OsAccessIfcConfiguration, #/components/schemas/SaltoSpaceStandardConfiguration, #/components/schemas/TesaApiConfiguration, #/components/schemas/TesaPmsRouterConfiguration, #/components/schemas/VingCardVisionConfiguration, #/components/schemas/VisionlineConfiguration, #/components/schemas/AccessControlUnitMapConfiguration, #/components/schemas/CustomPayment, #/components/schemas/PaymentFaker, #/components/schemas/KitTerminal, #/components/schemas/TimTerminal, #/components/schemas/ZvtTerminal, #/components/schemas/3RPmsConfiguration, #/components/schemas/Checkin24-7Configuration, #/components/schemas/HS3Configuration, #/components/schemas/MewsConfiguration, #/components/schemas/PlanyoConfiguration, #/components/schemas/PmsFaker, #/components/schemas/SihotConfiguration' from the request body 'oneOf' list
    • the request's body type/format changed from ''/'' to 'object'/''
    • the 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response's property type/format changed from ''/'' to 'object'/'' for status '201'
  • PUT /configurations/{configurationId}
    • added the new required request property 'apiVersion'
    • added the new required request property 'kind'
    • added the new required request property 'meta'
    • added the new required request property 'spec'
    • removed '#/components/schemas/AccessControlDefaultConfiguration, #/components/schemas/AccessControlUnitMapConfiguration, #/components/schemas/AccessControlFaker, #/components/schemas/ControllerConfiguration, #/components/schemas/DormaKabaConfiguration, #/components/schemas/HaefeleConfiguration, #/components/schemas/MesserschmittConfiguration, #/components/schemas/MesserschmittEntryApiConfiguration, #/components/schemas/MesserschmittIfcConfiguration, #/components/schemas/OnityConfiguration, #/components/schemas/OsAccessApiConfiguration, #/components/schemas/OsAccessIfcConfiguration, #/components/schemas/SaltoSpaceStandardConfiguration, #/components/schemas/TesaApiConfiguration, #/components/schemas/TesaPmsRouterConfiguration, #/components/schemas/VingCardVisionConfiguration, #/components/schemas/VisionlineConfiguration, #/components/schemas/AccessControlUnitMapConfiguration, #/components/schemas/CustomPayment, #/components/schemas/PaymentFaker, #/components/schemas/KitTerminal, #/components/schemas/TimTerminal, #/components/schemas/ZvtTerminal, #/components/schemas/3RPmsConfiguration, #/components/schemas/Checkin24-7Configuration, #/components/schemas/HS3Configuration, #/components/schemas/MewsConfiguration, #/components/schemas/PlanyoConfiguration, #/components/schemas/PmsFaker, #/components/schemas/SihotConfiguration' from the request body 'oneOf' list
    • the request's body type/format changed from ''/'' to 'object'/''
    • the 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response's property type/format changed from ''/'' to 'object'/'' for status '200'

Operations

  • DELETE /configurations/{configurationId} changed
  • GET /configurations changed
  • GET /configurations/{configurationId} changed
  • POST /configurations changed
  • PUT /configurations/{configurationId} changed
All 246 changes in detail
  • DELETE /configurations/{configurationId}
    • added the non-success response with the status '404'
    • added the non-success response with the status '409'
  • GET /configurations
    • added the new optional 'query' request parameter 'filter'
    • added the new optional 'query' request parameter 'page'
    • added the non-success response with the status '400'
    • added the non-success response with the status '500'
    • added the optional property 'data/items/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/type' to the response with the '200' status
    • added 'adyen, ohip, conditionFilter, serviceZoneMap, paymentMethodMap, casablanca' discriminator mapping keys to the 'data/items/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response property for the response status '200'
    • mapped value for discriminator key '3RPms' changed from '#/components/schemas/3RPmsConfiguration' to '#/components/schemas/3RPms' for 'data/items/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response property for the response status '200' (and 21 more of response-property-discriminator-mapping-changed)
    • removed '#/components/schemas/AccessControlDefaultConfiguration, #/components/schemas/AccessControlUnitMapConfiguration, #/components/schemas/AccessControlFaker, #/components/schemas/ControllerConfiguration, #/components/schemas/DormaKabaConfiguration, #/components/schemas/HaefeleConfiguration, #/components/schemas/MesserschmittConfiguration, #/components/schemas/MesserschmittEntryApiConfiguration, #/components/schemas/MesserschmittIfcConfiguration, #/components/schemas/OnityConfiguration, #/components/schemas/OsAccessApiConfiguration, #/components/schemas/OsAccessIfcConfiguration, #/components/schemas/SaltoSpaceStandardConfiguration, #/components/schemas/TesaApiConfiguration, #/components/schemas/TesaPmsRouterConfiguration, #/components/schemas/VingCardVisionConfiguration, #/components/schemas/VisionlineConfiguration, #/components/schemas/AccessControlUnitMapConfiguration, #/components/schemas/CustomPayment, #/components/schemas/PaymentFaker, #/components/schemas/KitTerminal, #/components/schemas/TimTerminal, #/components/schemas/ZvtTerminal, #/components/schemas/3RPmsConfiguration, #/components/schemas/Checkin24-7Configuration, #/components/schemas/HS3Configuration, #/components/schemas/MewsConfiguration, #/components/schemas/PlanyoConfiguration, #/components/schemas/PmsFaker, #/components/schemas/SihotConfiguration' from the 'data/items/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response property 'oneOf' list for the response status '200'
    • breaking: the 'data/items/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response's property type/format changed from ''/'' to 'object'/'' for status '200'
    • added the required property 'data/items/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/apiVersion' to the response with the '200' status (and 3 more of response-required-property-added)
  • GET /configurations/{configurationId}
    • added the non-success response with the status '404'
    • added the non-success response with the status '500'
    • added the optional property 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/type' to the response with the '200' status
    • added the optional property 'links' to the response with the '200' status
    • added 'casablanca, adyen, conditionFilter, ohip, paymentMethodMap, serviceZoneMap' discriminator mapping keys to the 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response property for the response status '200'
    • mapped value for discriminator key '3RPms' changed from '#/components/schemas/3RPmsConfiguration' to '#/components/schemas/3RPms' for 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response property for the response status '200' (and 21 more of response-property-discriminator-mapping-changed)
    • removed '#/components/schemas/AccessControlDefaultConfiguration, #/components/schemas/AccessControlUnitMapConfiguration, #/components/schemas/AccessControlFaker, #/components/schemas/ControllerConfiguration, #/components/schemas/DormaKabaConfiguration, #/components/schemas/HaefeleConfiguration, #/components/schemas/MesserschmittConfiguration, #/components/schemas/MesserschmittEntryApiConfiguration, #/components/schemas/MesserschmittIfcConfiguration, #/components/schemas/OnityConfiguration, #/components/schemas/OsAccessApiConfiguration, #/components/schemas/OsAccessIfcConfiguration, #/components/schemas/SaltoSpaceStandardConfiguration, #/components/schemas/TesaApiConfiguration, #/components/schemas/TesaPmsRouterConfiguration, #/components/schemas/VingCardVisionConfiguration, #/components/schemas/VisionlineConfiguration, #/components/schemas/AccessControlUnitMapConfiguration, #/components/schemas/CustomPayment, #/components/schemas/PaymentFaker, #/components/schemas/KitTerminal, #/components/schemas/TimTerminal, #/components/schemas/ZvtTerminal, #/components/schemas/3RPmsConfiguration, #/components/schemas/Checkin24-7Configuration, #/components/schemas/HS3Configuration, #/components/schemas/MewsConfiguration, #/components/schemas/PlanyoConfiguration, #/components/schemas/PmsFaker, #/components/schemas/SihotConfiguration' from the 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response property 'oneOf' list for the response status '200'
    • breaking: the 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response's property type/format changed from ''/'' to 'object'/'' for status '200'
    • added the required property 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/apiVersion' to the response with the '200' status (and 3 more of response-required-property-added)
  • POST /configurations
    • added the new optional request property 'type'
    • breaking: added the new required request property 'apiVersion' (and 3 more of new-required-request-property)
    • added 'casablanca, adyen, conditionFilter, ohip, paymentMethodMap, serviceZoneMap' mapping keys to the request discriminator
    • mapped value for key '3RPms' changed from '#/components/schemas/3RPmsConfiguration' to '#/components/schemas/3RPms' from the request discriminator (and 21 more of request-body-discriminator-mapping-changed)
    • breaking: removed '#/components/schemas/AccessControlDefaultConfiguration, #/components/schemas/AccessControlUnitMapConfiguration, #/components/schemas/AccessControlFaker, #/components/schemas/ControllerConfiguration, #/components/schemas/DormaKabaConfiguration, #/components/schemas/HaefeleConfiguration, #/components/schemas/MesserschmittConfiguration, #/components/schemas/MesserschmittEntryApiConfiguration, #/components/schemas/MesserschmittIfcConfiguration, #/components/schemas/OnityConfiguration, #/components/schemas/OsAccessApiConfiguration, #/components/schemas/OsAccessIfcConfiguration, #/components/schemas/SaltoSpaceStandardConfiguration, #/components/schemas/TesaApiConfiguration, #/components/schemas/TesaPmsRouterConfiguration, #/components/schemas/VingCardVisionConfiguration, #/components/schemas/VisionlineConfiguration, #/components/schemas/AccessControlUnitMapConfiguration, #/components/schemas/CustomPayment, #/components/schemas/PaymentFaker, #/components/schemas/KitTerminal, #/components/schemas/TimTerminal, #/components/schemas/ZvtTerminal, #/components/schemas/3RPmsConfiguration, #/components/schemas/Checkin24-7Configuration, #/components/schemas/HS3Configuration, #/components/schemas/MewsConfiguration, #/components/schemas/PlanyoConfiguration, #/components/schemas/PmsFaker, #/components/schemas/SihotConfiguration' from the request body 'oneOf' list
    • breaking: the request's body type/format changed from ''/'' to 'object'/''
    • added the non-success response with the status '400'
    • added the non-success response with the status '422'
    • added the non-success response with the status '500'
    • added the optional property 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/type' to the response with the '201' status
    • added the optional property 'links' to the response with the '201' status
    • added 'ohip, conditionFilter, serviceZoneMap, paymentMethodMap, casablanca, adyen' discriminator mapping keys to the 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response property for the response status '201'
    • mapped value for discriminator key '3RPms' changed from '#/components/schemas/3RPmsConfiguration' to '#/components/schemas/3RPms' for 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response property for the response status '201' (and 21 more of response-property-discriminator-mapping-changed)
    • removed '#/components/schemas/AccessControlDefaultConfiguration, #/components/schemas/AccessControlUnitMapConfiguration, #/components/schemas/AccessControlFaker, #/components/schemas/ControllerConfiguration, #/components/schemas/DormaKabaConfiguration, #/components/schemas/HaefeleConfiguration, #/components/schemas/MesserschmittConfiguration, #/components/schemas/MesserschmittEntryApiConfiguration, #/components/schemas/MesserschmittIfcConfiguration, #/components/schemas/OnityConfiguration, #/components/schemas/OsAccessApiConfiguration, #/components/schemas/OsAccessIfcConfiguration, #/components/schemas/SaltoSpaceStandardConfiguration, #/components/schemas/TesaApiConfiguration, #/components/schemas/TesaPmsRouterConfiguration, #/components/schemas/VingCardVisionConfiguration, #/components/schemas/VisionlineConfiguration, #/components/schemas/AccessControlUnitMapConfiguration, #/components/schemas/CustomPayment, #/components/schemas/PaymentFaker, #/components/schemas/KitTerminal, #/components/schemas/TimTerminal, #/components/schemas/ZvtTerminal, #/components/schemas/3RPmsConfiguration, #/components/schemas/Checkin24-7Configuration, #/components/schemas/HS3Configuration, #/components/schemas/MewsConfiguration, #/components/schemas/PlanyoConfiguration, #/components/schemas/PmsFaker, #/components/schemas/SihotConfiguration' from the 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response property 'oneOf' list for the response status '201'
    • breaking: the 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response's property type/format changed from ''/'' to 'object'/'' for status '201'
    • added the required property 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/apiVersion' to the response with the '201' status (and 3 more of response-required-property-added)
  • PUT /configurations/{configurationId}
    • added the new optional request property 'type'
    • breaking: added the new required request property 'apiVersion' (and 3 more of new-required-request-property)
    • added 'paymentMethodMap, serviceZoneMap, casablanca, adyen, ohip, conditionFilter' mapping keys to the request discriminator
    • mapped value for key '3RPms' changed from '#/components/schemas/3RPmsConfiguration' to '#/components/schemas/3RPms' from the request discriminator (and 21 more of request-body-discriminator-mapping-changed)
    • breaking: removed '#/components/schemas/AccessControlDefaultConfiguration, #/components/schemas/AccessControlUnitMapConfiguration, #/components/schemas/AccessControlFaker, #/components/schemas/ControllerConfiguration, #/components/schemas/DormaKabaConfiguration, #/components/schemas/HaefeleConfiguration, #/components/schemas/MesserschmittConfiguration, #/components/schemas/MesserschmittEntryApiConfiguration, #/components/schemas/MesserschmittIfcConfiguration, #/components/schemas/OnityConfiguration, #/components/schemas/OsAccessApiConfiguration, #/components/schemas/OsAccessIfcConfiguration, #/components/schemas/SaltoSpaceStandardConfiguration, #/components/schemas/TesaApiConfiguration, #/components/schemas/TesaPmsRouterConfiguration, #/components/schemas/VingCardVisionConfiguration, #/components/schemas/VisionlineConfiguration, #/components/schemas/AccessControlUnitMapConfiguration, #/components/schemas/CustomPayment, #/components/schemas/PaymentFaker, #/components/schemas/KitTerminal, #/components/schemas/TimTerminal, #/components/schemas/ZvtTerminal, #/components/schemas/3RPmsConfiguration, #/components/schemas/Checkin24-7Configuration, #/components/schemas/HS3Configuration, #/components/schemas/MewsConfiguration, #/components/schemas/PlanyoConfiguration, #/components/schemas/PmsFaker, #/components/schemas/SihotConfiguration' from the request body 'oneOf' list
    • breaking: the request's body type/format changed from ''/'' to 'object'/''
    • added the non-success response with the status '400' (and 3 more of response-non-success-status-added)
    • added the optional property 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/type' to the response with the '200' status
    • added the optional property 'links' to the response with the '200' status
    • added 'casablanca, adyen, ohip, conditionFilter, paymentMethodMap, serviceZoneMap' discriminator mapping keys to the 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response property for the response status '200'
    • mapped value for discriminator key '3RPms' changed from '#/components/schemas/3RPmsConfiguration' to '#/components/schemas/3RPms' for 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response property for the response status '200' (and 21 more of response-property-discriminator-mapping-changed)
    • removed '#/components/schemas/AccessControlDefaultConfiguration, #/components/schemas/AccessControlUnitMapConfiguration, #/components/schemas/AccessControlFaker, #/components/schemas/ControllerConfiguration, #/components/schemas/DormaKabaConfiguration, #/components/schemas/HaefeleConfiguration, #/components/schemas/MesserschmittConfiguration, #/components/schemas/MesserschmittEntryApiConfiguration, #/components/schemas/MesserschmittIfcConfiguration, #/components/schemas/OnityConfiguration, #/components/schemas/OsAccessApiConfiguration, #/components/schemas/OsAccessIfcConfiguration, #/components/schemas/SaltoSpaceStandardConfiguration, #/components/schemas/TesaApiConfiguration, #/components/schemas/TesaPmsRouterConfiguration, #/components/schemas/VingCardVisionConfiguration, #/components/schemas/VisionlineConfiguration, #/components/schemas/AccessControlUnitMapConfiguration, #/components/schemas/CustomPayment, #/components/schemas/PaymentFaker, #/components/schemas/KitTerminal, #/components/schemas/TimTerminal, #/components/schemas/ZvtTerminal, #/components/schemas/3RPmsConfiguration, #/components/schemas/Checkin24-7Configuration, #/components/schemas/HS3Configuration, #/components/schemas/MewsConfiguration, #/components/schemas/PlanyoConfiguration, #/components/schemas/PmsFaker, #/components/schemas/SihotConfiguration' from the 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response property 'oneOf' list for the response status '200'
    • breaking: the 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/' response's property type/format changed from ''/'' to 'object'/'' for status '200'
    • added the required property 'data/allOf[subschema #2: All Configurations -> subschema #2: Configuration]/apiVersion' to the response with the '200' status (and 3 more of response-required-property-added)
  • null null
    • removed the schema '3RPmsConfiguration' (and 47 more of api-schema-removed)

1.0.11

Models Updated: 1 model changed

  • AccessControlConfiguration changed

1.0.10

Operations: 2 operations changed

specification details:

  • /tags/1/description, /info/version changed

PUT /configurations/{configurationId}:

  • request:
    • body application/vnd.api+json:
      • property : changed POST /configurations:
  • request:
    • body application/vnd.api+json:
      • property : changed

1.0.9

Operations: 4 operations changed

specification details:

  • /tags/1/description, /info/version, /info/termsOfService, /info/license/url, /info/contact/url changed

PUT /configurations/{configurationId}:

  • request:

    • body application/vnd.api+json:
      • property : changed
      • property /schema/oneOf/6/properties/apiVersion: changed
      • property /schema/oneOf/5/properties/apiVersion: changed
      • property /schema/oneOf/4/properties/apiVersion: changed
      • property /schema/oneOf/3/properties/apiVersion: changed
      • property /schema/oneOf/2/properties/apiVersion: changed
      • property /schema/oneOf/1/properties/apiVersion: changed
      • property /schema/oneOf/0/properties/apiVersion: changed

  • response 200:

    • body application/vnd.api+json:
      • property /schema/properties/data: changed
      • property /schema/properties/data/properties/id: changed
      • property /schema/properties/data/properties/createdAt: changed
      • property /schema/properties/data/properties/updatedAt: changed GET /configurations/{configurationId}:

  • response 200:

    • body application/vnd.api+json:
      • property /schema/properties/data/properties/updatedAt: changed
      • property /schema/properties/data/properties/createdAt: changed GET /configurations:

  • response 200:

    • body application/vnd.api+json:
      • property /schema/properties/data/items/properties/updatedAt: changed
      • property /schema/properties/data/items/properties/createdAt: changed POST /configurations:

  • /description changed

  • header parameter Authorization: added

  • request:

    • body application/vnd.api+json:
      • property : changed
      • property /schema/oneOf/6/properties/apiVersion: changed
      • property /schema/oneOf/5/properties/apiVersion: changed
      • property /schema/oneOf/4/properties/apiVersion: changed
      • property /schema/oneOf/3/properties/apiVersion: changed
      • property /schema/oneOf/2/properties/apiVersion: changed
      • property /schema/oneOf/1/properties/apiVersion: changed
      • property /schema/oneOf/0/properties/apiVersion: changed

  • response 201:

    • /description changed

    • body application/vnd.api+json:

      • property /schema/properties/data: changed
      • property /schema/properties/data/properties/id: changed
      • property /schema/properties/data/properties/createdAt: changed
      • property /schema/properties/data/properties/updatedAt: changed

1.0.8

Initial public release 1.0.8