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

Apr 9, 2024

main
v1
Compare

API structure has changed

12 structure changes including:
1 Breaking change
5 Additions
6 Modifications
1 Removal
Modified 6 Breaking
DELETE /users/{userId}
  • Query
  • id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • userId path parameter Added
GET /cleaning_runs
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /tasks/{taskId}
  • Query
  • id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • taskId path parameter Added
GET /users/{userId}
  • Query
  • id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • userId path parameter Added
POST /cleaning_runs
  • Body
  • application/json content type Modified
    • id property Modified
      • Full types went from string(uuid) to string(uuid) | null
      • id property Modified
        • Full types went from string(uuid) to string(uuid) | null
    • date property Modified
      • Full types went from string(date-time) to string(date-time) | null
      • date property Modified
        • Full types went from string(date-time) to string(date-time) | null
    • phase property Added
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 201 response Added
PUT /users/{userId}
  • Query
  • id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • userId path parameter Added
Removed 1 Breaking
GET /cleaning_runs/{cleaningRunId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 5
GET /cleaning_runs/{cleaningRunId}
GET /tasks/{taskId}/rooms
GET /users/me
PATCH /cleaning_runs/{cleaningRunId}/phase
PUT /tasks/{taskId}/rooms