Transition to API version 0.0.4-dev (aces#6944)

Initiate development on version 0.0.4-dev of the API and remove support for 0.0.2 Resolves aces#6941
AlexandraLivadas · Jun 29, 2021 · 5cd6f70 · 5cd6f70
1 parent d90dfb1
commit 5cd6f70
Show file tree

Hide file tree

Showing 40 changed files with 511 additions and 84 deletions.
diff --git a/modules/api/docs/LorisRESTAPI.md b/modules/api/docs/LorisRESTAPI.md
diff --git a/modules/api/docs/LorisRESTAPI_v0.0.3.md → modules/api/docs/LorisRESTAPI_v0.0.4-dev.md b/modules/api/docs/LorisRESTAPI_v0.0.3.md → modules/api/docs/LorisRESTAPI_v0.0.4-dev.md
@@ -1,4 +1,4 @@
-# LORIS API - v0.0.3
+# LORIS API - v0.0.4-dev
 ## 1.0 Overview
 
 This document specifies the Loris REST API.
@@ -8,7 +8,7 @@ or no data. The Loris API uses standard HTTP error codes and the body of any res
 either be empty or contain only a JSON object for any request.
 
 For brevity, the `$LorisRoot/api/$APIVERSION` is omitted from the definitions in this
-document. This document specifies $APIVERSION v0.0.3 and it
+document. This document specifies $APIVERSION v0.0.4-dev and it
 MUST be included before the request in all requests.
 
 HTTP GET requests NEVER modify data. PUT, POST or PATCH requests MUST be used to modify

diff --git a/modules/api/php/endpoints/candidate/candidate.class.inc b/modules/api/php/endpoints/candidate/candidate.class.inc
@@ -63,8 +63,8 @@ class Candidate extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/dicom/dicom.class.inc b/modules/api/php/endpoints/candidate/visit/dicom/dicom.class.inc
@@ -79,7 +79,10 @@ class Dicom extends Endpoint implements \LORIS\Middleware\ETagCalculator
      */
     protected function supportedVersions() : array
     {
-        return ['v0.0.3'];
+        return [
+            'v0.0.3',
+            'v0.0.4-dev',
+        ];
     }
 
     /**

diff --git a/modules/api/php/endpoints/candidate/visit/dicoms.class.inc b/modules/api/php/endpoints/candidate/visit/dicoms.class.inc
@@ -68,7 +68,10 @@ class Dicoms extends Endpoint implements \LORIS\Middleware\ETagCalculator
      */
     protected function supportedVersions() : array
     {
-        return ['v0.0.3'];
+        return [
+            'v0.0.3',
+            'v0.0.4-dev',
+        ];
     }
 
     /**

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile.class.inc
@@ -59,6 +59,7 @@ class BidsFile extends Endpoint
     {
         return [
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile/archive.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile/archive.class.inc
@@ -66,6 +66,7 @@ class Archive extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile/channels.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile/channels.class.inc
@@ -66,6 +66,7 @@ class Channels extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile/electrodes.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile/electrodes.class.inc
@@ -66,6 +66,7 @@ class Electrodes extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile/events.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/bidsfile/events.class.inc
@@ -66,6 +66,7 @@ class Events extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/channels.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/channels.class.inc
@@ -75,6 +75,7 @@ class Channels extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/electrodes.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/electrodes.class.inc
@@ -75,6 +75,7 @@ class Electrodes extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/events.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/events.class.inc
@@ -75,6 +75,7 @@ class Events extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/metadata.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/metadata.class.inc
@@ -76,6 +76,7 @@ class Metadata extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/electrophysiology/recording.class.inc b/modules/api/php/endpoints/candidate/visit/electrophysiology/recording.class.inc
@@ -70,6 +70,7 @@ class Recording extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/image/format.class.inc b/modules/api/php/endpoints/candidate/visit/image/format.class.inc
@@ -61,8 +61,8 @@ class Format extends Endpoint
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/image/format/brainbrowser.class.inc b/modules/api/php/endpoints/candidate/visit/image/format/brainbrowser.class.inc
@@ -67,8 +67,8 @@ class Brainbrowser extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/image/format/raw.class.inc b/modules/api/php/endpoints/candidate/visit/image/format/raw.class.inc
@@ -62,8 +62,8 @@ class Raw extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/image/format/thumbnail.class.inc b/modules/api/php/endpoints/candidate/visit/image/format/thumbnail.class.inc
@@ -62,8 +62,8 @@ class Thumbnail extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/image/headers.class.inc b/modules/api/php/endpoints/candidate/visit/image/headers.class.inc
@@ -76,8 +76,8 @@ class Headers extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/image/image.class.inc b/modules/api/php/endpoints/candidate/visit/image/image.class.inc
@@ -72,8 +72,8 @@ class Image extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/image/qc.class.inc b/modules/api/php/endpoints/candidate/visit/image/qc.class.inc
@@ -79,8 +79,8 @@ class Qc extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/images.class.inc b/modules/api/php/endpoints/candidate/visit/images.class.inc
@@ -69,8 +69,8 @@ class Images extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/instrument/flags.class.inc b/modules/api/php/endpoints/candidate/visit/instrument/flags.class.inc
@@ -76,8 +76,8 @@ class Flags extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/instrument/instrument.class.inc b/modules/api/php/endpoints/candidate/visit/instrument/instrument.class.inc
@@ -76,8 +76,8 @@ class Instrument extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/instruments.class.inc b/modules/api/php/endpoints/candidate/visit/instruments.class.inc
@@ -69,8 +69,8 @@ class Instruments extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/qc.class.inc b/modules/api/php/endpoints/candidate/visit/qc.class.inc
@@ -73,8 +73,8 @@ class Qc extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/recordings.class.inc b/modules/api/php/endpoints/candidate/visit/recordings.class.inc
@@ -67,6 +67,7 @@ class Recordings extends Endpoint implements \LORIS\Middleware\ETagCalculator
     {
         return [
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/candidate/visit/visit.class.inc b/modules/api/php/endpoints/candidate/visit/visit.class.inc
@@ -75,8 +75,10 @@ class Visit extends Endpoint implements \LORIS\Middleware\ETagCalculator
      */
     protected function supportedVersions() : array
     {
-        // Removed 0.0.2 since session requires a project.
-        return ['v0.0.3'];
+         return [
+             'v0.0.3',
+             'v0.0.4-dev',
+         ];
     }
 
     /**

diff --git a/modules/api/php/endpoints/candidates.class.inc b/modules/api/php/endpoints/candidates.class.inc
@@ -73,8 +73,8 @@ class Candidates extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            "v0.0.2",
             "v0.0.3",
+            "v0.0.4-dev",
         ];
     }
 

diff --git a/modules/api/php/endpoints/login.class.inc b/modules/api/php/endpoints/login.class.inc
@@ -80,8 +80,8 @@ class Login extends Endpoint
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/project/candidates.class.inc b/modules/api/php/endpoints/project/candidates.class.inc
@@ -67,8 +67,8 @@ class Candidates extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/project/images.class.inc b/modules/api/php/endpoints/project/images.class.inc
@@ -66,7 +66,10 @@ class Images extends Endpoint implements \LORIS\Middleware\ETagCalculator
      */
     protected function supportedVersions() : array
     {
-        return ["v0.0.3"];
+        return [
+            "v0.0.3",
+            "v0.0.4-dev",
+        ];
     }
 
     /**

diff --git a/modules/api/php/endpoints/project/instrument/instrument.class.inc b/modules/api/php/endpoints/project/instrument/instrument.class.inc
@@ -68,8 +68,8 @@ class Instrument extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/project/instruments.class.inc b/modules/api/php/endpoints/project/instruments.class.inc
@@ -67,8 +67,8 @@ class Instruments extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/project/project.class.inc b/modules/api/php/endpoints/project/project.class.inc
@@ -67,8 +67,8 @@ class Project extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/project/recordings.class.inc b/modules/api/php/endpoints/project/recordings.class.inc
@@ -84,7 +84,10 @@ class Recordings extends Endpoint implements \LORIS\Middleware\ETagCalculator
      */
     protected function supportedVersions() : array
     {
-        return ["v0.0.3"];
+        return [
+            "v0.0.3",
+            "v0.0.4-dev"
+        ];
     }
 
     /**

diff --git a/modules/api/php/endpoints/project/visits.class.inc b/modules/api/php/endpoints/project/visits.class.inc
@@ -67,8 +67,8 @@ class Visits extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }
 

diff --git a/modules/api/php/endpoints/projects.class.inc b/modules/api/php/endpoints/projects.class.inc
@@ -63,8 +63,8 @@ class Projects extends Endpoint implements \LORIS\Middleware\ETagCalculator
     protected function supportedVersions() : array
     {
         return [
-            'v0.0.2',
             'v0.0.3',
+            'v0.0.4-dev',
         ];
     }