Merge pull request #59 from neurostuff/enh/version_info

[ENH] version info
neurostuff · Jul 13, 2023 · bbe8d91 · bbe8d91
2 parents 1284089 + 3008b30
commit bbe8d91
Showing 1 changed file with 24 additions and 0 deletions.
diff --git a/neurostore-openapi.yml b/neurostore-openapi.yml
@@ -155,6 +155,7 @@ paths:
         - $ref: '#/components/parameters/level'
         - $ref: '#/components/parameters/pmid'
         - $ref: '#/components/parameters/doi'
+        - $ref: '#/components/parameters/flat'
       security:
         - JSON-Web-Token: []
         - {}
@@ -209,6 +210,7 @@ paths:
       parameters:
         - $ref: '#/components/parameters/nested'
         - $ref: '#/components/parameters/studyset_owner'
+        - $ref: '#/components/parameters/flat'
     put:
       summary: PUT/update a study
       responses:
@@ -825,6 +827,8 @@ paths:
         - $ref: '#/components/parameters/publication'
         - $ref: '#/components/parameters/pmid'
         - $ref: '#/components/parameters/doi'
+        - $ref: '#/components/parameters/flat'
+        - $ref: '#/components/parameters/info'
       security:
         - JSON-Web-Token: []
         - {}
@@ -862,6 +866,9 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/base-study-return'
+      parameters:
+        - $ref: '#/components/parameters/flat'
+        - $ref: '#/components/parameters/info'
     put:
       summary: ''
       responses:
@@ -1953,6 +1960,23 @@ components:
       schema:
         type: string
       description: search for study with specific doi
+    flat:
+      name: flat
+      in: query
+      required: false
+      schema:
+        type: string
+        enum:
+          - 'true'
+          - 'false'
+      description: 'do not return any embedded relationships. When set, it is incompatible with nested. '
+    info:
+      name: info
+      in: query
+      required: false
+      schema:
+        type: string
+      description: show additional for endpoint-object relationships without being fully nested. Incompatible with nested
   securitySchemes:
     JSON-Web-Token:
       type: http