ServerStatus
Metadata about the current state of the server from the user’s perspective
type: object
Properties
Section titled “Properties”| Name | Type | Required | Description |
|---|---|---|---|
isPlanning | boolean | yes | Whether the server is currently working on updates to the user’s plan. While true, whatever existing plan may be cached on the client should be treated as invalid/disabled. |
errorMessage | string | null | yes | Currently applicable error message for display to user regarding a server-side issue. Expected to always be null. When set with a value, it’s due to an unsolvable error that is going to keep Wysp from working. |
dataAvailability | LOW PARTIAL FULL | yes | Availability of wysp’s various data sources for the user’s current location/plan. User should be gently notified of PARTIAL availability, and warned strongly of LOW availability. |