diff --git a/zoo-api.yaml b/zoo-api.yaml index 7a27a2c..bbe9780 100644 --- a/zoo-api.yaml +++ b/zoo-api.yaml @@ -60,12 +60,71 @@ paths: type: object properties: notifications: - type: string - apps: type: array items: - type: string - + type: object + properties: + type: + description: Describes the nature of the notification + type: string + example: Warning + enum: + - Warning + - Serious + - News + - Info + content: + description: Dutch text in _HTML_ - can consist of a few lines. + type: string + example: |- + De definities van opslagwijken verandert in 2024. Uw praktijk gaat van 15% naar 22% opslagwijk populatie. + id: + description: A unique ID that can be used to mark a notification as read. + type: number + example: 1000 + app_sections: + type: array + items: + type: object + properties: + title: + description: The section title, in dutch, in _HTML_. Apps are divided into sections. The main section has no title (blank string). + type: string + example: "" + apps: + type: array + items: + type: object + properties: + title: + description: The title, in dutch, as _HTML_. Will be quite short. + type: string + example: HIS op Orde + icon: + description: |- + The material icon name, as per the [material icon set](https://fonts.google.com/icons). + type: string + example: Chevron Right + badge: + description: |- + If -1, don't show a badge. If 0, show a badge (a small red dot) with no content. + Otherwise, show the number inside the dot; it is permissible to show 10 and up as '9+'. + type: number + example: -1 + url: + description: |- + The (usually relative) URL that hosts this app. Update the client URL to this when loading + this app; if API calls cannot render this app, set `window.location` to this URL. + type: string + example: /his-op-orde + app: + description: |- + A keyword that describes the app; can be blank or not present which means the only way to + load this app is by setting `window.location` with the URL. Otherwise, check the documentation + for that describes the app for information on what API is available for it. + type: string + example: HisOpOrde + /patient/dossier: get: tags: