Change Updates

Do not miss any Sync API changes, ever again

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

RSS

21 days ago

main
1.0.0
Compare
1.0.0

API structure has changed

Next change
23 structure changes including:
23 Modifications
Modified 23 Breaking
GET /v1/Services
  • Response
  • 200 response Modified
    • application/json content type Modified
      • services property Modified
        • reachability_debouncing_window property Modified
          • Type went from integer | null to integer
            Breaking
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ServiceSid}/Documents
  • Response
  • 200 response Modified
    • application/json content type Modified
      • documents property Modified
        • data property Modified
          • Type is now object | null
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ServiceSid}/Documents/{DocumentSid}/Permissions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ServiceSid}/Documents/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • Type is now object | null
GET /v1/Services/{ServiceSid}/Lists
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ServiceSid}/Lists/{ListSid}/Items
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • index property Modified
          • Type went from integer | null to integer
            Breaking
        • data property Modified
          • Type is now object | null
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index property Modified
        • Type went from integer | null to integer
          Breaking
      • data property Modified
        • Type is now object | null
GET /v1/Services/{ServiceSid}/Lists/{ListSid}/Permissions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ServiceSid}/Maps
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ServiceSid}/Maps/{MapSid}/Items
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • data property Modified
          • Type is now object | null
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • Type is now object | null
GET /v1/Services/{ServiceSid}/Maps/{MapSid}/Permissions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{ServiceSid}/Streams
  • Response
  • 200 response Modified
    • application/json content type Modified
      • meta property Modified
        • next_page_url, previous_page_url properties Modified
          • Type went from string(uri) to string(uri) | null
  • Query
  • Page, PageToken query parameters Added
GET /v1/Services/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • reachability_debouncing_window property Modified
        • Type went from integer | null to integer
          Breaking
POST /v1/Services
  • Response
  • 201 response Modified
    • application/json content type Modified
      • reachability_debouncing_window property Modified
        • Type went from integer | null to integer
          Breaking
POST /v1/Services/{ServiceSid}/Documents
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • Type is now object | null
POST /v1/Services/{ServiceSid}/Documents/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • Type is now object | null
POST /v1/Services/{ServiceSid}/Lists/{ListSid}/Items
  • Response
  • 201 response Modified
    • application/json content type Modified
      • index property Modified
        • Type went from integer | null to integer
          Breaking
      • data property Modified
        • Type is now object | null
POST /v1/Services/{ServiceSid}/Lists/{ListSid}/Items/{Index}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • index property Modified
        • Type went from integer | null to integer
          Breaking
      • data property Modified
        • Type is now object | null
POST /v1/Services/{ServiceSid}/Maps/{MapSid}/Items
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • Type is now object | null
POST /v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • data property Modified
        • Type is now object | null
POST /v1/Services/{ServiceSid}/Streams/{StreamSid}/Messages
  • Response
  • 201 response Modified
    • application/json content type Modified
      • data property Modified
        • Type is now object | null
POST /v1/Services/{Sid}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • reachability_debouncing_window property Modified
        • Type went from integer | null to integer
          Breaking