Change Updates

Do not miss any cleancontrol API changes, ever again

Subscribe to the cleancontrol API changelog to be up to date on recent changes.

RSS

Feb 27, 2024

main
v1
Compare

API structure has changed

22 structure changes including:
2 Breaking changes
1 Addition
19 Modifications
2 Removals
Modified 19 Breaking
PUT /tasks/{id}
  • Path
  • id path parameter Modified
    • Full types went from integer(int32) to string(uuid)
      Breaking
PUT /rooms/{id}
  • Path
  • id path parameter Modified
    • Full types went from integer(int32) to string(uuid)
      Breaking
  • Body
  • application/json content type Added
  • Response
  • 404 response Added
PUT /rooms/tasks/{id}
  • Path
  • id path parameter Modified
    • Full types went from integer(int32) to string(uuid)
      Breaking
PUT /products/{id}
  • Path
  • id path parameter Modified
    • Full types went from integer(int32) to string(uuid)
      Breaking
PUT /cleaning_runs/{id}
  • Path
  • id path parameter Modified
    • Full types went from integer(int32) to string(uuid)
      Breaking
POST /rooms/refills
  • Response
  • 200 response Modified
    • application/json content type Modified
      • room, refillTime properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • id property Added
POST /rooms
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 201, 409 responses Added
  • Body
  • application/json content type Added
GET /tasks/{id}
  • Path
  • id path parameter Modified
    • Full types went from integer(int32) to string(uuid)
      Breaking
GET /rooms/tasks/{id}
  • Path
  • id path parameter Modified
    • Full types went from integer(int32) to string(uuid)
      Breaking
GET /rooms/refills/{id}
  • Path
  • id path parameter Modified
    • Full types went from integer(int32) to string(uuid)
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • room, refillTime properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • id property Added
GET /rooms/refills
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /products/{id}
  • Path
  • id path parameter Modified
    • Full types went from integer(int32) to string(uuid)
      Breaking
GET /cleaning_runs/{id}
  • Path
  • id path parameter Modified
    • Full types went from integer(int32) to string(uuid)
      Breaking
DELETE /tasks/{id}
  • Path
  • id path parameter Modified
    • Full types went from integer(int32) to string(uuid)
      Breaking
DELETE /rooms/{id}
  • Path
  • id path parameter Modified
    • Full types went from integer(int32) to string(uuid)
      Breaking
  • Response
  • 404 response Added
DELETE /rooms/tasks/{id}
  • Path
  • id path parameter Modified
    • Full types went from integer(int32) to string(uuid)
      Breaking
DELETE /rooms/refills/{id}
  • Path
  • id path parameter Modified
    • Full types went from integer(int32) to string(uuid)
      Breaking
  • Response
  • 404 response Added
DELETE /products/{id}
  • Path
  • id path parameter Modified
    • Full types went from integer(int32) to string(uuid)
      Breaking
DELETE /cleaning_runs/{id}
  • Path
  • id path parameter Modified
    • Full types went from integer(int32) to string(uuid)
      Breaking
Removed 2 Breaking
GET /rooms/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /rooms/refills/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
GET /rooms/{id}