neops_workflow_engine_client 0.42.0b5__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 (71) hide show
  1. neops_workflow_engine_client-0.42.0b5/PKG-INFO +212 -0
  2. neops_workflow_engine_client-0.42.0b5/README.md +186 -0
  3. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/__init__.py +91 -0
  4. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/api/__init__.py +11 -0
  5. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/api/blackboard_api.py +1351 -0
  6. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/api/default_api.py +278 -0
  7. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/api/function_block_api.py +1412 -0
  8. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/api/health_api.py +281 -0
  9. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/api/schema_api.py +281 -0
  10. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/api/version_api.py +559 -0
  11. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/api/workflows_api.py +3105 -0
  12. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/api_client.py +797 -0
  13. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/api_response.py +21 -0
  14. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/configuration.py +575 -0
  15. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/exceptions.py +199 -0
  16. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/__init__.py +68 -0
  17. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/base_entity_dto.py +88 -0
  18. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/create_workflow_definition_dto.py +91 -0
  19. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/cron_configuration.py +101 -0
  20. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/crontab_configuration.py +99 -0
  21. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/db_update_dto.py +106 -0
  22. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/device_check_type_dto.py +109 -0
  23. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/device_config_type_dto.py +102 -0
  24. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/device_execution_result_type_dto.py +102 -0
  25. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/device_execution_type_dto.py +102 -0
  26. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/device_fact_type_dto.py +102 -0
  27. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/device_group_check_type_dto.py +123 -0
  28. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/device_group_fact_type_dto.py +109 -0
  29. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/device_group_type_dto.py +186 -0
  30. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/device_type_dto.py +423 -0
  31. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/entity_acquire_by_elastic_query.py +104 -0
  32. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/entity_acquire_by_expansion.py +102 -0
  33. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/entity_acquire_context.py +102 -0
  34. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/entity_acquire_reference.py +102 -0
  35. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/entity_create_dto.py +101 -0
  36. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/entity_delete_dto.py +99 -0
  37. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/entity_patch_dto.py +103 -0
  38. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/execute_workflow_dto.py +105 -0
  39. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/health_response.py +87 -0
  40. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/interface_type_dto.py +259 -0
  41. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/job_definition_dto.py +119 -0
  42. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/job_execution_context_dto.py +115 -0
  43. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/job_execution_result_db_updates_dto.py +95 -0
  44. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/job_execution_result_dto.py +97 -0
  45. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/job_log_dto.py +113 -0
  46. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/job_poll_dto.py +95 -0
  47. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/job_result_dto.py +102 -0
  48. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/job_show_result_dto.py +135 -0
  49. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/parametrized_function_block.py +160 -0
  50. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/platform_type_dto.py +102 -0
  51. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/register_function_block_dto.py +120 -0
  52. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/repeat_configuration.py +89 -0
  53. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/retry_configuration.py +89 -0
  54. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/role_device_group_type_dto.py +107 -0
  55. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/root_workflow.py +200 -0
  56. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/root_workflow_steps_inner.py +154 -0
  57. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/update_workflow_definition_dto.py +93 -0
  58. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/version_compatibility_request_dto.py +89 -0
  59. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/version_compatibility_response_dto.py +95 -0
  60. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/version_response_dto.py +87 -0
  61. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/versionable_dto.py +95 -0
  62. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/workflow_config.py +91 -0
  63. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/workflow_entry_dto.py +102 -0
  64. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/workflow_execution_parameters.py +89 -0
  65. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/workflow_execution_strategy.py +87 -0
  66. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/workflow_reference.py +162 -0
  67. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/workflow_reference_acquire_inner.py +165 -0
  68. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/models/workflow_reference_assert_inner.py +143 -0
  69. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/py.typed +0 -0
  70. neops_workflow_engine_client-0.42.0b5/neops_workflow_engine_client/rest.py +257 -0
  71. neops_workflow_engine_client-0.42.0b5/pyproject.toml +89 -0
@@ -0,0 +1,212 @@
1
+ Metadata-Version: 2.1
2
+ Name: neops_workflow_engine_client
3
+ Version: 0.42.0b5
4
+ Summary: Neops Workflow Engine
5
+ Home-page: https://github.com/GIT_USER_ID/GIT_REPO_ID
6
+ License: NoLicense
7
+ Keywords: OpenAPI,OpenAPI-Generator,Neops Workflow Engine
8
+ Author: OpenAPI Generator Community
9
+ Author-email: team@openapitools.org
10
+ Requires-Python: >=3.8,<4.0
11
+ Classifier: License :: Other/Proprietary License
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Programming Language :: Python :: 3.8
14
+ Classifier: Programming Language :: Python :: 3.9
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: 3.13
19
+ Requires-Dist: pydantic (>=2)
20
+ Requires-Dist: python-dateutil (>=2.8.2)
21
+ Requires-Dist: typing-extensions (>=4.7.1)
22
+ Requires-Dist: urllib3 (>=1.25.3,<3.0.0)
23
+ Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
24
+ Description-Content-Type: text/markdown
25
+
26
+ # Neops Workflow Engine Client
27
+ Neops workflow engine API documentation
28
+
29
+ This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
30
+
31
+ - API version: develop
32
+ - Package version: 0.42.0-beta.5
33
+ - Generator version: 7.10.0
34
+ - Build package: org.openapitools.codegen.languages.PythonClientCodegen
35
+
36
+ ## Requirements.
37
+
38
+ Python 3.8+
39
+
40
+ ## Installation & Usage
41
+ ### pip install
42
+
43
+ If the python package is hosted on a repository, you can install directly using:
44
+
45
+ ```sh
46
+ pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
47
+ ```
48
+ (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
49
+
50
+ Then import the package:
51
+ ```python
52
+ import neops_workflow_engine_client
53
+ ```
54
+
55
+ ### Setuptools
56
+
57
+ Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
58
+
59
+ ```sh
60
+ python setup.py install --user
61
+ ```
62
+ (or `sudo python setup.py install` to install the package for all users)
63
+
64
+ Then import the package:
65
+ ```python
66
+ import neops_workflow_engine_client
67
+ ```
68
+
69
+ ### Tests
70
+
71
+ Execute `pytest` to run the tests.
72
+
73
+ ## Getting Started
74
+
75
+ Please follow the [installation procedure](#installation--usage) and then run the following:
76
+
77
+ ```python
78
+
79
+ import neops_workflow_engine_client
80
+ from neops_workflow_engine_client.rest import ApiException
81
+ from pprint import pprint
82
+
83
+ # Defining the host is optional and defaults to http://localhost
84
+ # See configuration.py for a list of all supported configuration parameters.
85
+ configuration = neops_workflow_engine_client.Configuration(
86
+ host = "http://localhost"
87
+ )
88
+
89
+
90
+
91
+ # Enter a context with an instance of the API client
92
+ with neops_workflow_engine_client.ApiClient(configuration) as api_client:
93
+ # Create an instance of the API class
94
+ api_instance = neops_workflow_engine_client.BlackboardApi(api_client)
95
+ job_log_dto = neops_workflow_engine_client.JobLogDto() # JobLogDto |
96
+
97
+ try:
98
+ #
99
+ api_instance.blackboard_controller_add_job_log(job_log_dto)
100
+ except ApiException as e:
101
+ print("Exception when calling BlackboardApi->blackboard_controller_add_job_log: %s\n" % e)
102
+
103
+ ```
104
+
105
+ ## Documentation for API Endpoints
106
+
107
+ All URIs are relative to *http://localhost*
108
+
109
+ Class | Method | HTTP request | Description
110
+ ------------ | ------------- | ------------- | -------------
111
+ *BlackboardApi* | [**blackboard_controller_add_job_log**](docs/BlackboardApi.md#blackboard_controller_add_job_log) | **POST** /blackboard/job/log |
112
+ *BlackboardApi* | [**blackboard_controller_poll_job**](docs/BlackboardApi.md#blackboard_controller_poll_job) | **POST** /blackboard/job |
113
+ *BlackboardApi* | [**blackboard_controller_push_job_result**](docs/BlackboardApi.md#blackboard_controller_push_job_result) | **POST** /blackboard/job/result |
114
+ *BlackboardApi* | [**blackboard_controller_show_active_jobs**](docs/BlackboardApi.md#blackboard_controller_show_active_jobs) | **GET** /blackboard/jobs/active |
115
+ *BlackboardApi* | [**blackboard_controller_show_jobs**](docs/BlackboardApi.md#blackboard_controller_show_jobs) | **GET** /blackboard/jobs |
116
+ *DefaultApi* | [**app_controller_get_hello**](docs/DefaultApi.md#app_controller_get_hello) | **GET** / |
117
+ *FunctionBlockApi* | [**function_blocks_controller_find_all**](docs/FunctionBlockApi.md#function_blocks_controller_find_all) | **GET** /function-blocks/registrations/list | List all registered function blocks
118
+ *FunctionBlockApi* | [**function_blocks_controller_find_one_fb**](docs/FunctionBlockApi.md#function_blocks_controller_find_one_fb) | **GET** /function-blocks/{pkg}/{name}/{version} | Get a function block by ID
119
+ *FunctionBlockApi* | [**function_blocks_controller_find_one_fb_registration**](docs/FunctionBlockApi.md#function_blocks_controller_find_one_fb_registration) | **GET** /function-blocks/registrations/{pkg}/{name}/{version} | Get a function block registration by ID
120
+ *FunctionBlockApi* | [**function_blocks_controller_register**](docs/FunctionBlockApi.md#function_blocks_controller_register) | **POST** /function-blocks/register | Register a function block
121
+ *FunctionBlockApi* | [**function_blocks_controller_soft_delete**](docs/FunctionBlockApi.md#function_blocks_controller_soft_delete) | **DELETE** /function-blocks/{pkg}/{name}/{version} | Soft-delete a function block by ID
122
+ *HealthApi* | [**health_controller_healthy**](docs/HealthApi.md#health_controller_healthy) | **GET** /health | Check service health status
123
+ *SchemaApi* | [**schema_controller_get_schema**](docs/SchemaApi.md#schema_controller_get_schema) | **GET** /schema | Get the RootWorkflow JSON Schema of the workflow engine
124
+ *VersionApi* | [**version_controller_check_compatibility**](docs/VersionApi.md#version_controller_check_compatibility) | **POST** /version/compatibility | Check version compatibility
125
+ *VersionApi* | [**version_controller_get_version**](docs/VersionApi.md#version_controller_get_version) | **GET** /version | Get version of the service
126
+ *WorkflowsApi* | [**workflow_definition_controller_create**](docs/WorkflowsApi.md#workflow_definition_controller_create) | **POST** /workflow-definition | Create a Workflow definition
127
+ *WorkflowsApi* | [**workflow_definition_controller_find_all**](docs/WorkflowsApi.md#workflow_definition_controller_find_all) | **GET** /workflow-definition | Retrieve all workflow definitions
128
+ *WorkflowsApi* | [**workflow_definition_controller_find_by_sem_ver_string**](docs/WorkflowsApi.md#workflow_definition_controller_find_by_sem_ver_string) | **GET** /workflow-definition/find-by-semver/{semver} | Retrieve the closest matching workflow definition for a semantic version string
129
+ *WorkflowsApi* | [**workflow_definition_controller_find_one**](docs/WorkflowsApi.md#workflow_definition_controller_find_one) | **GET** /workflow-definition/{id} | Retrieve a workflow definitions by ID
130
+ *WorkflowsApi* | [**workflow_definition_controller_soft_delete**](docs/WorkflowsApi.md#workflow_definition_controller_soft_delete) | **DELETE** /workflow-definition/{id} | Soft-delete a workflow definition by ID
131
+ *WorkflowsApi* | [**workflow_definition_controller_update_workflow**](docs/WorkflowsApi.md#workflow_definition_controller_update_workflow) | **POST** /workflow-definition/update | Update a Workflow definition
132
+ *WorkflowsApi* | [**workflow_execution_controller_abort**](docs/WorkflowsApi.md#workflow_execution_controller_abort) | **DELETE** /workflow-execution/{id} | Abort a running workflow execution
133
+ *WorkflowsApi* | [**workflow_execution_controller_execute**](docs/WorkflowsApi.md#workflow_execution_controller_execute) | **POST** /workflow-execution | Add a workflow execution to the table
134
+ *WorkflowsApi* | [**workflow_execution_controller_find_all**](docs/WorkflowsApi.md#workflow_execution_controller_find_all) | **GET** /workflow-execution | Retrieve all workflow executions
135
+ *WorkflowsApi* | [**workflow_execution_controller_find_all_active**](docs/WorkflowsApi.md#workflow_execution_controller_find_all_active) | **GET** /workflow-execution/active | Retrieve all active workflow executions
136
+ *WorkflowsApi* | [**workflow_execution_controller_find_all_by_state**](docs/WorkflowsApi.md#workflow_execution_controller_find_all_by_state) | **GET** /workflow-execution/state/{state} | Retrieve all workflow executions by state
137
+ *WorkflowsApi* | [**workflow_execution_controller_find_one**](docs/WorkflowsApi.md#workflow_execution_controller_find_one) | **GET** /workflow-execution/id/{id} | Retrieve a specific workflow execution by ID
138
+
139
+
140
+ ## Documentation For Models
141
+
142
+ - [BaseEntityDto](docs/BaseEntityDto.md)
143
+ - [CreateWorkflowDefinitionDto](docs/CreateWorkflowDefinitionDto.md)
144
+ - [CronConfiguration](docs/CronConfiguration.md)
145
+ - [CrontabConfiguration](docs/CrontabConfiguration.md)
146
+ - [DbUpdateDto](docs/DbUpdateDto.md)
147
+ - [DeviceCheckTypeDto](docs/DeviceCheckTypeDto.md)
148
+ - [DeviceConfigTypeDto](docs/DeviceConfigTypeDto.md)
149
+ - [DeviceExecutionResultTypeDto](docs/DeviceExecutionResultTypeDto.md)
150
+ - [DeviceExecutionTypeDto](docs/DeviceExecutionTypeDto.md)
151
+ - [DeviceFactTypeDto](docs/DeviceFactTypeDto.md)
152
+ - [DeviceGroupCheckTypeDto](docs/DeviceGroupCheckTypeDto.md)
153
+ - [DeviceGroupFactTypeDto](docs/DeviceGroupFactTypeDto.md)
154
+ - [DeviceGroupTypeDto](docs/DeviceGroupTypeDto.md)
155
+ - [DeviceTypeDto](docs/DeviceTypeDto.md)
156
+ - [EntityAcquireByElasticQuery](docs/EntityAcquireByElasticQuery.md)
157
+ - [EntityAcquireByExpansion](docs/EntityAcquireByExpansion.md)
158
+ - [EntityAcquireContext](docs/EntityAcquireContext.md)
159
+ - [EntityAcquireReference](docs/EntityAcquireReference.md)
160
+ - [EntityCreateDto](docs/EntityCreateDto.md)
161
+ - [EntityDeleteDto](docs/EntityDeleteDto.md)
162
+ - [EntityPatchDto](docs/EntityPatchDto.md)
163
+ - [ExecuteWorkflowDto](docs/ExecuteWorkflowDto.md)
164
+ - [HealthResponse](docs/HealthResponse.md)
165
+ - [InterfaceTypeDto](docs/InterfaceTypeDto.md)
166
+ - [JobDefinitionDto](docs/JobDefinitionDto.md)
167
+ - [JobExecutionContextDto](docs/JobExecutionContextDto.md)
168
+ - [JobExecutionResultDbUpdatesDto](docs/JobExecutionResultDbUpdatesDto.md)
169
+ - [JobExecutionResultDto](docs/JobExecutionResultDto.md)
170
+ - [JobLogDto](docs/JobLogDto.md)
171
+ - [JobPollDto](docs/JobPollDto.md)
172
+ - [JobResultDto](docs/JobResultDto.md)
173
+ - [JobShowResultDto](docs/JobShowResultDto.md)
174
+ - [ParametrizedFunctionBlock](docs/ParametrizedFunctionBlock.md)
175
+ - [PlatformTypeDto](docs/PlatformTypeDto.md)
176
+ - [RegisterFunctionBlockDto](docs/RegisterFunctionBlockDto.md)
177
+ - [RepeatConfiguration](docs/RepeatConfiguration.md)
178
+ - [RetryConfiguration](docs/RetryConfiguration.md)
179
+ - [RoleDeviceGroupTypeDto](docs/RoleDeviceGroupTypeDto.md)
180
+ - [RootWorkflow](docs/RootWorkflow.md)
181
+ - [RootWorkflowStepsInner](docs/RootWorkflowStepsInner.md)
182
+ - [UpdateWorkflowDefinitionDto](docs/UpdateWorkflowDefinitionDto.md)
183
+ - [VersionCompatibilityRequestDto](docs/VersionCompatibilityRequestDto.md)
184
+ - [VersionCompatibilityResponseDto](docs/VersionCompatibilityResponseDto.md)
185
+ - [VersionResponseDto](docs/VersionResponseDto.md)
186
+ - [VersionableDto](docs/VersionableDto.md)
187
+ - [WorkflowConfig](docs/WorkflowConfig.md)
188
+ - [WorkflowEntryDto](docs/WorkflowEntryDto.md)
189
+ - [WorkflowExecutionParameters](docs/WorkflowExecutionParameters.md)
190
+ - [WorkflowExecutionStrategy](docs/WorkflowExecutionStrategy.md)
191
+ - [WorkflowReference](docs/WorkflowReference.md)
192
+ - [WorkflowReferenceAcquireInner](docs/WorkflowReferenceAcquireInner.md)
193
+ - [WorkflowReferenceAssertInner](docs/WorkflowReferenceAssertInner.md)
194
+
195
+
196
+ <a id="documentation-for-authorization"></a>
197
+ ## Documentation For Authorization
198
+
199
+
200
+ Authentication schemes defined for the API:
201
+ <a id="JWT"></a>
202
+ ### JWT
203
+
204
+ - **Type**: Bearer authentication (JWT)
205
+
206
+
207
+ ## Author
208
+
209
+
210
+
211
+
212
+
@@ -0,0 +1,186 @@
1
+ # Neops Workflow Engine Client
2
+ Neops workflow engine API documentation
3
+
4
+ This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
5
+
6
+ - API version: develop
7
+ - Package version: 0.42.0-beta.5
8
+ - Generator version: 7.10.0
9
+ - Build package: org.openapitools.codegen.languages.PythonClientCodegen
10
+
11
+ ## Requirements.
12
+
13
+ Python 3.8+
14
+
15
+ ## Installation & Usage
16
+ ### pip install
17
+
18
+ If the python package is hosted on a repository, you can install directly using:
19
+
20
+ ```sh
21
+ pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
22
+ ```
23
+ (you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
24
+
25
+ Then import the package:
26
+ ```python
27
+ import neops_workflow_engine_client
28
+ ```
29
+
30
+ ### Setuptools
31
+
32
+ Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
33
+
34
+ ```sh
35
+ python setup.py install --user
36
+ ```
37
+ (or `sudo python setup.py install` to install the package for all users)
38
+
39
+ Then import the package:
40
+ ```python
41
+ import neops_workflow_engine_client
42
+ ```
43
+
44
+ ### Tests
45
+
46
+ Execute `pytest` to run the tests.
47
+
48
+ ## Getting Started
49
+
50
+ Please follow the [installation procedure](#installation--usage) and then run the following:
51
+
52
+ ```python
53
+
54
+ import neops_workflow_engine_client
55
+ from neops_workflow_engine_client.rest import ApiException
56
+ from pprint import pprint
57
+
58
+ # Defining the host is optional and defaults to http://localhost
59
+ # See configuration.py for a list of all supported configuration parameters.
60
+ configuration = neops_workflow_engine_client.Configuration(
61
+ host = "http://localhost"
62
+ )
63
+
64
+
65
+
66
+ # Enter a context with an instance of the API client
67
+ with neops_workflow_engine_client.ApiClient(configuration) as api_client:
68
+ # Create an instance of the API class
69
+ api_instance = neops_workflow_engine_client.BlackboardApi(api_client)
70
+ job_log_dto = neops_workflow_engine_client.JobLogDto() # JobLogDto |
71
+
72
+ try:
73
+ #
74
+ api_instance.blackboard_controller_add_job_log(job_log_dto)
75
+ except ApiException as e:
76
+ print("Exception when calling BlackboardApi->blackboard_controller_add_job_log: %s\n" % e)
77
+
78
+ ```
79
+
80
+ ## Documentation for API Endpoints
81
+
82
+ All URIs are relative to *http://localhost*
83
+
84
+ Class | Method | HTTP request | Description
85
+ ------------ | ------------- | ------------- | -------------
86
+ *BlackboardApi* | [**blackboard_controller_add_job_log**](docs/BlackboardApi.md#blackboard_controller_add_job_log) | **POST** /blackboard/job/log |
87
+ *BlackboardApi* | [**blackboard_controller_poll_job**](docs/BlackboardApi.md#blackboard_controller_poll_job) | **POST** /blackboard/job |
88
+ *BlackboardApi* | [**blackboard_controller_push_job_result**](docs/BlackboardApi.md#blackboard_controller_push_job_result) | **POST** /blackboard/job/result |
89
+ *BlackboardApi* | [**blackboard_controller_show_active_jobs**](docs/BlackboardApi.md#blackboard_controller_show_active_jobs) | **GET** /blackboard/jobs/active |
90
+ *BlackboardApi* | [**blackboard_controller_show_jobs**](docs/BlackboardApi.md#blackboard_controller_show_jobs) | **GET** /blackboard/jobs |
91
+ *DefaultApi* | [**app_controller_get_hello**](docs/DefaultApi.md#app_controller_get_hello) | **GET** / |
92
+ *FunctionBlockApi* | [**function_blocks_controller_find_all**](docs/FunctionBlockApi.md#function_blocks_controller_find_all) | **GET** /function-blocks/registrations/list | List all registered function blocks
93
+ *FunctionBlockApi* | [**function_blocks_controller_find_one_fb**](docs/FunctionBlockApi.md#function_blocks_controller_find_one_fb) | **GET** /function-blocks/{pkg}/{name}/{version} | Get a function block by ID
94
+ *FunctionBlockApi* | [**function_blocks_controller_find_one_fb_registration**](docs/FunctionBlockApi.md#function_blocks_controller_find_one_fb_registration) | **GET** /function-blocks/registrations/{pkg}/{name}/{version} | Get a function block registration by ID
95
+ *FunctionBlockApi* | [**function_blocks_controller_register**](docs/FunctionBlockApi.md#function_blocks_controller_register) | **POST** /function-blocks/register | Register a function block
96
+ *FunctionBlockApi* | [**function_blocks_controller_soft_delete**](docs/FunctionBlockApi.md#function_blocks_controller_soft_delete) | **DELETE** /function-blocks/{pkg}/{name}/{version} | Soft-delete a function block by ID
97
+ *HealthApi* | [**health_controller_healthy**](docs/HealthApi.md#health_controller_healthy) | **GET** /health | Check service health status
98
+ *SchemaApi* | [**schema_controller_get_schema**](docs/SchemaApi.md#schema_controller_get_schema) | **GET** /schema | Get the RootWorkflow JSON Schema of the workflow engine
99
+ *VersionApi* | [**version_controller_check_compatibility**](docs/VersionApi.md#version_controller_check_compatibility) | **POST** /version/compatibility | Check version compatibility
100
+ *VersionApi* | [**version_controller_get_version**](docs/VersionApi.md#version_controller_get_version) | **GET** /version | Get version of the service
101
+ *WorkflowsApi* | [**workflow_definition_controller_create**](docs/WorkflowsApi.md#workflow_definition_controller_create) | **POST** /workflow-definition | Create a Workflow definition
102
+ *WorkflowsApi* | [**workflow_definition_controller_find_all**](docs/WorkflowsApi.md#workflow_definition_controller_find_all) | **GET** /workflow-definition | Retrieve all workflow definitions
103
+ *WorkflowsApi* | [**workflow_definition_controller_find_by_sem_ver_string**](docs/WorkflowsApi.md#workflow_definition_controller_find_by_sem_ver_string) | **GET** /workflow-definition/find-by-semver/{semver} | Retrieve the closest matching workflow definition for a semantic version string
104
+ *WorkflowsApi* | [**workflow_definition_controller_find_one**](docs/WorkflowsApi.md#workflow_definition_controller_find_one) | **GET** /workflow-definition/{id} | Retrieve a workflow definitions by ID
105
+ *WorkflowsApi* | [**workflow_definition_controller_soft_delete**](docs/WorkflowsApi.md#workflow_definition_controller_soft_delete) | **DELETE** /workflow-definition/{id} | Soft-delete a workflow definition by ID
106
+ *WorkflowsApi* | [**workflow_definition_controller_update_workflow**](docs/WorkflowsApi.md#workflow_definition_controller_update_workflow) | **POST** /workflow-definition/update | Update a Workflow definition
107
+ *WorkflowsApi* | [**workflow_execution_controller_abort**](docs/WorkflowsApi.md#workflow_execution_controller_abort) | **DELETE** /workflow-execution/{id} | Abort a running workflow execution
108
+ *WorkflowsApi* | [**workflow_execution_controller_execute**](docs/WorkflowsApi.md#workflow_execution_controller_execute) | **POST** /workflow-execution | Add a workflow execution to the table
109
+ *WorkflowsApi* | [**workflow_execution_controller_find_all**](docs/WorkflowsApi.md#workflow_execution_controller_find_all) | **GET** /workflow-execution | Retrieve all workflow executions
110
+ *WorkflowsApi* | [**workflow_execution_controller_find_all_active**](docs/WorkflowsApi.md#workflow_execution_controller_find_all_active) | **GET** /workflow-execution/active | Retrieve all active workflow executions
111
+ *WorkflowsApi* | [**workflow_execution_controller_find_all_by_state**](docs/WorkflowsApi.md#workflow_execution_controller_find_all_by_state) | **GET** /workflow-execution/state/{state} | Retrieve all workflow executions by state
112
+ *WorkflowsApi* | [**workflow_execution_controller_find_one**](docs/WorkflowsApi.md#workflow_execution_controller_find_one) | **GET** /workflow-execution/id/{id} | Retrieve a specific workflow execution by ID
113
+
114
+
115
+ ## Documentation For Models
116
+
117
+ - [BaseEntityDto](docs/BaseEntityDto.md)
118
+ - [CreateWorkflowDefinitionDto](docs/CreateWorkflowDefinitionDto.md)
119
+ - [CronConfiguration](docs/CronConfiguration.md)
120
+ - [CrontabConfiguration](docs/CrontabConfiguration.md)
121
+ - [DbUpdateDto](docs/DbUpdateDto.md)
122
+ - [DeviceCheckTypeDto](docs/DeviceCheckTypeDto.md)
123
+ - [DeviceConfigTypeDto](docs/DeviceConfigTypeDto.md)
124
+ - [DeviceExecutionResultTypeDto](docs/DeviceExecutionResultTypeDto.md)
125
+ - [DeviceExecutionTypeDto](docs/DeviceExecutionTypeDto.md)
126
+ - [DeviceFactTypeDto](docs/DeviceFactTypeDto.md)
127
+ - [DeviceGroupCheckTypeDto](docs/DeviceGroupCheckTypeDto.md)
128
+ - [DeviceGroupFactTypeDto](docs/DeviceGroupFactTypeDto.md)
129
+ - [DeviceGroupTypeDto](docs/DeviceGroupTypeDto.md)
130
+ - [DeviceTypeDto](docs/DeviceTypeDto.md)
131
+ - [EntityAcquireByElasticQuery](docs/EntityAcquireByElasticQuery.md)
132
+ - [EntityAcquireByExpansion](docs/EntityAcquireByExpansion.md)
133
+ - [EntityAcquireContext](docs/EntityAcquireContext.md)
134
+ - [EntityAcquireReference](docs/EntityAcquireReference.md)
135
+ - [EntityCreateDto](docs/EntityCreateDto.md)
136
+ - [EntityDeleteDto](docs/EntityDeleteDto.md)
137
+ - [EntityPatchDto](docs/EntityPatchDto.md)
138
+ - [ExecuteWorkflowDto](docs/ExecuteWorkflowDto.md)
139
+ - [HealthResponse](docs/HealthResponse.md)
140
+ - [InterfaceTypeDto](docs/InterfaceTypeDto.md)
141
+ - [JobDefinitionDto](docs/JobDefinitionDto.md)
142
+ - [JobExecutionContextDto](docs/JobExecutionContextDto.md)
143
+ - [JobExecutionResultDbUpdatesDto](docs/JobExecutionResultDbUpdatesDto.md)
144
+ - [JobExecutionResultDto](docs/JobExecutionResultDto.md)
145
+ - [JobLogDto](docs/JobLogDto.md)
146
+ - [JobPollDto](docs/JobPollDto.md)
147
+ - [JobResultDto](docs/JobResultDto.md)
148
+ - [JobShowResultDto](docs/JobShowResultDto.md)
149
+ - [ParametrizedFunctionBlock](docs/ParametrizedFunctionBlock.md)
150
+ - [PlatformTypeDto](docs/PlatformTypeDto.md)
151
+ - [RegisterFunctionBlockDto](docs/RegisterFunctionBlockDto.md)
152
+ - [RepeatConfiguration](docs/RepeatConfiguration.md)
153
+ - [RetryConfiguration](docs/RetryConfiguration.md)
154
+ - [RoleDeviceGroupTypeDto](docs/RoleDeviceGroupTypeDto.md)
155
+ - [RootWorkflow](docs/RootWorkflow.md)
156
+ - [RootWorkflowStepsInner](docs/RootWorkflowStepsInner.md)
157
+ - [UpdateWorkflowDefinitionDto](docs/UpdateWorkflowDefinitionDto.md)
158
+ - [VersionCompatibilityRequestDto](docs/VersionCompatibilityRequestDto.md)
159
+ - [VersionCompatibilityResponseDto](docs/VersionCompatibilityResponseDto.md)
160
+ - [VersionResponseDto](docs/VersionResponseDto.md)
161
+ - [VersionableDto](docs/VersionableDto.md)
162
+ - [WorkflowConfig](docs/WorkflowConfig.md)
163
+ - [WorkflowEntryDto](docs/WorkflowEntryDto.md)
164
+ - [WorkflowExecutionParameters](docs/WorkflowExecutionParameters.md)
165
+ - [WorkflowExecutionStrategy](docs/WorkflowExecutionStrategy.md)
166
+ - [WorkflowReference](docs/WorkflowReference.md)
167
+ - [WorkflowReferenceAcquireInner](docs/WorkflowReferenceAcquireInner.md)
168
+ - [WorkflowReferenceAssertInner](docs/WorkflowReferenceAssertInner.md)
169
+
170
+
171
+ <a id="documentation-for-authorization"></a>
172
+ ## Documentation For Authorization
173
+
174
+
175
+ Authentication schemes defined for the API:
176
+ <a id="JWT"></a>
177
+ ### JWT
178
+
179
+ - **Type**: Bearer authentication (JWT)
180
+
181
+
182
+ ## Author
183
+
184
+
185
+
186
+
@@ -0,0 +1,91 @@
1
+ # coding: utf-8
2
+
3
+ # flake8: noqa
4
+
5
+ """
6
+ Neops Workflow Engine
7
+
8
+ Neops workflow engine API documentation
9
+
10
+ The version of the OpenAPI document: develop
11
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
12
+
13
+ Do not edit the class manually.
14
+ """ # noqa: E501
15
+
16
+
17
+ __version__ = "0.42.0-beta.5"
18
+
19
+ # import apis into sdk package
20
+ from neops_workflow_engine_client.api.blackboard_api import BlackboardApi
21
+ from neops_workflow_engine_client.api.default_api import DefaultApi
22
+ from neops_workflow_engine_client.api.function_block_api import FunctionBlockApi
23
+ from neops_workflow_engine_client.api.health_api import HealthApi
24
+ from neops_workflow_engine_client.api.schema_api import SchemaApi
25
+ from neops_workflow_engine_client.api.version_api import VersionApi
26
+ from neops_workflow_engine_client.api.workflows_api import WorkflowsApi
27
+
28
+ # import ApiClient
29
+ from neops_workflow_engine_client.api_response import ApiResponse
30
+ from neops_workflow_engine_client.api_client import ApiClient
31
+ from neops_workflow_engine_client.configuration import Configuration
32
+ from neops_workflow_engine_client.exceptions import OpenApiException
33
+ from neops_workflow_engine_client.exceptions import ApiTypeError
34
+ from neops_workflow_engine_client.exceptions import ApiValueError
35
+ from neops_workflow_engine_client.exceptions import ApiKeyError
36
+ from neops_workflow_engine_client.exceptions import ApiAttributeError
37
+ from neops_workflow_engine_client.exceptions import ApiException
38
+
39
+ # import models into sdk package
40
+ from neops_workflow_engine_client.models.base_entity_dto import BaseEntityDto
41
+ from neops_workflow_engine_client.models.create_workflow_definition_dto import CreateWorkflowDefinitionDto
42
+ from neops_workflow_engine_client.models.cron_configuration import CronConfiguration
43
+ from neops_workflow_engine_client.models.crontab_configuration import CrontabConfiguration
44
+ from neops_workflow_engine_client.models.db_update_dto import DbUpdateDto
45
+ from neops_workflow_engine_client.models.device_check_type_dto import DeviceCheckTypeDto
46
+ from neops_workflow_engine_client.models.device_config_type_dto import DeviceConfigTypeDto
47
+ from neops_workflow_engine_client.models.device_execution_result_type_dto import DeviceExecutionResultTypeDto
48
+ from neops_workflow_engine_client.models.device_execution_type_dto import DeviceExecutionTypeDto
49
+ from neops_workflow_engine_client.models.device_fact_type_dto import DeviceFactTypeDto
50
+ from neops_workflow_engine_client.models.device_group_check_type_dto import DeviceGroupCheckTypeDto
51
+ from neops_workflow_engine_client.models.device_group_fact_type_dto import DeviceGroupFactTypeDto
52
+ from neops_workflow_engine_client.models.device_group_type_dto import DeviceGroupTypeDto
53
+ from neops_workflow_engine_client.models.device_type_dto import DeviceTypeDto
54
+ from neops_workflow_engine_client.models.entity_acquire_by_elastic_query import EntityAcquireByElasticQuery
55
+ from neops_workflow_engine_client.models.entity_acquire_by_expansion import EntityAcquireByExpansion
56
+ from neops_workflow_engine_client.models.entity_acquire_context import EntityAcquireContext
57
+ from neops_workflow_engine_client.models.entity_acquire_reference import EntityAcquireReference
58
+ from neops_workflow_engine_client.models.entity_create_dto import EntityCreateDto
59
+ from neops_workflow_engine_client.models.entity_delete_dto import EntityDeleteDto
60
+ from neops_workflow_engine_client.models.entity_patch_dto import EntityPatchDto
61
+ from neops_workflow_engine_client.models.execute_workflow_dto import ExecuteWorkflowDto
62
+ from neops_workflow_engine_client.models.health_response import HealthResponse
63
+ from neops_workflow_engine_client.models.interface_type_dto import InterfaceTypeDto
64
+ from neops_workflow_engine_client.models.job_definition_dto import JobDefinitionDto
65
+ from neops_workflow_engine_client.models.job_execution_context_dto import JobExecutionContextDto
66
+ from neops_workflow_engine_client.models.job_execution_result_db_updates_dto import JobExecutionResultDbUpdatesDto
67
+ from neops_workflow_engine_client.models.job_execution_result_dto import JobExecutionResultDto
68
+ from neops_workflow_engine_client.models.job_log_dto import JobLogDto
69
+ from neops_workflow_engine_client.models.job_poll_dto import JobPollDto
70
+ from neops_workflow_engine_client.models.job_result_dto import JobResultDto
71
+ from neops_workflow_engine_client.models.job_show_result_dto import JobShowResultDto
72
+ from neops_workflow_engine_client.models.parametrized_function_block import ParametrizedFunctionBlock
73
+ from neops_workflow_engine_client.models.platform_type_dto import PlatformTypeDto
74
+ from neops_workflow_engine_client.models.register_function_block_dto import RegisterFunctionBlockDto
75
+ from neops_workflow_engine_client.models.repeat_configuration import RepeatConfiguration
76
+ from neops_workflow_engine_client.models.retry_configuration import RetryConfiguration
77
+ from neops_workflow_engine_client.models.role_device_group_type_dto import RoleDeviceGroupTypeDto
78
+ from neops_workflow_engine_client.models.root_workflow import RootWorkflow
79
+ from neops_workflow_engine_client.models.root_workflow_steps_inner import RootWorkflowStepsInner
80
+ from neops_workflow_engine_client.models.update_workflow_definition_dto import UpdateWorkflowDefinitionDto
81
+ from neops_workflow_engine_client.models.version_compatibility_request_dto import VersionCompatibilityRequestDto
82
+ from neops_workflow_engine_client.models.version_compatibility_response_dto import VersionCompatibilityResponseDto
83
+ from neops_workflow_engine_client.models.version_response_dto import VersionResponseDto
84
+ from neops_workflow_engine_client.models.versionable_dto import VersionableDto
85
+ from neops_workflow_engine_client.models.workflow_config import WorkflowConfig
86
+ from neops_workflow_engine_client.models.workflow_entry_dto import WorkflowEntryDto
87
+ from neops_workflow_engine_client.models.workflow_execution_parameters import WorkflowExecutionParameters
88
+ from neops_workflow_engine_client.models.workflow_execution_strategy import WorkflowExecutionStrategy
89
+ from neops_workflow_engine_client.models.workflow_reference import WorkflowReference
90
+ from neops_workflow_engine_client.models.workflow_reference_acquire_inner import WorkflowReferenceAcquireInner
91
+ from neops_workflow_engine_client.models.workflow_reference_assert_inner import WorkflowReferenceAssertInner
@@ -0,0 +1,11 @@
1
+ # flake8: noqa
2
+
3
+ # import apis into api package
4
+ from neops_workflow_engine_client.api.blackboard_api import BlackboardApi
5
+ from neops_workflow_engine_client.api.default_api import DefaultApi
6
+ from neops_workflow_engine_client.api.function_block_api import FunctionBlockApi
7
+ from neops_workflow_engine_client.api.health_api import HealthApi
8
+ from neops_workflow_engine_client.api.schema_api import SchemaApi
9
+ from neops_workflow_engine_client.api.version_api import VersionApi
10
+ from neops_workflow_engine_client.api.workflows_api import WorkflowsApi
11
+