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 29, 2024

main
v1
Compare

API structure has changed

21 structure changes including:
3 Breaking changes
18 Modifications
3 Removals
Modified 18 Breaking
DELETE /cleaning_runs/{id}
  • Response
  • 200 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
DELETE /products/{id}
  • Response
  • 200 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
DELETE /rooms/tasks/{id}
  • Response
  • 200 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • roomId, taskId query parameters Added
DELETE /tasks/{id}
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • taskId query parameter Added
GET /cleaning_runs
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /cleaning_runs/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cleaningTeam property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • cleaners, cleanerIds, startingRoomId properties Added
GET /products
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /products/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • image property Added
GET /rooms/refills
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /rooms/refills/{refillId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • item property Modified
GET /rooms/tasks
  • Query
  • roomId query parameter Added
GET /rooms/tasks/{id}
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • taskId, roomId query parameters Added
POST /cleaning_runs
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cleaningTeam property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • cleaners, cleanerIds, startingRoomId properties Added
  • Body
  • application/json content type Added
POST /products
  • Response
  • 200 response Modified
    • application/json content type Modified
      • image property Added
  • Body
  • application/json content type Added
POST /rooms/refills
  • Response
  • 200 response Modified
    • application/json content type Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
POST /tasks
  • Body
  • application/json content type Added
PUT /products/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • image property Added
  • Body
  • application/json content type Added
PUT /tasks/{id}
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • taskId query parameter Added
  • Body
  • application/json content type Added
Removed 3 Breaking
POST /rooms/tasks
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /cleaning_runs/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /rooms/tasks/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking