Change Updates

Do not miss any CleanControl Hub changes, ever again

Subscribe to the CleanControl Hub changelog to be up to date on recent changes.

RSS

Changelog

Last update:
cleancontrol API
10 structure changes including:
10 Modifications
Modified 10
GET /cleaning_runs
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /cleaning_runs/{cleaningRunId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • startingRoom property Modified
GET /cleaning_runs/{cleaningRunId}/nextRoom
  • Response
  • 200 response Modified
    • application/json content type Modified
      • occupied property Added
GET /rooms
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /rooms/{roomId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • occupied property Added
GET /tasks/{taskId}/rooms
  • Response
  • 200 response Modified
    • application/json content type Modified
PATCH /cleaning_runs/{cleaningRunId}/phase
  • Response
  • 200 response Modified
    • application/json content type Modified
      • startingRoom property Modified
POST /cleaning_runs
  • Body
  • application/json content type Modified
    • startingRoom property Modified
      • occupied property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • startingRoom property Modified
POST /rooms
  • Body
  • application/json content type Modified
    • occupied property Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • occupied property Added
PUT /rooms/{roomId}
  • Body
  • application/json content type Modified
    • occupied property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • occupied property Added
cleancontrol API
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
cleancontrol API
7 structure changes including:
1 Addition
6 Modifications
Modified 6 Breaking
GET /cleaning_runs
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /cleaning_runs/{cleaningRunId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cleaners property Modified
GET /users
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /users/{userId}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • username property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • email, password properties Added
POST /cleaning_runs
  • Body
  • application/json content type Modified
    • cleaners property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cleaners property Modified
PUT /users/{userId}
  • Body
  • application/json content type Modified
    • username property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
    • email, password properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • username property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • email, password properties Added
Added 1
POST /users
cleancontrol API
4 structure changes including:
4 Additions
Added 4
DELETE /users/{userId}
GET /users
GET /users/{userId}
PUT /users/{userId}
cleancontrol API
15 structure changes including:
7 Breaking changes
8 Additions
7 Removals
Removed 7 Breaking
DELETE /rooms/refills/{refillId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /rooms/tasks/{roomId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /rooms/refills
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /rooms/refills/{refillId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /rooms/tasks
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /rooms/tasks/{roomId}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /rooms/refills
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 8
DELETE /rooms/{roomId}/refills/{refillId}
DELETE /rooms/{roomId}/tasks/{taskId}
GET /cleaning_runs/{cleaningRunId}/nextRoom
GET /rooms/{roomId}/refills
GET /rooms/{roomId}/refills/{refillId}
GET /rooms/{roomId}/tasks
GET /rooms/{roomId}/tasks/{taskId}
POST /rooms/{roomId}/refills
cleancontrol API
14 structure changes including:
14 Modifications
Modified 14 Breaking
DELETE /cleaning_runs/{cleaningRunId}
  • Path went from /cleaning_runs/{id} to /cleaning_runs/{cleaningRunId} (same operationId)
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • cleaningRunId path parameter Added
DELETE /products/{productId}
  • Path went from /products/{id} to /products/{productId} (same operationId)
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • productId path parameter Added
DELETE /rooms/refills/{refillId}
  • Query
  • id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • refillId path parameter Added
DELETE /rooms/tasks/{roomId}
  • Path went from /rooms/tasks/{id} to /rooms/tasks/{roomId} (same operationId)
  • Query
  • roomId query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • roomId path parameter Added
DELETE /rooms/{roomId}
  • Query
  • id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • roomId path parameter Added
DELETE /tasks/{taskId}
  • Path went from /tasks/{id} to /tasks/{taskId} (same operationId)
  • Query
  • taskId query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • taskId path parameter Added
GET /cleaning_runs/{cleaningRunId}
  • Path went from /cleaning_runs/{id} to /cleaning_runs/{cleaningRunId} (same operationId)
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • cleaningRunId path parameter Added
GET /products/{productId}
  • Path went from /products/{id} to /products/{productId} (same operationId)
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • productId path parameter Added
GET /rooms/tasks/{roomId}
  • Path went from /rooms/tasks/{id} to /rooms/tasks/{roomId} (same operationId)
  • Query
  • roomId query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • roomId path parameter Added
GET /rooms/{roomId}
  • Query
  • id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • roomId path parameter Added
GET /tasks/{taskId}
  • Path went from /tasks/{id} to /tasks/{taskId} (same operationId)
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • id query parameter Added
PUT /products/{productId}
  • Path went from /products/{id} to /products/{productId} (same operationId)
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • productId path parameter Added
PUT /rooms/{roomId}
  • Query
  • id query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • roomId path parameter Added
PUT /tasks/{taskId}
  • Path went from /tasks/{id} to /tasks/{taskId} (same operationId)
  • Query
  • taskId query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Path
  • taskId path parameter Added
cleancontrol API
14 structure changes including:
5 Breaking changes
9 Modifications
5 Removals
Modified 9
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
      • cleaners property Modified
GET /products
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /products/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id property Modified
        • Full types went from string(uuid) to string(uuid) | null
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
POST /cleaning_runs
  • Body
  • application/json content type Modified
    • cleaners property Modified
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cleaners property Modified
POST /products
  • 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
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id property Modified
        • Full types went from string(uuid) to string(uuid) | null
PUT /products/{id}
  • 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
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id property Modified
        • Full types went from string(uuid) to string(uuid) | null
Removed 5 Breaking
DELETE /users/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /users/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /users
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /users/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
cleancontrol API
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
cleancontrol API
7 structure changes including:
7 Modifications
Modified 7 Breaking
DELETE /rooms/refills/{refillId}
  • Path went from /rooms/refills/{id} to /rooms/refills/{refillId} (same operationId)
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • id query parameter Added
DELETE /rooms/{roomId}
  • Path went from /rooms/{id} to /rooms/{roomId} (same operationId)
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • id query parameter Added
GET /rooms/refills
  • Response
  • 200 response Modified
    • application/json content type Modified
GET /rooms/refills/{refillId}
  • Path went from /rooms/refills/{id} to /rooms/refills/{refillId} (same operationId)
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id property Modified
        • Full types went from string(uuid) to string(uuid) | null
  • 404 response Added
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • refillId path parameter Added
  • Query
  • roomId query parameter Added
GET /rooms/{roomId}
  • Path went from /rooms/{id} to /rooms/{roomId} (same operationId)
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • id query parameter Added
POST /rooms/refills
  • Response
  • 200 response Modified
    • application/json content type Modified
      • id property Modified
        • Full types went from string(uuid) to string(uuid) | null
  • Query
  • roomId query parameter Added
PUT /rooms/{roomId}
  • Path went from /rooms/{id} to /rooms/{roomId} (same operationId)
  • Path
  • id path parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Query
  • id query parameter Added
cleancontrol API
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}
cleancontrol API
10 structure changes including:
10 Additions
Added 10
GET /confirmEmail
GET /manage/info
POST /forgotPassword
POST /login
POST /manage/2fa
POST /manage/info
POST /refresh
POST /register
POST /resendConfirmationEmail
POST /resetPassword