Skip to content

Release v2.2024.08.16.6
Compare
Choose a tag to compare
@kritsel kritsel released this 16 Aug 14:12
· 170 commits to main since this release
v2.2024.08.16.6
65ea3ae

All changes are relative to the previous released version.

Note: status identifiers like 'new' and 'unchanged' does not apply to the API itself; it only applies to this specification of the API.

General

  • using specific types for fields like HomeID, ZoneID etc. to ensure consistency in the various places where these are used
  • changed multipe string fields into enums
  • various schema definition refactorings to re-use repeating data structures as much as possible

Paths covered

user

  • GET /me: unchanged
  • GET /users: unchanged

mobile device

  • GET /homes/{homeId}/mobileDevices: unchanged
  • GET /homes/{homeId}/mobileDevices/{mobileDeviceId}: unchanged
  • DELETE /homes/{homeId}/mobileDevices/{mobileDeviceId}: unchanged
  • GET /homes/{homeId}/mobileDevices/{mobileDeviceId}/settings: new
  • PUT /homes/{homeId}/mobileDevices/{mobileDeviceId}/settings: new

home

  • GET /homes: unchanged
  • GET /homes/{homeId}: unchanged
  • GET /homes/{homeId}/airComfort: unchanged
  • PUT /homes/{homeId}/details: new`
  • GET /homes/{homeId}/heatingCircuits: new
  • GET /homes/{homeId}/heatingSystem: unchanged
  • PUT /homes/{homeId}/heatingSystem/boiler: new
  • PUT /homes/{homeId}/heatingSystem/underfloorHeating: new
  • GET /homes/{homeId}/incidentDetection: new
  • PUT /homes/{homeId}/incidentDetection: new
  • POST /homes/{homeId}/overlay: use a specific type to update an Overlay (which only contains the properties you can actually set)
  • DELETE /homes/{homeId}/overlay: unchanged
  • GET /homes/{homeId}/state: unchanged
  • GET /homes/{homeId}/weather: unchanged

home control

  • POST /homes/{homeId}/overlay: unchanged
  • PUT /homes/{homeId}/overlay: unchanged
  • DELETE /homes/{homeId}/overlay: unchanged

zone

  • GET /homes/{homeId}/zones: unchanged
  • GET /homes/{homeId}/zones/{zoneId}: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/capabilities: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/state: unchanged

zone control

  • GET /homes/{homeId}/zones/{zoneId}/defaultOverlay: new
  • PUT /homes/{homeId}/zones/{zoneId}/defaultOverlay: new
  • GET /homes/{homeId}/zones/{zoneId}/earlyStart: unchanged
  • PUT /homes/{homeId}/zones/{zoneId}/earlyStart: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/overlay: unchanged
  • PUT /homes/{homeId}/zones/{zoneId}/overlay: use a specific type to update an Overlay (which only contains the properties you can actually set)
  • DELETE /homes/{homeId}/zones/{zoneId}/overlay: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/schedule/awayConfiguration: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/schedule/activeTimetable: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/schedule/timetables: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/schedule/timetables/{timetableTypeId}: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/schedule/timetables/{timetableTypeId}/blocks: unchanged
  • GET /homes/{homeId}/zones/{zoneId}/schedule/timetables/{timetableTypeId}/blocks/{dayType}: unchanged
  • PUT /homes/{homeId}/zones/{zoneId}/schedule/timetables/{timetableTypeId}/blocks/{dayType}: new

device

  • GET /homes/{homeId}/devices: unchanged
  • POST/homes/{homeId}/identify: unchanged
  • GET /homes/{homeId}/deviceList: unchanged

report

  • GET /homes/{homeId}/zones/{zoneId}/dayReport: fixed errors in the defined schema
Assets 2
Loading