Skip to content

Commit 3c5fae8

Browse files
author
Adrian Gonzalez-Martin
authored
Update swagger spec (#53)
1 parent 0dc89c7 commit 3c5fae8

File tree

14 files changed

+1328
-17
lines changed

14 files changed

+1328
-17
lines changed

‎python/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,15 +99,21 @@ Class | Method | HTTP request | Description
9999
*EnvironmentApi* | [**read_health_check**](docs/EnvironmentApi.md#read_health_check) | **GET** /healthcheck |
100100
*EnvironmentApi* | [**read_user**](docs/EnvironmentApi.md#read_user) | **GET** /user |
101101
*EnvironmentApi* | [**read_version**](docs/EnvironmentApi.md#read_version) | **GET** /version |
102+
*ExperimentsApi* | [**create_canary_experiment**](docs/ExperimentsApi.md#create_canary_experiment) | **POST** /namespaces/{namespace}/pipelines/{name}/experiment/canary |
102103
*ExperimentsApi* | [**create_pipeline_experiment**](docs/ExperimentsApi.md#create_pipeline_experiment) | **POST** /namespaces/{namespace}/pipelines/{name}/experiment |
104+
*ExperimentsApi* | [**create_shadow_experiment**](docs/ExperimentsApi.md#create_shadow_experiment) | **POST** /namespaces/{namespace}/pipelines/{name}/experiment/shadow |
103105
*ExperimentsApi* | [**delete_pipeline_experiment**](docs/ExperimentsApi.md#delete_pipeline_experiment) | **DELETE** /namespaces/{namespace}/pipelines/{name}/experiment |
104106
*ExperimentsApi* | [**get_pipeline_experiment**](docs/ExperimentsApi.md#get_pipeline_experiment) | **GET** /namespaces/{namespace}/pipelines/{name}/experiment |
105107
*ExperimentsApi* | [**promote_canary**](docs/ExperimentsApi.md#promote_canary) | **PUT** /namespaces/{namespace}/pipelines/{name}/experiment/canary |
108+
*ExperimentsApi* | [**promote_shadow**](docs/ExperimentsApi.md#promote_shadow) | **PUT** /namespaces/{namespace}/pipelines/{name}/experiment/shadow |
106109
*ExperimentsApi* | [**remove_canary**](docs/ExperimentsApi.md#remove_canary) | **DELETE** /namespaces/{namespace}/pipelines/{name}/experiment/canary |
110+
*ExperimentsApi* | [**remove_shadow**](docs/ExperimentsApi.md#remove_shadow) | **DELETE** /namespaces/{namespace}/pipelines/{name}/experiment/shadow |
107111
*ExperimentsApi* | [**update_pipeline_experiment**](docs/ExperimentsApi.md#update_pipeline_experiment) | **PUT** /namespaces/{namespace}/pipelines/{name}/experiment |
108112
*ExplainApi* | [**explain_seldon_deployment**](docs/ExplainApi.md#explain_seldon_deployment) | **POST** /namespaces/{namespace}/seldondeployments/{name}/explain |
109113
*ExplainApi* | [**explain_seldon_pipeline**](docs/ExplainApi.md#explain_seldon_pipeline) | **POST** /namespaces/{namespace}/pipelines/{name}/explain |
110114
*GitOpsApi* | [**read_git_ops_status**](docs/GitOpsApi.md#read_git_ops_status) | **GET** /namespaces/{namespace}/gitops-status |
115+
*GitOpsApi* | [**read_pipeline_git_diff**](docs/GitOpsApi.md#read_pipeline_git_diff) | **GET** /namespaces/{namespace}/pipelines/{name}/gitdiff |
116+
*GitOpsApi* | [**read_pipeline_git_logs**](docs/GitOpsApi.md#read_pipeline_git_logs) | **GET** /namespaces/{namespace}/pipelines/{name}/gitlogs |
111117
*GitOpsApi* | [**read_seldon_deployment_git_diff**](docs/GitOpsApi.md#read_seldon_deployment_git_diff) | **GET** /namespaces/{namespace}/seldondeployments/{name}/gitdiff |
112118
*GitOpsApi* | [**read_seldon_deployment_git_logs**](docs/GitOpsApi.md#read_seldon_deployment_git_logs) | **GET** /namespaces/{namespace}/seldondeployments/{name}/gitlogs |
113119
*GitOpsApi* | [**seldon_deployment_git_restore**](docs/GitOpsApi.md#seldon_deployment_git_restore) | **GET** /namespaces/{namespace}/seldondeployments/{name}/gitrestore |

‎python/docs/ExperimentsApi.md‎

Lines changed: 234 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,77 @@ All URIs are relative to *http://X.X.X.X/seldon-deploy/api/v1alpha1*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7+
[**create_canary_experiment**](ExperimentsApi.md#create_canary_experiment) | **POST** /namespaces/{namespace}/pipelines/{name}/experiment/canary |
78
[**create_pipeline_experiment**](ExperimentsApi.md#create_pipeline_experiment) | **POST** /namespaces/{namespace}/pipelines/{name}/experiment |
9+
[**create_shadow_experiment**](ExperimentsApi.md#create_shadow_experiment) | **POST** /namespaces/{namespace}/pipelines/{name}/experiment/shadow |
810
[**delete_pipeline_experiment**](ExperimentsApi.md#delete_pipeline_experiment) | **DELETE** /namespaces/{namespace}/pipelines/{name}/experiment |
911
[**get_pipeline_experiment**](ExperimentsApi.md#get_pipeline_experiment) | **GET** /namespaces/{namespace}/pipelines/{name}/experiment |
1012
[**promote_canary**](ExperimentsApi.md#promote_canary) | **PUT** /namespaces/{namespace}/pipelines/{name}/experiment/canary |
13+
[**promote_shadow**](ExperimentsApi.md#promote_shadow) | **PUT** /namespaces/{namespace}/pipelines/{name}/experiment/shadow |
1114
[**remove_canary**](ExperimentsApi.md#remove_canary) | **DELETE** /namespaces/{namespace}/pipelines/{name}/experiment/canary |
15+
[**remove_shadow**](ExperimentsApi.md#remove_shadow) | **DELETE** /namespaces/{namespace}/pipelines/{name}/experiment/shadow |
1216
[**update_pipeline_experiment**](ExperimentsApi.md#update_pipeline_experiment) | **PUT** /namespaces/{namespace}/pipelines/{name}/experiment |
1317

1418

19+
# **create_canary_experiment**
20+
> object create_canary_experiment(name, namespace, weight, action=action, message=message)
21+
22+
23+
24+
Create the specified Seldon Pipeline Canary experiment
25+
26+
### Example
27+
```python
28+
from __future__ import print_function
29+
import time
30+
import seldon_deploy_sdk
31+
from seldon_deploy_sdk.rest import ApiException
32+
from pprint import pprint
33+
34+
# Configure OAuth2 access token for authorization: OAuth2
35+
configuration = seldon_deploy_sdk.Configuration()
36+
configuration.access_token = 'YOUR_ACCESS_TOKEN'
37+
38+
# create an instance of the API class
39+
api_instance = seldon_deploy_sdk.ExperimentsApi(seldon_deploy_sdk.ApiClient(configuration))
40+
name = 'name_example' # str | Name identifies a resource
41+
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
42+
weight = 789 # int | Weight of the traffic directed to the canary pipeline, between 0 and 100
43+
action = 'action_example' # str | Action (optional)
44+
message = 'message_example' # str | Message (optional)
45+
46+
try:
47+
api_response = api_instance.create_canary_experiment(name, namespace, weight, action=action, message=message)
48+
pprint(api_response)
49+
except ApiException as e:
50+
print("Exception when calling ExperimentsApi->create_canary_experiment: %s\n" % e)
51+
```
52+
53+
### Parameters
54+
55+
Name | Type | Description | Notes
56+
------------- | ------------- | ------------- | -------------
57+
**name** | **str**| Name identifies a resource |
58+
**namespace** | **str**| Namespace provides a logical grouping of resources |
59+
**weight** | **int**| Weight of the traffic directed to the canary pipeline, between 0 and 100 |
60+
**action** | **str**| Action | [optional]
61+
**message** | **str**| Message | [optional]
62+
63+
### Return type
64+
65+
**object**
66+
67+
### Authorization
68+
69+
[OAuth2](../README.md#OAuth2)
70+
71+
### HTTP request headers
72+
73+
- **Content-Type**: application/json
74+
- **Accept**: application/json
75+
76+
[[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)
77+
1578
# **create_pipeline_experiment**
1679
> SeldonExperiment create_pipeline_experiment(name, namespace, experiment, action=action, message=message)
1780
@@ -71,6 +134,63 @@ Name | Type | Description | Notes
71134

72135
[[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)
73136

137+
# **create_shadow_experiment**
138+
> object create_shadow_experiment(name, namespace, action=action, message=message)
139+
140+
141+
142+
Create the specified Seldon Pipeline Shadow experiment
143+
144+
### Example
145+
```python
146+
from __future__ import print_function
147+
import time
148+
import seldon_deploy_sdk
149+
from seldon_deploy_sdk.rest import ApiException
150+
from pprint import pprint
151+
152+
# Configure OAuth2 access token for authorization: OAuth2
153+
configuration = seldon_deploy_sdk.Configuration()
154+
configuration.access_token = 'YOUR_ACCESS_TOKEN'
155+
156+
# create an instance of the API class
157+
api_instance = seldon_deploy_sdk.ExperimentsApi(seldon_deploy_sdk.ApiClient(configuration))
158+
name = 'name_example' # str | Name identifies a resource
159+
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
160+
action = 'action_example' # str | Action (optional)
161+
message = 'message_example' # str | Message (optional)
162+
163+
try:
164+
api_response = api_instance.create_shadow_experiment(name, namespace, action=action, message=message)
165+
pprint(api_response)
166+
except ApiException as e:
167+
print("Exception when calling ExperimentsApi->create_shadow_experiment: %s\n" % e)
168+
```
169+
170+
### Parameters
171+
172+
Name | Type | Description | Notes
173+
------------- | ------------- | ------------- | -------------
174+
**name** | **str**| Name identifies a resource |
175+
**namespace** | **str**| Namespace provides a logical grouping of resources |
176+
**action** | **str**| Action | [optional]
177+
**message** | **str**| Message | [optional]
178+
179+
### Return type
180+
181+
**object**
182+
183+
### Authorization
184+
185+
[OAuth2](../README.md#OAuth2)
186+
187+
### HTTP request headers
188+
189+
- **Content-Type**: application/json
190+
- **Accept**: application/json
191+
192+
[[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)
193+
74194
# **delete_pipeline_experiment**
75195
> object delete_pipeline_experiment(name, namespace)
76196
@@ -234,6 +354,63 @@ Name | Type | Description | Notes
234354

235355
[[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)
236356

357+
# **promote_shadow**
358+
> object promote_shadow(name, namespace, action=action, message=message)
359+
360+
361+
362+
Promote the specified Seldon Pipeline Shadow
363+
364+
### Example
365+
```python
366+
from __future__ import print_function
367+
import time
368+
import seldon_deploy_sdk
369+
from seldon_deploy_sdk.rest import ApiException
370+
from pprint import pprint
371+
372+
# Configure OAuth2 access token for authorization: OAuth2
373+
configuration = seldon_deploy_sdk.Configuration()
374+
configuration.access_token = 'YOUR_ACCESS_TOKEN'
375+
376+
# create an instance of the API class
377+
api_instance = seldon_deploy_sdk.ExperimentsApi(seldon_deploy_sdk.ApiClient(configuration))
378+
name = 'name_example' # str | Name identifies a resource
379+
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
380+
action = 'action_example' # str | Action (optional)
381+
message = 'message_example' # str | Message (optional)
382+
383+
try:
384+
api_response = api_instance.promote_shadow(name, namespace, action=action, message=message)
385+
pprint(api_response)
386+
except ApiException as e:
387+
print("Exception when calling ExperimentsApi->promote_shadow: %s\n" % e)
388+
```
389+
390+
### Parameters
391+
392+
Name | Type | Description | Notes
393+
------------- | ------------- | ------------- | -------------
394+
**name** | **str**| Name identifies a resource |
395+
**namespace** | **str**| Namespace provides a logical grouping of resources |
396+
**action** | **str**| Action | [optional]
397+
**message** | **str**| Message | [optional]
398+
399+
### Return type
400+
401+
**object**
402+
403+
### Authorization
404+
405+
[OAuth2](../README.md#OAuth2)
406+
407+
### HTTP request headers
408+
409+
- **Content-Type**: application/json
410+
- **Accept**: application/json
411+
412+
[[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)
413+
237414
# **remove_canary**
238415
> object remove_canary(name, namespace, action=action, message=message)
239416
@@ -291,6 +468,63 @@ Name | Type | Description | Notes
291468

292469
[[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)
293470

471+
# **remove_shadow**
472+
> object remove_shadow(name, namespace, action=action, message=message)
473+
474+
475+
476+
Delete the specified Seldon Pipeline Shadow
477+
478+
### Example
479+
```python
480+
from __future__ import print_function
481+
import time
482+
import seldon_deploy_sdk
483+
from seldon_deploy_sdk.rest import ApiException
484+
from pprint import pprint
485+
486+
# Configure OAuth2 access token for authorization: OAuth2
487+
configuration = seldon_deploy_sdk.Configuration()
488+
configuration.access_token = 'YOUR_ACCESS_TOKEN'
489+
490+
# create an instance of the API class
491+
api_instance = seldon_deploy_sdk.ExperimentsApi(seldon_deploy_sdk.ApiClient(configuration))
492+
name = 'name_example' # str | Name identifies a resource
493+
namespace = 'namespace_example' # str | Namespace provides a logical grouping of resources
494+
action = 'action_example' # str | Action (optional)
495+
message = 'message_example' # str | Message (optional)
496+
497+
try:
498+
api_response = api_instance.remove_shadow(name, namespace, action=action, message=message)
499+
pprint(api_response)
500+
except ApiException as e:
501+
print("Exception when calling ExperimentsApi->remove_shadow: %s\n" % e)
502+
```
503+
504+
### Parameters
505+
506+
Name | Type | Description | Notes
507+
------------- | ------------- | ------------- | -------------
508+
**name** | **str**| Name identifies a resource |
509+
**namespace** | **str**| Namespace provides a logical grouping of resources |
510+
**action** | **str**| Action | [optional]
511+
**message** | **str**| Message | [optional]
512+
513+
### Return type
514+
515+
**object**
516+
517+
### Authorization
518+
519+
[OAuth2](../README.md#OAuth2)
520+
521+
### HTTP request headers
522+
523+
- **Content-Type**: application/json
524+
- **Accept**: application/json
525+
526+
[[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)
527+
294528
# **update_pipeline_experiment**
295529
> SeldonExperiment update_pipeline_experiment(name, namespace, experiment, action=action, message=message)
296530

0 commit comments

Comments
 (0)