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

Mar 1, 2024

main
v1
Compare

API structure has changed

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