#287: Update yaml file

* Remove unnecessary "readyOnly"
* Reformat
* Rename viewId to viewName

studymanager/src/main/resources/openapi/StudyManagerAPI.yaml

@@ -395,7 +395,7 @@ paths:
               schema:
                 $ref: '#/components/schemas/StudyTimeline'
         '404':
-           description: Not found
+          description: Not found
 
 
   /studies/{studyId}/studyGroups:
@@ -1076,14 +1076,14 @@ paths:
                   format: binary
 
       responses:
-         '201':
-           description: import was successful
-           content:
-             application/json:
-               schema:
-                 $ref: '#/components/schemas/Study'
-         '400':
-           description: bad request
+        '201':
+          description: import was successful
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Study'
+        '400':
+          description: bad request
 
   /studies/{studyId}/export/study:
     parameters:
@@ -1191,7 +1191,7 @@ paths:
       - $ref: '#/components/parameters/StudyId'
       - $ref: '#/components/parameters/ObservationId'
     get:
-      operationId: listViewsForObservation
+      operationId: getViewsForObservation
       description: "Get a list of available views"
       tags:
         - data
@@ -1205,7 +1205,7 @@ paths:
                 items:
                   $ref: '#/components/schemas/ObservationDataView'
 
-  /studies/{studyId}/observations/{observationId}/views/{viewId}:
+  /studies/{studyId}/observations/{observationId}/views/{viewName}:
     get:
       tags:
         - data
@@ -1214,7 +1214,7 @@ paths:
       parameters:
         - $ref: '#/components/parameters/StudyId'
         - $ref: '#/components/parameters/ObservationId'
-        - name: viewId
+        - name: viewName
           in: path
           required: true
           schema:
@@ -1264,7 +1264,6 @@ paths:
           schema:
             type: string
             format: date-time
-            readOnly: true
         - name: size
           in: query
           schema:
@@ -1360,7 +1359,6 @@ components:
       properties:
         componentId:
           type: string
-          readOnly: true
         title:
           type: string
         description:
@@ -1441,11 +1439,9 @@ components:
         start:
           type: string
           format: date
-          readOnly: true
         end:
           type: string
           format: date
-          readOnly: true
         plannedStart:
           type: string
           format: date
@@ -1455,18 +1451,15 @@ components:
         created:
           type: string
           format: date-time
-          readOnly: true
         modified:
           type: string
           format: date-time
-          readOnly: true
         userRoles:
           type: array
           description: the roles the _current user_ has within _this_ study.
           items:
             $ref: '#/components/schemas/StudyRole'
           uniqueItems: true
-          readOnly: true
           minItems: 1
         contact:
           $ref: '#/components/schemas/Contact'
@@ -1499,7 +1492,6 @@ components:
         - active
         - paused
         - closed
-      readOnly: true
       default: draft
 
     StudyGroup:
@@ -1517,15 +1509,12 @@ components:
           $ref: '#/components/schemas/StudyDuration'
         numberOfParticipants:
           type: integer
-          readOnly: true
         created:
           type: string
           format: date-time
-          readOnly: true
         modified:
           type: string
           format: date-time
-          readOnly: true
     StudyDuration:
       type: object
       properties:
@@ -1551,21 +1540,17 @@ components:
           $ref: '#/components/schemas/Id'
         registrationToken:
           type: string
-          readOnly: true
         status:
           $ref: '#/components/schemas/ParticipantStatus'
         start:
           type: string
           format: date-time
-          readOnly: true
         created:
           type: string
           format: date-time
-          readOnly: true
         modified:
           type: string
           format: date-time
-          readOnly: true
 
     ParticipantStatus:
       type: string
@@ -1611,11 +1596,9 @@ components:
         created:
           type: string
           format: date-time
-          readOnly: true
         modified:
           type: string
           format: date-time
-          readOnly: true
         hidden:
           type: boolean
         noSchedule:
@@ -1698,10 +1681,8 @@ components:
         created:
           type: string
           format: date-time
-          readOnly: true
         token:
           type: string
-          readOnly: true
       required:
         - tokenId
         - tokenLabel
@@ -1724,19 +1705,18 @@ components:
         lastDataReceived:
           type: string
           format: date-time
-          readOnly: true
 
     ObservationDataView:
       type: object
       properties:
-        id:
+        name:
           type: string
         title:
           type: string
         description:
           type: string
       required:
-        - id
+        - name
 
     ObservationDataViewData:
       type: object
@@ -1820,15 +1800,12 @@ components:
         created:
           type: string
           format: date-time
-          readOnly: true
         modified:
           type: string
           format: date-time
-          readOnly: true
 
     Trigger:
       type: object
-      readOnly: true
       properties:
         type:
           type: string
@@ -1838,11 +1815,9 @@ components:
         created:
           type: string
           format: date-time
-          readOnly: true
         modified:
           type: string
           format: date-time
-          readOnly: true
 
     Action:
       type: object
@@ -1857,21 +1832,17 @@ components:
         created:
           type: string
           format: date-time
-          readOnly: true
         modified:
           type: string
           format: date-time
-          readOnly: true
 
     StudyId:
       type: integer
       format: int64
-      readOnly: true
 
     Id:
       type: integer
       format: int32
-      readOnly: true
 
     IdReference:
       type: integer
@@ -1958,20 +1929,15 @@ components:
       properties:
         uid:
           type: string
-          readOnly: true
         name:
           type: string
-          readOnly: true
         institution:
           type: string
-          readOnly: true
         email:
           type: string
           format: email
-          readOnly: true
       required:
         - uid
-      readOnly: true
 
     CurrentUser:
       description: |
@@ -1983,30 +1949,24 @@ components:
             completeProfile:
               type: boolean
               default: false
-              readOnly: true
             roles:
               type: array
               items:
                 $ref: '#/components/schemas/PlatformRole'
               uniqueItems: true
-              readOnly: true
             links:
               title: ProfileLinks
               type: object
               properties:
                 profile:
                   type: string
                   format: uri
-                  readOnly: true
                 userManagement:
                   type: string
                   format: uri
-                  readOnly: true
-              readOnly: true
           required:
             - roles
             - links
-          readOnly: true
 
     Collaborator:
       type: object
@@ -2018,11 +1978,9 @@ components:
           items:
             $ref: '#/components/schemas/StudyRole'
           uniqueItems: true
-          readOnly: true
       required:
         - user
         - roles
-      readOnly: true
 
     CollaboratorDetails:
       type: object
@@ -2045,13 +2003,10 @@ components:
             required:
               - role
               - assignedAt
-            readOnly: true
           uniqueItems: true
-          readOnly: true
       required:
         - user
         - roles
-      readOnly: true
 
     PlatformRole:
       description: |
@@ -2109,10 +2064,8 @@ components:
             - clientId
           externalDocs:
             url: https://www.keycloak.org/docs/latest/securing_apps/index.html#javascript-adapter-reference
-          readOnly: true
       required:
         - auth
-      readOnly: true
 
     BuildInfo:
       type: object
@@ -2186,21 +2139,18 @@ components:
       schema:
         type: string
         format: date-time
-        readOnly: true
     From:
       name: from
       in: query
       schema:
         type: string
         format: date-time
-        readOnly: true
     To:
       name: to
       in: query
       schema:
         type: string
         format: date-time
-        readOnly: true
 
   securitySchemes:
     OAuth: