5857d5eae457bf4690d7641b505586e16fdb95da

docs/DefaultApi.md

@@ -11,7 +11,7 @@ Method | HTTP request | Description
 
 
 # **base_studies_get**
-> BaseStudyReturn base_studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, source=source, publication=publication, pmid=pmid, doi=doi)
+> BaseStudyReturn base_studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, source=source, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info)
 
 
 
@@ -60,10 +60,12 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
     publication = 'publication_example' # str | search for papers from a particular journal (optional)
     pmid = 'pmid_example' # str | search for particular pmid (optional)
     doi = 'doi_example' # str | search for study with specific doi (optional)
+    flat = 'flat_example' # str | do not return any embedded relationships. When set, it is incompatible with nested.  (optional)
+    info = 'info_example' # str | show additional for endpoint-object relationships without being fully nested. Incompatible with nested (optional)
 
     try:
         # 
-        api_response = api_instance.base_studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, source=source, publication=publication, pmid=pmid, doi=doi)
+        api_response = api_instance.base_studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, name=name, description=description, authors=authors, level=level, data_type=data_type, source=source, publication=publication, pmid=pmid, doi=doi, flat=flat, info=info)
         print("The response of DefaultApi->base_studies_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -89,6 +91,8 @@ Name | Type | Description  | Notes
  **publication** | **str**| search for papers from a particular journal | [optional] 
  **pmid** | **str**| search for particular pmid | [optional] 
  **doi** | **str**| search for study with specific doi | [optional] 
+ **flat** | **str**| do not return any embedded relationships. When set, it is incompatible with nested.  | [optional] 
+ **info** | **str**| show additional for endpoint-object relationships without being fully nested. Incompatible with nested | [optional] 
 
 ### Return type
 
@@ -111,7 +115,7 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **base_studies_id_get**
-> BaseStudyReturn base_studies_id_get(id)
+> BaseStudyReturn base_studies_id_get(id, flat=flat, info=info)
 
 Your GET endpoint
 
@@ -137,10 +141,12 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = neurostore_sdk.DefaultApi(api_client)
     id = 'id_example' # str | 
+    flat = 'flat_example' # str | do not return any embedded relationships. When set, it is incompatible with nested.  (optional)
+    info = 'info_example' # str | show additional for endpoint-object relationships without being fully nested. Incompatible with nested (optional)
 
     try:
         # Your GET endpoint
-        api_response = api_instance.base_studies_id_get(id)
+        api_response = api_instance.base_studies_id_get(id, flat=flat, info=info)
         print("The response of DefaultApi->base_studies_id_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -153,6 +159,8 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **id** | **str**|  | 
+ **flat** | **str**| do not return any embedded relationships. When set, it is incompatible with nested.  | [optional] 
+ **info** | **str**| show additional for endpoint-object relationships without being fully nested. Incompatible with nested | [optional] 
 
 ### Return type
 

docs/StoreApi.md

@@ -1900,7 +1900,7 @@ Name | Type | Description  | Notes
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **studies_get**
-> StudyList studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi)
+> StudyList studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi, flat=flat)
 
 GET a list of studies
 
@@ -1955,10 +1955,11 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
     level = 'group' # str | select between studies with group results or meta results (optional) (default to 'group')
     pmid = 'pmid_example' # str | search for particular pmid (optional)
     doi = 'doi_example' # str | search for study with specific doi (optional)
+    flat = 'flat_example' # str | do not return any embedded relationships. When set, it is incompatible with nested.  (optional)
 
     try:
         # GET a list of studies
-        api_response = api_instance.studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi)
+        api_response = api_instance.studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi, flat=flat)
         print("The response of StoreApi->studies_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -1988,6 +1989,7 @@ Name | Type | Description  | Notes
  **level** | **str**| select between studies with group results or meta results | [optional] [default to 'group']
  **pmid** | **str**| search for particular pmid | [optional] 
  **doi** | **str**| search for study with specific doi | [optional] 
+ **flat** | **str**| do not return any embedded relationships. When set, it is incompatible with nested.  | [optional] 
 
 ### Return type
 
@@ -2083,7 +2085,7 @@ void (empty response body)
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **studies_id_get**
-> StudyReturn studies_id_get(id, nested=nested, studyset_owner=studyset_owner)
+> StudyReturn studies_id_get(id, nested=nested, studyset_owner=studyset_owner, flat=flat)
 
 GET a study
 
@@ -2113,10 +2115,11 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
     id = 'id_example' # str | 
     nested = True # bool | whether to show the URI to a resource (false) or to embed the object in the response (true) (optional)
     studyset_owner = 'studyset_owner_example' # str | for all studies filter which studysets are listed based on who owns the studyset (optional)
+    flat = 'flat_example' # str | do not return any embedded relationships. When set, it is incompatible with nested.  (optional)
 
     try:
         # GET a study
-        api_response = api_instance.studies_id_get(id, nested=nested, studyset_owner=studyset_owner)
+        api_response = api_instance.studies_id_get(id, nested=nested, studyset_owner=studyset_owner, flat=flat)
         print("The response of StoreApi->studies_id_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -2131,6 +2134,7 @@ Name | Type | Description  | Notes
  **id** | **str**|  | 
  **nested** | **bool**| whether to show the URI to a resource (false) or to embed the object in the response (true) | [optional] 
  **studyset_owner** | **str**| for all studies filter which studysets are listed based on who owns the studyset | [optional] 
+ **flat** | **str**| do not return any embedded relationships. When set, it is incompatible with nested.  | [optional] 
 
 ### Return type
 

docs/StudiesApi.md

@@ -12,7 +12,7 @@ Method | HTTP request | Description
 
 
 # **studies_get**
-> StudyList studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi)
+> StudyList studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi, flat=flat)
 
 GET a list of studies
 
@@ -67,10 +67,11 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
     level = 'group' # str | select between studies with group results or meta results (optional) (default to 'group')
     pmid = 'pmid_example' # str | search for particular pmid (optional)
     doi = 'doi_example' # str | search for study with specific doi (optional)
+    flat = 'flat_example' # str | do not return any embedded relationships. When set, it is incompatible with nested.  (optional)
 
     try:
         # GET a list of studies
-        api_response = api_instance.studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi)
+        api_response = api_instance.studies_get(search=search, sort=sort, page=page, desc=desc, page_size=page_size, nested=nested, name=name, description=description, source_id=source_id, unique=unique, source=source, authors=authors, user_id=user_id, data_type=data_type, studyset_owner=studyset_owner, level=level, pmid=pmid, doi=doi, flat=flat)
         print("The response of StudiesApi->studies_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -100,6 +101,7 @@ Name | Type | Description  | Notes
  **level** | **str**| select between studies with group results or meta results | [optional] [default to 'group']
  **pmid** | **str**| search for particular pmid | [optional] 
  **doi** | **str**| search for study with specific doi | [optional] 
+ **flat** | **str**| do not return any embedded relationships. When set, it is incompatible with nested.  | [optional] 
 
 ### Return type
 
@@ -195,7 +197,7 @@ void (empty response body)
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
 # **studies_id_get**
-> StudyReturn studies_id_get(id, nested=nested, studyset_owner=studyset_owner)
+> StudyReturn studies_id_get(id, nested=nested, studyset_owner=studyset_owner, flat=flat)
 
 GET a study
 
@@ -225,10 +227,11 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
     id = 'id_example' # str | 
     nested = True # bool | whether to show the URI to a resource (false) or to embed the object in the response (true) (optional)
     studyset_owner = 'studyset_owner_example' # str | for all studies filter which studysets are listed based on who owns the studyset (optional)
+    flat = 'flat_example' # str | do not return any embedded relationships. When set, it is incompatible with nested.  (optional)
 
     try:
         # GET a study
-        api_response = api_instance.studies_id_get(id, nested=nested, studyset_owner=studyset_owner)
+        api_response = api_instance.studies_id_get(id, nested=nested, studyset_owner=studyset_owner, flat=flat)
         print("The response of StudiesApi->studies_id_get:\n")
         pprint(api_response)
     except Exception as e:
@@ -243,6 +246,7 @@ Name | Type | Description  | Notes
  **id** | **str**|  | 
  **nested** | **bool**| whether to show the URI to a resource (false) or to embed the object in the response (true) | [optional] 
  **studyset_owner** | **str**| for all studies filter which studysets are listed based on who owns the studyset | [optional] 
+ **flat** | **str**| do not return any embedded relationships. When set, it is incompatible with nested.  | [optional] 
 
 ### Return type