Change Updates

Do not miss any Class Manager API changes, ever again

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

RSS

Nov 29, 2023

dev
0.0.4-dev.115
Compare
0.0.4-dev.115

API structure has changed

13 structure changes including:
3 Breaking changes
1 Addition
9 Modifications
3 Removals
Modified 9 Breaking
DELETE /v1/staff/{id}
  • Response
  • 200 response Modified
    • application/json content type Added
GET /v1/accounts
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pagination property Modified
GET /v1/links/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • pagination property Modified
GET /v1/staff/
  • Path went from /v1/staff to /v1/staff/ (same operationId)
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data, pagination properties Modified
  • Query
  • search, page, pageSize, selectAll, where, sort query parameters Added
GET /v1/staff/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • verification_status property Modified
        • Full types went from string to string | null
      • jobTitle property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • job_title property Added
POST /v1/auth/login
  • Response
  • 200 response Modified
    • application/json content type Modified
      • user property Modified
POST /v1/auth/register
  • Response
  • 200 response Modified
    • application/json content type Modified
      • email property Modified
        • Full types went from string to object
          Breaking
POST /v1/staff/
  • Path went from /v1/staff to /v1/staff/ (same operationId)
  • Response
  • 200 response Modified
    • application/json content type Modified
      • verification_status property Modified
        • Full types went from string to string | null
      • jobTitle property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • job_title property Added
PUT /v1/staff/{id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • verification_status property Modified
        • Full types went from string to string | null
      • jobTitle property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • job_title property Added
Removed 3 Breaking
GET /v1/contacts
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /v1/contacts/{id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /v1/staff/{id}/invite
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
POST /v1/staff/{id}/invite