Skip to content

Commit

Permalink
Merge pull request #9 from waylayio/chore/regenerate
Browse files Browse the repository at this point in the history
Regenerate rules sdk 🔁
  • Loading branch information
plankthom authored Dec 16, 2024
2 parents a7b8bfa + 95e1ab0 commit 46dc9a2
Show file tree
Hide file tree
Showing 244 changed files with 2,123 additions and 264 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/python.yml
Original file line number Diff line number Diff line change
Expand Up @@ -133,4 +133,4 @@ jobs:
- name: Publish to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
packages-dir: waylay-sdk-rules-types/dist
packages-dir: waylay-sdk-rules-types/dist
12 changes: 10 additions & 2 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
LICENSE.txt
Makefile
README.md
docs/ATasksBatchOperationSpecification.md
docs/AboutApi.md
docs/ActuatorExecutionResult.md
docs/ActuatorNode.md
Expand All @@ -19,6 +18,7 @@ docs/BatchTaskCommand.md
docs/BatchTaskCommandAllOfAction.md
docs/BatchTaskEntity.md
docs/BatchTaskQuery.md
docs/BatchTaskSpec.md
docs/BatchUpdatePlugin.md
docs/BatchUpdateProperties.md
docs/BatchUpdatePropertiesAllOfAction.md
Expand Down Expand Up @@ -78,8 +78,12 @@ docs/SuccessOperationResultValue.md
docs/TaskDefaultsElement.md
docs/TaskEntity.md
docs/TaskEntityPagingResult.md
docs/TaskEntityPagingResultAllOfValues.md
docs/TaskFromTemplate.md
docs/TaskListingInner.md
docs/TaskNodesApi.md
docs/TaskRuntimeInformation.md
docs/TaskRuntimeInformationAllOfHealth.md
docs/TaskScenarioType.md
docs/TaskSettings.md
docs/TaskSpecification.md
Expand Down Expand Up @@ -129,7 +133,6 @@ test/api/templates_api_test.py
test/conftest.py
test/openapi.py
test/types/__init__.py
test/types/a_tasks_batch_operation_specification_stub.py
test/types/actuator_execution_result_stub.py
test/types/actuator_node_stub.py
test/types/batch_id_query_stub.py
Expand All @@ -143,6 +146,7 @@ test/types/batch_task_command_all_of_action_stub.py
test/types/batch_task_command_stub.py
test/types/batch_task_entity_stub.py
test/types/batch_task_query_stub.py
test/types/batch_task_spec_stub.py
test/types/batch_task_stub.py
test/types/batch_update_plugin_stub.py
test/types/batch_update_properties_all_of_action_stub.py
Expand Down Expand Up @@ -198,9 +202,13 @@ test/types/stream_data_data_stub.py
test/types/stream_data_stub.py
test/types/success_operation_result_value_stub.py
test/types/task_defaults_element_stub.py
test/types/task_entity_paging_result_all_of_values_stub.py
test/types/task_entity_paging_result_stub.py
test/types/task_entity_stub.py
test/types/task_from_template_stub.py
test/types/task_listing_inner_stub.py
test/types/task_runtime_information_all_of_health_stub.py
test/types/task_runtime_information_stub.py
test/types/task_scenario_type_stub.py
test/types/task_settings_stub.py
test/types/task_specification_stub.py
Expand Down
2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.7.0
7.8.0
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
The REST api to manage rule tasks and rule templates in the Waylay platform.

This Python package is automatically generated based on the
Waylay Rules OpenAPI specification (API version: 6.5.0)
Waylay Rules OpenAPI specification (API version: 6.12.0)
For more information, please visit [the openapi specification](https://docs.waylay.io/openapi/public/redocly/rules.html).

It consists of two sub-packages that are both plugins for the waylay-sdk-core package.
Expand Down Expand Up @@ -69,6 +69,7 @@ Class | Method | HTTP request | Description
*TaskNodesApi* | [**get_states**](docs/TaskNodesApi.md#get_states) | **GET** /rules/v1/tasks/{taskId}/nodes/{nodeId}/states | Get Supported States
*TaskNodesApi* | [**get**](docs/TaskNodesApi.md#get) | **GET** /rules/v1/tasks/{taskId}/nodes/{nodeId} | Get Current States
*TaskNodesApi* | [**patch**](docs/TaskNodesApi.md#patch) | **PATCH** /rules/v1/tasks/{taskId}/nodes/{nodeId} | Set Node State
*TaskNodesApi* | [**post**](docs/TaskNodesApi.md#post) | **POST** /rules/v1/tasks/callback | Finalize Asynchronous Execution With Token
*TaskNodesApi* | [**update**](docs/TaskNodesApi.md#update) | **POST** /rules/v1/tasks/{taskId}/nodes/{nodeId} | Set Current State
*TasksApi* | [**create**](docs/TasksApi.md#create) | **POST** /rules/v1/tasks | Create Task
*TasksApi* | [**delete**](docs/TasksApi.md#delete) | **DELETE** /rules/v1/tasks/{taskId} | Delete Task
Expand All @@ -94,7 +95,6 @@ Class | Method | HTTP request | Description

## Documentation For Models

- [ATasksBatchOperationSpecification](docs/ATasksBatchOperationSpecification.md)
- [ActuatorExecutionResult](docs/ActuatorExecutionResult.md)
- [ActuatorNode](docs/ActuatorNode.md)
- [BatchIdQuery](docs/BatchIdQuery.md)
Expand All @@ -109,6 +109,7 @@ Class | Method | HTTP request | Description
- [BatchTaskCommandAllOfAction](docs/BatchTaskCommandAllOfAction.md)
- [BatchTaskEntity](docs/BatchTaskEntity.md)
- [BatchTaskQuery](docs/BatchTaskQuery.md)
- [BatchTaskSpec](docs/BatchTaskSpec.md)
- [BatchUpdatePlugin](docs/BatchUpdatePlugin.md)
- [BatchUpdateProperties](docs/BatchUpdateProperties.md)
- [BatchUpdatePropertiesAllOfAction](docs/BatchUpdatePropertiesAllOfAction.md)
Expand Down Expand Up @@ -165,7 +166,11 @@ Class | Method | HTTP request | Description
- [TaskDefaultsElement](docs/TaskDefaultsElement.md)
- [TaskEntity](docs/TaskEntity.md)
- [TaskEntityPagingResult](docs/TaskEntityPagingResult.md)
- [TaskEntityPagingResultAllOfValues](docs/TaskEntityPagingResultAllOfValues.md)
- [TaskFromTemplate](docs/TaskFromTemplate.md)
- [TaskListingInner](docs/TaskListingInner.md)
- [TaskRuntimeInformation](docs/TaskRuntimeInformation.md)
- [TaskRuntimeInformationAllOfHealth](docs/TaskRuntimeInformationAllOfHealth.md)
- [TaskScenarioType](docs/TaskScenarioType.md)
- [TaskSettings](docs/TaskSettings.md)
- [TaskSpecification](docs/TaskSpecification.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ATasksBatchOperationSpecification
# BatchTaskSpec


## Properties
Expand All @@ -13,19 +13,19 @@ Name | Type | Description | Notes
## Example

```python
from waylay.services.rules.models.a_tasks_batch_operation_specification import ATasksBatchOperationSpecification
from waylay.services.rules.models.batch_task_spec import BatchTaskSpec

# TODO update the JSON string below
json = "{}"
# create an instance of ATasksBatchOperationSpecification from a JSON string
a_tasks_batch_operation_specification_instance = ATasksBatchOperationSpecification.from_json(json)
# create an instance of BatchTaskSpec from a JSON string
batch_task_spec_instance = BatchTaskSpec.from_json(json)
# print the JSON string representation of the object
print ATasksBatchOperationSpecification.to_json()
print BatchTaskSpec.to_json()

# convert the object into a dict
a_tasks_batch_operation_specification_dict = a_tasks_batch_operation_specification_instance.to_dict()
# create an instance of ATasksBatchOperationSpecification from a dict
a_tasks_batch_operation_specification_form_dict = a_tasks_batch_operation_specification.from_dict(a_tasks_batch_operation_specification_dict)
batch_task_spec_dict = batch_task_spec_instance.to_dict()
# create an instance of BatchTaskSpec from a dict
batch_task_spec_form_dict = batch_task_spec.from_dict(batch_task_spec_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

Expand Down
3 changes: 3 additions & 0 deletions docs/PropertyUpdatesSpec.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**variables** | **object** | Set of variables to update. Will be merged with the current variables. To delete any of the current variables (and fall back to the default value from the template) set the value to `null` | [optional]
**tags** | **object** | Key-value pairs. Will be merged with the current tags. To delete any of the current tags set the value to `null` | [optional]
**gates_need_full_observation** | **bool** | Only evaluate gates when all inputs are observed | [optional] [default to False]
**reset_observations** | **bool** | | [optional] [default to True]
**parallel** | **bool** | | [optional] [default to True]

## Example

Expand Down
1 change: 1 addition & 0 deletions docs/ReplaceTemplate200Response.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Name | Type | Description | Notes
**tags** | **object** | Key-value pairs on which you can filter to finding templates back | [optional]
**variables** | [**List[VariableDeclaration]**](VariableDeclaration.md) | Variable declarations | [optional]
**task_defaults** | [**TaskDefaultsElement**](TaskDefaultsElement.md) | | [optional]
**description** | **str** | Description of the template | [optional]
**notes** | [**List[NoteElement]**](NoteElement.md) | List of notes as explanation for users | [optional]
**user** | **str** | Creation user mail address |
**create_time** | **int** | Timestamp expressed as milliseconds since 00:00:00 UTC on 1 January 1970, not counting leap seconds. |
Expand Down
2 changes: 1 addition & 1 deletion docs/TaskEntityPagingResult.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Name | Type | Description | Notes
**skip** | **int** | Number of items skipped before this page of results. | [default to 0]
**limit** | **int** | Size of one page of results. | [default to 10]
**total** | **int** | Total number of items matching the query of which this is one page of results. |
**values** | [**List[TaskEntity]**](TaskEntity.md) | | [optional]
**values** | [**List[TaskEntityPagingResultAllOfValues]**](TaskEntityPagingResultAllOfValues.md) | | [optional]

## Example

Expand Down
50 changes: 50 additions & 0 deletions docs/TaskEntityPagingResultAllOfValues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# TaskEntityPagingResultAllOfValues


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Unique task identifier |
**name** | **str** | |
**status** | [**TaskStatus**](TaskStatus.md) | |
**user** | **str** | Creation user mail address or 'system' for system generated tasks |
**create_time** | **int** | Timestamp expressed as milliseconds since 00:00:00 UTC on 1 January 1970, not counting leap seconds. |
**template** | **str** | Unique template identifier | [optional]
**network** | **object** | The graph, either from the template or from the task definition. Depending on the `format` query parameter either BN or simplified format |
**resource_ids** | **List[str]** | List of resources that are used in the task | [optional]
**tags** | **object** | Key-value pairs on which you can set at task creation and later filter tasks | [optional]
**type** | [**TaskScenarioType**](TaskScenarioType.md) | | [optional]
**reset_observations** | **bool** | | [optional]
**parallel** | **bool** | | [optional]
**gates_need_full_observation** | **bool** | | [optional]
**cron** | **str** | cron expression as defined in [Cron format](https://www.quartz-scheduler.org/documentation/quartz-1.8.6/tutorials/TutorialLesson06) | [optional]
**rrule** | **str** | RRule expression as defined in [RFC5545 3.8.5.3](https://www.rfc-editor.org/rfc/rfc5545#section-3.8.5.3) | [optional]
**time_zone** | **str** | Optional identifier of the time zone in which the schedule expression is to be interpreted | [optional]
**frequency** | **int** | polling frequency in milliseconds | [optional]
**finished_time** | **int** | Timestamp expressed as milliseconds since 00:00:00 UTC on 1 January 1970, not counting leap seconds. | [optional]
**invocation_count** | **int** | Number of times the task has been invoked | [optional]
**raw_data** | **object** | rawData of the task | [optional]
**last_execution_time** | **int** | Timestamp expressed as milliseconds since 00:00:00 UTC on 1 January 1970, not counting leap seconds. | [optional]
**health** | [**TaskRuntimeInformationAllOfHealth**](TaskRuntimeInformationAllOfHealth.md) | | [optional]

## Example

```python
from waylay.services.rules.models.task_entity_paging_result_all_of_values import TaskEntityPagingResultAllOfValues

# TODO update the JSON string below
json = "{}"
# create an instance of TaskEntityPagingResultAllOfValues from a JSON string
task_entity_paging_result_all_of_values_instance = TaskEntityPagingResultAllOfValues.from_json(json)
# print the JSON string representation of the object
print TaskEntityPagingResultAllOfValues.to_json()

# convert the object into a dict
task_entity_paging_result_all_of_values_dict = task_entity_paging_result_all_of_values_instance.to_dict()
# create an instance of TaskEntityPagingResultAllOfValues from a dict
task_entity_paging_result_all_of_values_form_dict = task_entity_paging_result_all_of_values.from_dict(task_entity_paging_result_all_of_values_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


50 changes: 50 additions & 0 deletions docs/TaskListingInner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# TaskListingInner


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Unique task identifier |
**name** | **str** | |
**status** | [**TaskStatus**](TaskStatus.md) | |
**user** | **str** | Creation user mail address or 'system' for system generated tasks |
**create_time** | **int** | Timestamp expressed as milliseconds since 00:00:00 UTC on 1 January 1970, not counting leap seconds. |
**template** | **str** | Unique template identifier | [optional]
**network** | **object** | The graph, either from the template or from the task definition. Depending on the `format` query parameter either BN or simplified format |
**resource_ids** | **List[str]** | List of resources that are used in the task | [optional]
**tags** | **object** | Key-value pairs on which you can set at task creation and later filter tasks | [optional]
**type** | [**TaskScenarioType**](TaskScenarioType.md) | | [optional]
**reset_observations** | **bool** | | [optional]
**parallel** | **bool** | | [optional]
**gates_need_full_observation** | **bool** | | [optional]
**cron** | **str** | cron expression as defined in [Cron format](https://www.quartz-scheduler.org/documentation/quartz-1.8.6/tutorials/TutorialLesson06) | [optional]
**rrule** | **str** | RRule expression as defined in [RFC5545 3.8.5.3](https://www.rfc-editor.org/rfc/rfc5545#section-3.8.5.3) | [optional]
**time_zone** | **str** | Optional identifier of the time zone in which the schedule expression is to be interpreted | [optional]
**frequency** | **int** | polling frequency in milliseconds | [optional]
**finished_time** | **int** | Timestamp expressed as milliseconds since 00:00:00 UTC on 1 January 1970, not counting leap seconds. | [optional]
**invocation_count** | **int** | Number of times the task has been invoked | [optional]
**raw_data** | **object** | rawData of the task | [optional]
**last_execution_time** | **int** | Timestamp expressed as milliseconds since 00:00:00 UTC on 1 January 1970, not counting leap seconds. | [optional]
**health** | [**TaskRuntimeInformationAllOfHealth**](TaskRuntimeInformationAllOfHealth.md) | | [optional]

## Example

```python
from waylay.services.rules.models.task_listing_inner import TaskListingInner

# TODO update the JSON string below
json = "{}"
# create an instance of TaskListingInner from a JSON string
task_listing_inner_instance = TaskListingInner.from_json(json)
# print the JSON string representation of the object
print TaskListingInner.to_json()

# convert the object into a dict
task_listing_inner_dict = task_listing_inner_instance.to_dict()
# create an instance of TaskListingInner from a dict
task_listing_inner_form_dict = task_listing_inner.from_dict(task_listing_inner_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


81 changes: 81 additions & 0 deletions docs/TaskNodesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Method | HTTP request | Description
[**get_states**](TaskNodesApi.md#get_states) | **GET** /rules/v1/tasks/{taskId}/nodes/{nodeId}/states | Get Supported States
[**get**](TaskNodesApi.md#get) | **GET** /rules/v1/tasks/{taskId}/nodes/{nodeId} | Get Current States
[**patch**](TaskNodesApi.md#patch) | **PATCH** /rules/v1/tasks/{taskId}/nodes/{nodeId} | Set Node State
[**post**](TaskNodesApi.md#post) | **POST** /rules/v1/tasks/callback | Finalize Asynchronous Execution With Token
[**update**](TaskNodesApi.md#update) | **POST** /rules/v1/tasks/{taskId}/nodes/{nodeId} | Set Current State

# **get_states**
Expand Down Expand Up @@ -226,6 +227,86 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected

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

# **post**
> post(
> query: PostQuery,
> headers
> ) -> object
Finalize Asynchronous Execution With Token

Post a result to finalize an asynchronous plugin execution using the onetime token from the callback url.

### Example

```python
from pprint import pprint

# Import the waylay-client from the waylay-sdk-core package
from waylay.sdk.client import WaylayClient
from waylay.sdk.api.api_exceptions import ApiError

# Intialize a waylay client instance
waylay_client = WaylayClient.from_profile()

# Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-rules-types` is installed
try:
# Finalize Asynchronous Execution With Token
# calls `POST /rules/v1/tasks/callback`
api_response = await waylay_client.rules.task_nodes.post(
# query parameters:
query = {
},
# non-json binary data: use a byte array or a generator of bytearray chuncks
content=b'my-binary-data',
# this operation supports multiple request content types: use `headers` to specify the one used
# alternatives:
headers = {
'content-type': 'application/octet-stream'
},
)
print("The response of rules.task_nodes.post:\n")
pprint(api_response)
except ApiError as e:
print("Exception when calling rules.task_nodes.post: %s\n" % e)
```

### Endpoint
```
POST /rules/v1/tasks/callback
```
### Parameters

Name | Type | API binding | Description | Notes
-------- | ----- | ------------- | ------------- | -------------
**content** | **[ContentRequest](Operation.md#req_arg_content)** | binary request body | Callback result to be passed to the plugin | [optional]
**query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | |
**query['access_token']** (dict) <br> **query.access_token** (Query) | **str** | query parameter `"access_token"` | Token that was given in the callback url |
**headers** | [HeaderTypes](Operation.md#req_headers) | request headers | |
**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType `application/octet-stream`

### Return type

Selected path param | Raw response param | Return Type | Description | Links
------------------- | ------------------ | ------------ | ----------- | -----
Literal[""] _(default)_ | False _(default)_ | **`object`** | |
str | False _(default)_ | **`Any`** | If any other string value for the selected path is provided, the exact type of the response will only be known at runtime. |
/ | True | `Response` | The raw http response object.

### HTTP request headers

- **Content-Type**: application/octet-stream
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Successful Response | - |
**403** | Invalid Token | - |

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

# **update**
> update(
> task_id: str,
Expand Down
Loading

0 comments on commit 46dc9a2

Please sign in to comment.