From e91397336d3a49154bd8061edaaebf25fd2edead Mon Sep 17 00:00:00 2001
From: Reinier Zwitserloot <reinier@zwitserloot.com>
Date: Tue, 11 Apr 2023 16:10:12 +0200
Subject: [PATCH] [apidoc] [trivial] Renamed QoC to Quality of Care, modified a
 few descriptions.

---
 zoo-api.yaml | 27 +++++++++++----------------
 1 file changed, 11 insertions(+), 16 deletions(-)

diff --git a/zoo-api.yaml b/zoo-api.yaml
index 5e33dcc..903eb5c 100644
--- a/zoo-api.yaml
+++ b/zoo-api.yaml
@@ -3,19 +3,10 @@ info:
   title: Zorg op Orde API
   description: |-
     Copyright Zorg op Orde – All rights reserved.
-    
-    Security is done, for now, via cookies - i.e. just make the API request,
-    if done from a browser session that is logged in, the API request is handled.
-    
-    All API requests can return an error state of 'not logged in' or 'not authorized'
-    (which means, some user is logged in, but is not allowed to see / act the thing they want to see / act on).
   contact:
-    name: Zorg op Orde tech lead
-    email: r.zwitserloot@zorgoporde.nl
+    name: Zorg op Orde
+    email: api@zorgoporde.nl
   version: 0.1-DEV
-externalDocs:
-  description: Find out more about Swagger
-  url: http://swagger.io
 servers:
   - url: https://tools.zorgoporde.nl/api1
     description: Production
@@ -29,9 +20,9 @@ tags:
     description: |-
       API for retrieving medical dossier data and concerns based on looking up a
       specific patient.
-  - name: QoC
+  - name: Quality of Care
     description: |-
-      API related to Quality of Care features
+      API related to Quality of Care (QoC) features
       
       A care program (dutch: _ketenzorg_ or _zorgprogramma_) describes a specific disease (such as Diabetes or Astma) or a more abstract concern such as elderly care or general concern about cardiovascular health. The same care program can show up multiple times, as there are different care programs and standards for the same disease or concern. For example, there could be the InEen report 'take' on how one should provide Diabetes care, and there could be some regional group's slightly different take on it; these would show up as different care programs.
 
@@ -130,6 +121,10 @@ paths:
       tags:
         - patient
       summary: Get detailed medical dossier info for the stated patient
+      description: |-
+        WorkInProgress: The API will require you to provide (as parameters) the purpose of the request and potentially
+        the person on whose authority this request is being made, which will be logged and reviewed for the
+        _Principle of Least Privilege_ policy.
       parameters:
         - name: bsn
           in: query
@@ -404,7 +399,7 @@ paths:
   /qoc/careprogram:
     get:
       tags:
-        - QoC
+        - Quality of Care
       summary: List all available care programs
       description: Includes all care programs that the user is allowed to see, even ones that are unfavourited or not shown by default.
       responses:
@@ -423,7 +418,7 @@ paths:
   /qoc/careprogram/{careprogramKey}/fave:
     put:
       tags:
-        - QoC
+        - Quality of Care
       summary: Favourite, unfavourite, or clear fav status for a given CareProgram
       parameters:
         - name: careprogramKey
@@ -472,7 +467,7 @@ paths:
   /qoc/indicatorset/{setKey}:
     get:
       tags:
-        - QoC
+        - Quality of Care
       summary: Load an indicator-based report
       parameters:
         - name: setKey