Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Regenerate registry sdk 🔁 #24

Merged
merged 1 commit into from
Aug 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,10 @@ docs/DeploySpec.md
docs/DeploySpecOpenfaasSpec.md
docs/DeployType.md
docs/DeprecatePreviousPolicy.md
docs/DeprecatePreviousPolicyAnyOf.md
docs/DeprecatePreviousPolicyAnyOf1.md
docs/DeprecatePreviousPolicyAnyOf2.md
docs/DeprecatePreviousPolicyAnyOf3.md
docs/Documentation.md
docs/DocumentationProperty.md
docs/EntityWithLinksIKfservingResponseV2.md
Expand Down Expand Up @@ -83,6 +87,10 @@ docs/GetPlugResponseV2LinksPublished.md
docs/GetWebscriptResponseV2.md
docs/GetWebscriptResponseV2Links.md
docs/HALLink.md
docs/HALLinkHref.md
docs/HALLinks.md
docs/InvocationAttributes.md
docs/InvocationAttributesAuth.md
docs/InvokeHALLink.md
docs/JobAndFunctionHALLink.md
docs/JobCause.md
Expand Down Expand Up @@ -159,6 +167,7 @@ docs/PlugPropertyFormatType.md
docs/PlugResponseV2.md
docs/PlugType.md
docs/PlugVersionsResponseV2.md
docs/PlugWithInvocationResponseV2.md
docs/PlugsApi.md
docs/PostModelJobAsyncResponseV2.md
docs/PostModelJobSyncResponseV2.md
Expand All @@ -173,6 +182,7 @@ docs/RebuildModelSyncResponseV2.md
docs/RebuildPlugAsyncResponseV2.md
docs/RebuildPlugSyncResponseV2.md
docs/RebuildPolicy.md
docs/RebuildRequestV2.md
docs/RebuildWebscriptAsyncResponseV2.md
docs/RebuildWebscriptSyncResponseV2.md
docs/RegistryErrorResponse.md
Expand Down Expand Up @@ -301,6 +311,10 @@ test/types/deploy_spec_openfaas_spec_stub.py
test/types/deploy_spec_stub.py
test/types/deploy_stub.py
test/types/deploy_type_stub.py
test/types/deprecate_previous_policy_any_of1_stub.py
test/types/deprecate_previous_policy_any_of2_stub.py
test/types/deprecate_previous_policy_any_of3_stub.py
test/types/deprecate_previous_policy_any_of_stub.py
test/types/deprecate_previous_policy_stub.py
test/types/documentation_property_stub.py
test/types/documentation_stub.py
Expand Down Expand Up @@ -329,7 +343,11 @@ test/types/get_plug_response_v2_links_stub.py
test/types/get_plug_response_v2_stub.py
test/types/get_webscript_response_v2_links_stub.py
test/types/get_webscript_response_v2_stub.py
test/types/hal_link_href_stub.py
test/types/hal_link_stub.py
test/types/hal_links_stub.py
test/types/invocation_attributes_auth_stub.py
test/types/invocation_attributes_stub.py
test/types/invoke_hal_link_stub.py
test/types/job_and_function_hal_link_stub.py
test/types/job_cause_stub.py
Expand Down Expand Up @@ -403,6 +421,7 @@ test/types/plug_response_v2_stub.py
test/types/plug_stub.py
test/types/plug_type_stub.py
test/types/plug_versions_response_v2_stub.py
test/types/plug_with_invocation_response_v2_stub.py
test/types/post_model_job_async_response_v2_stub.py
test/types/post_model_job_sync_response_v2_stub.py
test/types/post_plug_job_async_response_v2_stub.py
Expand All @@ -416,6 +435,7 @@ test/types/rebuild_model_sync_response_v2_stub.py
test/types/rebuild_plug_async_response_v2_stub.py
test/types/rebuild_plug_sync_response_v2_stub.py
test/types/rebuild_policy_stub.py
test/types/rebuild_request_v2_stub.py
test/types/rebuild_webscript_async_response_v2_stub.py
test/types/rebuild_webscript_sync_response_v2_stub.py
test/types/registry_error_response_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.2.0
7.7.0
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
V2 API to build and deploy Waylay functions (plugs, webscripts, BYOML models).

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

It consists of two sub-packages that are both plugins for the waylay-sdk-core package.
Expand All @@ -13,13 +13,16 @@ It consists of two sub-packages that are both plugins for the waylay-sdk-core pa
This package requires Python 3.9+.

## Installation
Typically this package is installed when installing the [waylay-sdk-core](https://pypi.org/project/waylay-sdk/) package to enable the service's functionality.
When the service api methods are required, waylay-sdk-registry is included in:
- ```pip install waylay-sdk-core[registry]``` to install `waylay-sdk-core` along with only this service, or
- ```pip install waylay-sdk-core[services]``` to install `waylay-sdk-core` along with all services.
When the typed models are required, both waylay-sdk-registry and waylay-sdk-registry-types are included in:
- ```pip install waylay-sdk-core[registry,registry-types]``` to install `waylay-sdk-core` along with only this service including the typed models, or
- ```pip install waylay-sdk-core[services,services-types]``` to install `waylay-sdk-core` along with all services along with the typed models.

Normally this package is installed together with support for other services using the [waylay-sdk](https://pypi.org/project/waylay-sdk/) umbrella package:
* `pip install waylay-sdk` will install `waylay-sdk-registry` together with the SDK api packages for other services.
* `pip install waylay-sdk[types-registry]` will additionally install the types package `waylay-sdk-registry-types`.
* `pip install waylay-sdk[types]` will install the types packages for this and all other services.

Alternatively, you can install support for this _registry_ service only, installing or extending an existing [waylay-sdk-core](https://pypi.org/project/waylay-sdk-core/):

- `pip install waylay-sdk-registry` to only install api support for _registry_.
- `pip install waylay-sdk-registry[types]` to additionally install type support for _registry_.

## Usage

Expand Down Expand Up @@ -174,6 +177,10 @@ Class | Method | HTTP request | Description
- [DeploySpecOpenfaasSpec](docs/DeploySpecOpenfaasSpec.md)
- [DeployType](docs/DeployType.md)
- [DeprecatePreviousPolicy](docs/DeprecatePreviousPolicy.md)
- [DeprecatePreviousPolicyAnyOf](docs/DeprecatePreviousPolicyAnyOf.md)
- [DeprecatePreviousPolicyAnyOf1](docs/DeprecatePreviousPolicyAnyOf1.md)
- [DeprecatePreviousPolicyAnyOf2](docs/DeprecatePreviousPolicyAnyOf2.md)
- [DeprecatePreviousPolicyAnyOf3](docs/DeprecatePreviousPolicyAnyOf3.md)
- [Documentation](docs/Documentation.md)
- [DocumentationProperty](docs/DocumentationProperty.md)
- [EntityWithLinksIKfservingResponseV2](docs/EntityWithLinksIKfservingResponseV2.md)
Expand Down Expand Up @@ -202,6 +209,10 @@ Class | Method | HTTP request | Description
- [GetWebscriptResponseV2](docs/GetWebscriptResponseV2.md)
- [GetWebscriptResponseV2Links](docs/GetWebscriptResponseV2Links.md)
- [HALLink](docs/HALLink.md)
- [HALLinkHref](docs/HALLinkHref.md)
- [HALLinks](docs/HALLinks.md)
- [InvocationAttributes](docs/InvocationAttributes.md)
- [InvocationAttributesAuth](docs/InvocationAttributesAuth.md)
- [InvokeHALLink](docs/InvokeHALLink.md)
- [JobAndFunctionHALLink](docs/JobAndFunctionHALLink.md)
- [JobCause](docs/JobCause.md)
Expand Down Expand Up @@ -275,6 +286,7 @@ Class | Method | HTTP request | Description
- [PlugResponseV2](docs/PlugResponseV2.md)
- [PlugType](docs/PlugType.md)
- [PlugVersionsResponseV2](docs/PlugVersionsResponseV2.md)
- [PlugWithInvocationResponseV2](docs/PlugWithInvocationResponseV2.md)
- [PostModelJobAsyncResponseV2](docs/PostModelJobAsyncResponseV2.md)
- [PostModelJobSyncResponseV2](docs/PostModelJobSyncResponseV2.md)
- [PostPlugJobAsyncResponseV2](docs/PostPlugJobAsyncResponseV2.md)
Expand All @@ -288,6 +300,7 @@ Class | Method | HTTP request | Description
- [RebuildPlugAsyncResponseV2](docs/RebuildPlugAsyncResponseV2.md)
- [RebuildPlugSyncResponseV2](docs/RebuildPlugSyncResponseV2.md)
- [RebuildPolicy](docs/RebuildPolicy.md)
- [RebuildRequestV2](docs/RebuildRequestV2.md)
- [RebuildWebscriptAsyncResponseV2](docs/RebuildWebscriptAsyncResponseV2.md)
- [RebuildWebscriptSyncResponseV2](docs/RebuildWebscriptSyncResponseV2.md)
- [RegistryErrorResponse](docs/RegistryErrorResponse.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/AssetSummaryWithHALLinkLinks.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ HAL links to the asset

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**asset** | [**HALLink**](HALLink.md) | |
**asset** | [**HALLinks**](HALLinks.md) | |

## Example

Expand Down
1 change: 1 addition & 0 deletions docs/CompiledRuntimeVersion.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Name | Type | Description | Notes
**language** | [**LanguageRelease**](LanguageRelease.md) | | [optional]
**provided_dependencies** | [**List[ProvidedDependency]**](ProvidedDependency.md) | Description of dependencies provided by this runtime version. | [optional]
**assets** | [**AssetsConditions**](AssetsConditions.md) | | [optional]
**invocation** | [**InvocationAttributes**](InvocationAttributes.md) | | [optional]
**title** | **str** | |
**description** | **str** | | [optional]
**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org |
Expand Down
1 change: 0 additions & 1 deletion docs/DeployArgsDeploySpecOverrides.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Name | Type | Description | Notes
**service** | **str** | | [optional]
**image** | **str** | | [optional]
**namespace** | **str** | | [optional]
**env_process** | **str** | | [optional]
**network** | **str** | | [optional]
**env_vars** | **Dict[str, str]** | | [optional]
**constraints** | **List[str]** | | [optional]
Expand Down
1 change: 0 additions & 1 deletion docs/DeploySpecOpenfaasSpec.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Name | Type | Description | Notes
**service** | **str** | | [optional]
**image** | **str** | | [optional]
**namespace** | **str** | | [optional]
**env_process** | **str** | | [optional]
**network** | **str** | | [optional]
**env_vars** | **Dict[str, str]** | | [optional]
**constraints** | **List[str]** | | [optional]
Expand Down
17 changes: 17 additions & 0 deletions docs/DeprecatePreviousPolicy.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,23 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

## Example

```python
from waylay.services.registry.models.deprecate_previous_policy import DeprecatePreviousPolicy

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

# convert the object into a dict
deprecate_previous_policy_dict = deprecate_previous_policy_instance.to_dict()
# create an instance of DeprecatePreviousPolicy from a dict
deprecate_previous_policy_form_dict = deprecate_previous_policy.from_dict(deprecate_previous_policy_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)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


2 changes: 1 addition & 1 deletion docs/GetPlugResponseV2.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Plug Found

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**entity** | [**PlugResponseV2**](PlugResponseV2.md) | |
**entity** | [**PlugWithInvocationResponseV2**](PlugWithInvocationResponseV2.md) | |
**links** | [**GetPlugResponseV2Links**](GetPlugResponseV2Links.md) | |

## Example
Expand Down
2 changes: 1 addition & 1 deletion docs/GetPlugResponseV2LinksDraft.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Link to the lastest draft version.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**draft** | **bool** | |
**href** | **str** | |
**href** | [**HALLinkHref**](HALLinkHref.md) | |
**version** | **str** | |
**deprecated** | **bool** | |

Expand Down
2 changes: 1 addition & 1 deletion docs/GetPlugResponseV2LinksPublished.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Link to the lastest published version.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**draft** | **bool** | |
**href** | **str** | |
**href** | [**HALLinkHref**](HALLinkHref.md) | |
**version** | **str** | |
**deprecated** | **bool** | |

Expand Down
2 changes: 1 addition & 1 deletion docs/HALLink.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**href** | **str** | |
**href** | [**HALLinkHref**](HALLinkHref.md) | |

## Example

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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

## Example

```python
from waylay.services.registry.models.hal_link_href import HALLinkHref

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

# convert the object into a dict
hal_link_href_dict = hal_link_href_instance.to_dict()
# create an instance of HALLinkHref from a dict
hal_link_href_form_dict = hal_link_href.from_dict(hal_link_href_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)


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

One or more links of the same HAL collection.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**href** | [**HALLinkHref**](HALLinkHref.md) | |

## Example

```python
from waylay.services.registry.models.hal_links import HALLinks

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

# convert the object into a dict
hal_links_dict = hal_links_instance.to_dict()
# create an instance of HALLinks from a dict
hal_links_form_dict = hal_links.from_dict(hal_links_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)


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


## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**auth** | [**InvocationAttributesAuth**](InvocationAttributesAuth.md) | |
**task_context** | **bool** | Indicates whether the task context attributes should be provided in `options.task`. |
**node_context** | **bool** | Indicates whether the node context attributes should be provided in `options.node`. |
**raw_data_context** | **bool** | Indicates that the rawdata context attributes should be provided in `options.rawData`. |
**callback** | **bool** | Indicates that the plug implementer intends to use the callback mechanism. |

## Example

```python
from waylay.services.registry.models.invocation_attributes import InvocationAttributes

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

# convert the object into a dict
invocation_attributes_dict = invocation_attributes_instance.to_dict()
# create an instance of InvocationAttributes from a dict
invocation_attributes_form_dict = invocation_attributes.from_dict(invocation_attributes_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)


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

Indicates what credentials are passed to provide a Waylay authorization context.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading