Change Updates

Do not miss any Advanced API changes, ever again

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

RSS
Advanced API

Changelog

Last update:
Compare

  • Moved GlobalTriggers to the top of the returned json as it seems to have caused confusion

  • Added the field ImageType to the IMAGE-SAVE Event and image-history

  • Removed the Id field from image-history, just use the index of the Image in the returned Array

  • All Image Types (LIGHT, DARK, BIAS, FLAT, SNAPSHOT) now raise an IMAGE-SAVE event

  • Event watchers are now started independently of the api, therefore Events can still be retrieved using event-history even if the api wasn't running before.

5 structure changes including:
1 Addition
4 Modifications
Modified 4 Breaking
GET /equipment/focuser/last-af
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • RSquares property Modified
GET /image-history
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • array-1 alternative Modified
GET /profile/show
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • PluginSettings property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /sequence/list-available
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • Type went from array[string] to array[object]
          Breaking
        • object property Added
Added 1
GET /sequence/reset
2 structure changes including:
2 Modifications
Modified 2 Breaking
GET /equipment/mount/info
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • SiteElevation, TimeToMeridianFlip properties Modified
          • Type went from integer to number
            Breaking
GET /sequence/json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response, Error, StatusCode, Success, Type properties Added
6 structure changes including:
6 Modifications
Modified 6 Breaking
GET /equipment/camera/cool
  • Query
  • minutes query parameter Modified
    • Query parameter is now required
      Breaking
GET /equipment/camera/info
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • TargetTemp, AtTargetTemp properties Added
GET /equipment/camera/warm
  • Query
  • minutes query parameter Added
GET /equipment/filterwheel/info
  • Response
  • 200 response Modified
    • application/json content type Modified
      • Response property Modified
        • AvailableFilters property Modified
          • Property is no longer required
        • CanSetFilter property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • IsMoving, SupportedActions, SelectedFilter properties Added
GET /equipment/rotator/move
  • Query
  • position query parameter Modified
    • Type went from integer(int32) to number
      Breaking
GET /equipment/rotator/move-mechanical
  • Query
  • position query parameter Modified
    • Type went from integer(int32) to number
      Breaking