neops_workflow_engine_client 0.31.0__tar.gz → 0.35.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. {neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/PKG-INFO +23 -10
  2. {neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/README.md +22 -9
  3. {neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/neops_workflow_engine_client/__init__.py +7 -1
  4. {neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/neops_workflow_engine_client/api/__init__.py +2 -0
  5. neops_workflow_engine_client-0.35.0/neops_workflow_engine_client/api/blackboard_api.py +542 -0
  6. {neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/neops_workflow_engine_client/api/default_api.py +13 -5
  7. {neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/neops_workflow_engine_client/api/function_block_api.py +14 -14
  8. {neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/neops_workflow_engine_client/api/health_api.py +3 -3
  9. neops_workflow_engine_client-0.35.0/neops_workflow_engine_client/api/workflows_api.py +1293 -0
  10. {neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/neops_workflow_engine_client/api_client.py +1 -1
  11. {neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/neops_workflow_engine_client/configuration.py +1 -1
  12. {neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/neops_workflow_engine_client/models/__init__.py +4 -0
  13. neops_workflow_engine_client-0.35.0/neops_workflow_engine_client/models/execute_workflow_dto.py +93 -0
  14. {neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/neops_workflow_engine_client/models/health_response.py +2 -2
  15. neops_workflow_engine_client-0.35.0/neops_workflow_engine_client/models/job_definition_dto.py +87 -0
  16. neops_workflow_engine_client-0.35.0/neops_workflow_engine_client/models/job_result_dto.py +87 -0
  17. {neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/neops_workflow_engine_client/models/register_function_block_dto.py +11 -11
  18. neops_workflow_engine_client-0.35.0/neops_workflow_engine_client/models/workflow_dto.py +107 -0
  19. {neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/pyproject.toml +1 -1
  20. {neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/neops_workflow_engine_client/api_response.py +0 -0
  21. {neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/neops_workflow_engine_client/exceptions.py +0 -0
  22. {neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/neops_workflow_engine_client/py.typed +0 -0
  23. {neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/neops_workflow_engine_client/rest.py +0 -0
{neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: neops_workflow_engine_client
3
- Version: 0.31.0
3
+ Version: 0.35.0
4
4
  Summary: Neops Workflow Engine
5
5
  Home-page: https://github.com/GIT_USER_ID/GIT_REPO_ID
6
6
  License: NoLicense
@@ -29,7 +29,7 @@ Neops workflow engine API documentation
29
29
  This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
30
30
 
31
31
  - API version: 1.0
32
- - Package version: 0.31.0
32
+ - Package version: 0.35.0
33
33
  - Generator version: 7.9.0
34
34
  - Build package: org.openapitools.codegen.languages.PythonClientCodegen
35
35
 
@@ -91,12 +91,14 @@ configuration = neops_workflow_engine_client.Configuration(
91
91
  # Enter a context with an instance of the API client
92
92
  with neops_workflow_engine_client.ApiClient(configuration) as api_client:
93
93
  # Create an instance of the API class
94
- api_instance = neops_workflow_engine_client.DefaultApi(api_client)
94
+ api_instance = neops_workflow_engine_client.BlackboardApi(api_client)
95
95
 
96
96
  try:
97
- api_instance.app_controller_get_hello()
97
+ api_response = api_instance.blackboard_controller_poll_job()
98
+ print("The response of BlackboardApi->blackboard_controller_poll_job:\n")
99
+ pprint(api_response)
98
100
  except ApiException as e:
99
- print("Exception when calling DefaultApi->app_controller_get_hello: %s\n" % e)
101
+ print("Exception when calling BlackboardApi->blackboard_controller_poll_job: %s\n" % e)
100
102
 
101
103
  ```
102
104
 
@@ -106,18 +108,29 @@ All URIs are relative to *http://localhost*
106
108
 
107
109
  Class | Method | HTTP request | Description
108
110
  ------------ | ------------- | ------------- | -------------
111
+ *BlackboardApi* | [**blackboard_controller_poll_job**](docs/BlackboardApi.md#blackboard_controller_poll_job) | **GET** /blackboard/job |
112
+ *BlackboardApi* | [**blackboard_controller_push_job_result**](docs/BlackboardApi.md#blackboard_controller_push_job_result) | **POST** /blackboard/job/result |
109
113
  *DefaultApi* | [**app_controller_get_hello**](docs/DefaultApi.md#app_controller_get_hello) | **GET** / |
110
- *FunctionBlockApi* | [**function_blocks_controller_find_all**](docs/FunctionBlockApi.md#function_blocks_controller_find_all) | **GET** /function-blocks |
111
- *FunctionBlockApi* | [**function_blocks_controller_find_one**](docs/FunctionBlockApi.md#function_blocks_controller_find_one) | **GET** /function-blocks/{id} |
112
- *FunctionBlockApi* | [**function_blocks_controller_register**](docs/FunctionBlockApi.md#function_blocks_controller_register) | **POST** /function-blocks |
113
- *FunctionBlockApi* | [**function_blocks_controller_unregister**](docs/FunctionBlockApi.md#function_blocks_controller_unregister) | **DELETE** /function-blocks/{id} |
114
- *HealthApi* | [**health_controller_healthy**](docs/HealthApi.md#health_controller_healthy) | **GET** /health |
114
+ *FunctionBlockApi* | [**function_blocks_controller_find_all**](docs/FunctionBlockApi.md#function_blocks_controller_find_all) | **GET** /function-blocks/list | List all registered function blocks
115
+ *FunctionBlockApi* | [**function_blocks_controller_find_one**](docs/FunctionBlockApi.md#function_blocks_controller_find_one) | **GET** /function-blocks/{id} | Get a function block by id
116
+ *FunctionBlockApi* | [**function_blocks_controller_register**](docs/FunctionBlockApi.md#function_blocks_controller_register) | **POST** /function-blocks/register | Register a function block
117
+ *FunctionBlockApi* | [**function_blocks_controller_unregister**](docs/FunctionBlockApi.md#function_blocks_controller_unregister) | **DELETE** /function-blocks/{id} | Unregister a function block
118
+ *HealthApi* | [**health_controller_healthy**](docs/HealthApi.md#health_controller_healthy) | **GET** /health | Check health of task engine
119
+ *WorkflowsApi* | [**workflow_controller_execute**](docs/WorkflowsApi.md#workflow_controller_execute) | **POST** /workflow | Execute a workflow
120
+ *WorkflowsApi* | [**workflow_controller_ge_all**](docs/WorkflowsApi.md#workflow_controller_ge_all) | **GET** /workflow/failed | List all failed workflows
121
+ *WorkflowsApi* | [**workflow_controller_get_all**](docs/WorkflowsApi.md#workflow_controller_get_all) | **GET** /workflow/all | List all workflows
122
+ *WorkflowsApi* | [**workflow_controller_get_running**](docs/WorkflowsApi.md#workflow_controller_get_running) | **GET** /workflow/running | List all running workflows
123
+ *WorkflowsApi* | [**workflow_controller_remove**](docs/WorkflowsApi.md#workflow_controller_remove) | **DELETE** /workflow/{id} | Stop a workflow
115
124
 
116
125
 
117
126
  ## Documentation For Models
118
127
 
128
+ - [ExecuteWorkflowDto](docs/ExecuteWorkflowDto.md)
119
129
  - [HealthResponse](docs/HealthResponse.md)
130
+ - [JobDefinitionDto](docs/JobDefinitionDto.md)
131
+ - [JobResultDto](docs/JobResultDto.md)
120
132
  - [RegisterFunctionBlockDto](docs/RegisterFunctionBlockDto.md)
133
+ - [WorkflowDto](docs/WorkflowDto.md)
121
134
 
122
135
 
123
136
  <a id="documentation-for-authorization"></a>
{neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/README.md RENAMED
@@ -4,7 +4,7 @@ Neops workflow engine API documentation
4
4
  This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
5
5
 
6
6
  - API version: 1.0
7
- - Package version: 0.31.0
7
+ - Package version: 0.35.0
8
8
  - Generator version: 7.9.0
9
9
  - Build package: org.openapitools.codegen.languages.PythonClientCodegen
10
10
 
@@ -66,12 +66,14 @@ configuration = neops_workflow_engine_client.Configuration(
66
66
  # Enter a context with an instance of the API client
67
67
  with neops_workflow_engine_client.ApiClient(configuration) as api_client:
68
68
  # Create an instance of the API class
69
- api_instance = neops_workflow_engine_client.DefaultApi(api_client)
69
+ api_instance = neops_workflow_engine_client.BlackboardApi(api_client)
70
70
 
71
71
  try:
72
- api_instance.app_controller_get_hello()
72
+ api_response = api_instance.blackboard_controller_poll_job()
73
+ print("The response of BlackboardApi->blackboard_controller_poll_job:\n")
74
+ pprint(api_response)
73
75
  except ApiException as e:
74
- print("Exception when calling DefaultApi->app_controller_get_hello: %s\n" % e)
76
+ print("Exception when calling BlackboardApi->blackboard_controller_poll_job: %s\n" % e)
75
77
 
76
78
  ```
77
79
 
@@ -81,18 +83,29 @@ All URIs are relative to *http://localhost*
81
83
 
82
84
  Class | Method | HTTP request | Description
83
85
  ------------ | ------------- | ------------- | -------------
86
+ *BlackboardApi* | [**blackboard_controller_poll_job**](docs/BlackboardApi.md#blackboard_controller_poll_job) | **GET** /blackboard/job |
87
+ *BlackboardApi* | [**blackboard_controller_push_job_result**](docs/BlackboardApi.md#blackboard_controller_push_job_result) | **POST** /blackboard/job/result |
84
88
  *DefaultApi* | [**app_controller_get_hello**](docs/DefaultApi.md#app_controller_get_hello) | **GET** / |
85
- *FunctionBlockApi* | [**function_blocks_controller_find_all**](docs/FunctionBlockApi.md#function_blocks_controller_find_all) | **GET** /function-blocks |
86
- *FunctionBlockApi* | [**function_blocks_controller_find_one**](docs/FunctionBlockApi.md#function_blocks_controller_find_one) | **GET** /function-blocks/{id} |
87
- *FunctionBlockApi* | [**function_blocks_controller_register**](docs/FunctionBlockApi.md#function_blocks_controller_register) | **POST** /function-blocks |
88
- *FunctionBlockApi* | [**function_blocks_controller_unregister**](docs/FunctionBlockApi.md#function_blocks_controller_unregister) | **DELETE** /function-blocks/{id} |
89
- *HealthApi* | [**health_controller_healthy**](docs/HealthApi.md#health_controller_healthy) | **GET** /health |
89
+ *FunctionBlockApi* | [**function_blocks_controller_find_all**](docs/FunctionBlockApi.md#function_blocks_controller_find_all) | **GET** /function-blocks/list | List all registered function blocks
90
+ *FunctionBlockApi* | [**function_blocks_controller_find_one**](docs/FunctionBlockApi.md#function_blocks_controller_find_one) | **GET** /function-blocks/{id} | Get a function block by id
91
+ *FunctionBlockApi* | [**function_blocks_controller_register**](docs/FunctionBlockApi.md#function_blocks_controller_register) | **POST** /function-blocks/register | Register a function block
92
+ *FunctionBlockApi* | [**function_blocks_controller_unregister**](docs/FunctionBlockApi.md#function_blocks_controller_unregister) | **DELETE** /function-blocks/{id} | Unregister a function block
93
+ *HealthApi* | [**health_controller_healthy**](docs/HealthApi.md#health_controller_healthy) | **GET** /health | Check health of task engine
94
+ *WorkflowsApi* | [**workflow_controller_execute**](docs/WorkflowsApi.md#workflow_controller_execute) | **POST** /workflow | Execute a workflow
95
+ *WorkflowsApi* | [**workflow_controller_ge_all**](docs/WorkflowsApi.md#workflow_controller_ge_all) | **GET** /workflow/failed | List all failed workflows
96
+ *WorkflowsApi* | [**workflow_controller_get_all**](docs/WorkflowsApi.md#workflow_controller_get_all) | **GET** /workflow/all | List all workflows
97
+ *WorkflowsApi* | [**workflow_controller_get_running**](docs/WorkflowsApi.md#workflow_controller_get_running) | **GET** /workflow/running | List all running workflows
98
+ *WorkflowsApi* | [**workflow_controller_remove**](docs/WorkflowsApi.md#workflow_controller_remove) | **DELETE** /workflow/{id} | Stop a workflow
90
99
 
91
100
 
92
101
  ## Documentation For Models
93
102
 
103
+ - [ExecuteWorkflowDto](docs/ExecuteWorkflowDto.md)
94
104
  - [HealthResponse](docs/HealthResponse.md)
105
+ - [JobDefinitionDto](docs/JobDefinitionDto.md)
106
+ - [JobResultDto](docs/JobResultDto.md)
95
107
  - [RegisterFunctionBlockDto](docs/RegisterFunctionBlockDto.md)
108
+ - [WorkflowDto](docs/WorkflowDto.md)
96
109
 
97
110
 
98
111
  <a id="documentation-for-authorization"></a>
{neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/neops_workflow_engine_client/__init__.py RENAMED
@@ -14,12 +14,14 @@
14
14
  """ # noqa: E501
15
15
 
16
16
 
17
- __version__ = "0.31.0"
17
+ __version__ = "0.35.0"
18
18
 
19
19
  # import apis into sdk package
20
+ from neops_workflow_engine_client.api.blackboard_api import BlackboardApi
20
21
  from neops_workflow_engine_client.api.default_api import DefaultApi
21
22
  from neops_workflow_engine_client.api.function_block_api import FunctionBlockApi
22
23
  from neops_workflow_engine_client.api.health_api import HealthApi
24
+ from neops_workflow_engine_client.api.workflows_api import WorkflowsApi
23
25
 
24
26
  # import ApiClient
25
27
  from neops_workflow_engine_client.api_response import ApiResponse
@@ -33,5 +35,9 @@ from neops_workflow_engine_client.exceptions import ApiAttributeError
33
35
  from neops_workflow_engine_client.exceptions import ApiException
34
36
 
35
37
  # import models into sdk package
38
+ from neops_workflow_engine_client.models.execute_workflow_dto import ExecuteWorkflowDto
36
39
  from neops_workflow_engine_client.models.health_response import HealthResponse
40
+ from neops_workflow_engine_client.models.job_definition_dto import JobDefinitionDto
41
+ from neops_workflow_engine_client.models.job_result_dto import JobResultDto
37
42
  from neops_workflow_engine_client.models.register_function_block_dto import RegisterFunctionBlockDto
43
+ from neops_workflow_engine_client.models.workflow_dto import WorkflowDto
{neops_workflow_engine_client-0.31.0 → neops_workflow_engine_client-0.35.0}/neops_workflow_engine_client/api/__init__.py RENAMED
@@ -1,7 +1,9 @@
1
1
  # flake8: noqa
2
2
 
3
3
  # import apis into api package
4
+ from neops_workflow_engine_client.api.blackboard_api import BlackboardApi
4
5
  from neops_workflow_engine_client.api.default_api import DefaultApi
5
6
  from neops_workflow_engine_client.api.function_block_api import FunctionBlockApi
6
7
  from neops_workflow_engine_client.api.health_api import HealthApi
8
+ from neops_workflow_engine_client.api.workflows_api import WorkflowsApi
7
9