Skip to content

Commit 3ed81f1

Browse files
12d355862b7b5ae4a70f01c838155b5879a5d574
1 parent 2ecdeb7 commit 3ed81f1

File tree

5 files changed

+35
-14
lines changed

5 files changed

+35
-14
lines changed

.openapi-generator/FILES

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,4 @@ setup.cfg
234234
setup.py
235235
test-requirements.txt
236236
test/__init__.py
237-
test/test_pipeline_study_result.py
238-
test/test_pipeline_study_result_list.py
239-
test/test_pipeline_study_results_api.py
240237
tox.ini

docs/PipelineStudyResultsApi.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Method | HTTP request | Description
1212

1313

1414
# **pipeline_study_results_get**
15-
> PipelineStudyResultList pipeline_study_results_get()
15+
> PipelineStudyResultList pipeline_study_results_get(feature_filter=feature_filter)
1616
1717
GET a list of pipeline run results
1818

@@ -37,10 +37,11 @@ configuration = neurostore_sdk.Configuration(
3737
with neurostore_sdk.ApiClient(configuration) as api_client:
3838
# Create an instance of the API class
3939
api_instance = neurostore_sdk.PipelineStudyResultsApi(api_client)
40+
feature_filter = ['feature_filter_example'] # List[str] | Filter results by feature content using jsonpath syntax (optional)
4041

4142
try:
4243
# GET a list of pipeline run results
43-
api_response = api_instance.pipeline_study_results_get()
44+
api_response = api_instance.pipeline_study_results_get(feature_filter=feature_filter)
4445
print("The response of PipelineStudyResultsApi->pipeline_study_results_get:\n")
4546
pprint(api_response)
4647
except Exception as e:
@@ -49,7 +50,10 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
4950

5051

5152
### Parameters
52-
This endpoint does not need any parameter.
53+
54+
Name | Type | Description | Notes
55+
------------- | ------------- | ------------- | -------------
56+
**feature_filter** | [**List[str]**](str.md)| Filter results by feature content using jsonpath syntax | [optional]
5357

5458
### Return type
5559

docs/PipelinesApi.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,6 +267,7 @@ POST/create a pipeline
267267

268268
### Example
269269

270+
* Bearer Authentication (JSON-Web-Token):
270271
```python
271272
import time
272273
import os
@@ -281,6 +282,15 @@ configuration = neurostore_sdk.Configuration(
281282
host = "https://neurostore.org/api"
282283
)
283284

285+
# The client must configure the authentication and authorization parameters
286+
# in accordance with the API server security policy.
287+
# Examples for each auth method are provided below, use the example that
288+
# satisfies your auth use case.
289+
290+
# Configure Bearer authorization: JSON-Web-Token
291+
configuration = neurostore_sdk.Configuration(
292+
access_token = os.environ["BEARER_TOKEN"]
293+
)
284294

285295
# Enter a context with an instance of the API client
286296
with neurostore_sdk.ApiClient(configuration) as api_client:
@@ -308,7 +318,7 @@ void (empty response body)
308318

309319
### Authorization
310320

311-
No authorization required
321+
[JSON-Web-Token](../README.md#JSON-Web-Token)
312322

313323
### HTTP request headers
314324

@@ -319,6 +329,7 @@ No authorization required
319329
| Status code | Description | Response headers |
320330
|-------------|-------------|------------------|
321331
**201** | Created | - |
332+
**401** | Unauthorized - Authentication required | - |
322333

323334
[[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)
324335

neurostore_sdk/api/pipeline_study_results_api.py

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
from pydantic import validate_arguments, ValidationError
2121
from typing_extensions import Annotated
2222

23-
from pydantic import StrictStr
23+
from pydantic import Field, StrictStr, conlist
2424

2525
from typing import Optional
2626

@@ -48,15 +48,17 @@ def __init__(self, api_client=None):
4848
self.api_client = api_client
4949

5050
@validate_arguments
51-
def pipeline_study_results_get(self, **kwargs) -> PipelineStudyResultList: # noqa: E501
51+
def pipeline_study_results_get(self, feature_filter : Annotated[Optional[conlist(StrictStr)], Field(description="Filter results by feature content using jsonpath syntax")] = None, **kwargs) -> PipelineStudyResultList: # noqa: E501
5252
"""GET a list of pipeline run results # noqa: E501
5353
5454
This method makes a synchronous HTTP request by default. To make an
5555
asynchronous HTTP request, please pass async_req=True
5656
57-
>>> thread = api.pipeline_study_results_get(async_req=True)
57+
>>> thread = api.pipeline_study_results_get(feature_filter, async_req=True)
5858
>>> result = thread.get()
5959
60+
:param feature_filter: Filter results by feature content using jsonpath syntax
61+
:type feature_filter: List[str]
6062
:param async_req: Whether to execute the request asynchronously.
6163
:type async_req: bool, optional
6264
:param _request_timeout: timeout setting for this request. If one
@@ -71,18 +73,20 @@ def pipeline_study_results_get(self, **kwargs) -> PipelineStudyResultList: # no
7173
kwargs['_return_http_data_only'] = True
7274
if '_preload_content' in kwargs:
7375
raise ValueError("Error! Please call the pipeline_study_results_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
74-
return self.pipeline_study_results_get_with_http_info(**kwargs) # noqa: E501
76+
return self.pipeline_study_results_get_with_http_info(feature_filter, **kwargs) # noqa: E501
7577

7678
@validate_arguments
77-
def pipeline_study_results_get_with_http_info(self, **kwargs) -> ApiResponse: # noqa: E501
79+
def pipeline_study_results_get_with_http_info(self, feature_filter : Annotated[Optional[conlist(StrictStr)], Field(description="Filter results by feature content using jsonpath syntax")] = None, **kwargs) -> ApiResponse: # noqa: E501
7880
"""GET a list of pipeline run results # noqa: E501
7981
8082
This method makes a synchronous HTTP request by default. To make an
8183
asynchronous HTTP request, please pass async_req=True
8284
83-
>>> thread = api.pipeline_study_results_get_with_http_info(async_req=True)
85+
>>> thread = api.pipeline_study_results_get_with_http_info(feature_filter, async_req=True)
8486
>>> result = thread.get()
8587
88+
:param feature_filter: Filter results by feature content using jsonpath syntax
89+
:type feature_filter: List[str]
8690
:param async_req: Whether to execute the request asynchronously.
8791
:type async_req: bool, optional
8892
:param _preload_content: if False, the ApiResponse.data will
@@ -111,6 +115,7 @@ def pipeline_study_results_get_with_http_info(self, **kwargs) -> ApiResponse: #
111115
_params = locals()
112116

113117
_all_params = [
118+
'feature_filter'
114119
]
115120
_all_params.extend(
116121
[
@@ -141,6 +146,10 @@ def pipeline_study_results_get_with_http_info(self, **kwargs) -> ApiResponse: #
141146

142147
# process the query parameters
143148
_query_params = []
149+
if _params.get('feature_filter') is not None: # noqa: E501
150+
_query_params.append(('feature_filter', _params['feature_filter']))
151+
_collection_formats['feature_filter'] = 'multi'
152+
144153
# process the header parameters
145154
_header_params = dict(_params.get('_headers', {}))
146155
# process the form parameters

neurostore_sdk/api/pipelines_api.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -707,7 +707,7 @@ def pipelines_post_with_http_info(self, pipeline : Optional[Pipeline] = None, **
707707
_header_params['Content-Type'] = _content_types_list
708708

709709
# authentication setting
710-
_auth_settings = [] # noqa: E501
710+
_auth_settings = ['JSON-Web-Token'] # noqa: E501
711711

712712
_response_types_map = {}
713713

0 commit comments

Comments
 (0)