/waylay-sdk-registry-py

Primary LanguagePythonISC LicenseISC

Waylay Registry Service

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) For more information, please visit the openapi specification.

It consists of two sub-packages that are both plugins for the waylay-sdk-core package.

  • The waylay-sdk-registry sub-package contains the Registry api methods.
  • The waylay-sdk-registry-types sub-package is an extension that contains the typed model classes for all path params, query params, body params and responses for each of the api methods in waylay-sdk-registry.

Requirements.

This package requires Python 3.9+.

Installation

Typically this package is installed when installing the waylay-sdk-core 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.

Usage

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-registry-types` is installed
from waylay.services.registry.models.root_page_response import RootPageResponse
try:
    # Get Service Status
    # calls `GET /registry/v2/`
    api_response = await waylay_client.registry.about.get(
    )
    print("The response of registry.about.get:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling registry.about.get: %s\n" % e)

For more information, please visit the Waylay API documentation.

Documentation for API Endpoints

All URIs are relative to https://api.waylay.io

Class Method HTTP request Description
AboutApi get GET /registry/v2/ Get Service Status
JobsApi events GET /registry/v2/jobs/events Stream Events
JobsApi get GET /registry/v2/jobs/{type}/{id} Get Job
JobsApi list GET /registry/v2/jobs/ List Jobs
ModelsApi create POST /registry/v2/models/ Create Model
ModelsApi delete_asset DELETE /registry/v2/models/{name}/versions/{version}/content/{wildcard} Delete Model Asset
ModelsApi get_archive GET /registry/v2/models/{name}/versions/{version}/content Get Model Archive
ModelsApi get_asset GET /registry/v2/models/{name}/versions/{version}/content/{wildcard} Get File From Model Archive
ModelsApi get_latest GET /registry/v2/models/{name} Get Latest Model Version
ModelsApi get GET /registry/v2/models/{name}/versions/{version} Get Model Version
ModelsApi jobs GET /registry/v2/models/{name}/versions/{version}/jobs List Model Jobs
ModelsApi list GET /registry/v2/models/ List Models
ModelsApi list_versions GET /registry/v2/models/{name}/versions List Model Versions
ModelsApi patch_metadata PATCH /registry/v2/models/{name}/versions/{version}/metadata Patch Model Metadata
ModelsApi publish POST /registry/v2/models/{name}/versions/{version}/publish Publish Draft Model
ModelsApi rebuild POST /registry/v2/models/{name}/versions/{version}/rebuild Rebuild Model
ModelsApi remove_version DELETE /registry/v2/models/{name}/versions/{version} Remove Model Version
ModelsApi remove_versions DELETE /registry/v2/models/{name} Remove Model
ModelsApi update_asset PUT /registry/v2/models/{name}/versions/{version}/content/{wildcard} Update Model Asset
ModelsApi update_assets PUT /registry/v2/models/{name}/versions/{version}/content Update Model Assets
ModelsApi verify POST /registry/v2/models/{name}/versions/{version}/verify Verify Health Of Model
PlugsApi create POST /registry/v2/plugs/ Create Plug
PlugsApi delete_asset DELETE /registry/v2/plugs/{name}/versions/{version}/content/{wildcard} Delete Plug Asset
PlugsApi get_archive GET /registry/v2/plugs/{name}/versions/{version}/content Get Plug Archive
PlugsApi get_asset GET /registry/v2/plugs/{name}/versions/{version}/content/{wildcard} Get File From Plug Archive
PlugsApi get_latest GET /registry/v2/plugs/{name} Get Latest Plug Version
PlugsApi get GET /registry/v2/plugs/{name}/versions/{version} Get Plug Version
PlugsApi jobs GET /registry/v2/plugs/{name}/versions/{version}/jobs List Plug Jobs
PlugsApi list GET /registry/v2/plugs/ List Plugs
PlugsApi list_versions GET /registry/v2/plugs/{name}/versions List Plug Versions
PlugsApi patch_interface PATCH /registry/v2/plugs/{name}/versions/{version}/interface Patch Plug Interface
PlugsApi patch_metadata PATCH /registry/v2/plugs/{name}/versions/{version}/metadata Patch Plug Metadata
PlugsApi publish POST /registry/v2/plugs/{name}/versions/{version}/publish Publish Draft Plug
PlugsApi rebuild POST /registry/v2/plugs/{name}/versions/{version}/rebuild Rebuild Plug
PlugsApi remove_version DELETE /registry/v2/plugs/{name}/versions/{version} Remove Plug Version
PlugsApi remove_versions DELETE /registry/v2/plugs/{name} Remove Plug
PlugsApi update_asset PUT /registry/v2/plugs/{name}/versions/{version}/content/{wildcard} Update Plug Asset
PlugsApi update_assets PUT /registry/v2/plugs/{name}/versions/{version}/content Update Plug Assets
PlugsApi verify POST /registry/v2/plugs/{name}/versions/{version}/verify Verify Health Of Plug
RuntimesApi example_archive GET /registry/v2/runtimes/{name}/versions/{version}/example Get Runtime Example Archive
RuntimesApi get_example_asset GET /registry/v2/runtimes/{name}/versions/{version}/example/{wildcard} Get File From Runtime Example Archive
RuntimesApi get_latest GET /registry/v2/runtimes/{name} Get Latest Runtime Version
RuntimesApi get GET /registry/v2/runtimes/{name}/versions/{version} Get Runtime Version
RuntimesApi list GET /registry/v2/runtimes/ List Runtimes
RuntimesApi list_versions GET /registry/v2/runtimes/{name}/versions List Runtime Versions
SchemasApi get_by_role GET /registry/v2/schemas/{functionType}/{role}/schema Get Asset Schema
SchemasApi get GET /registry/v2/schemas/{schemaId} Get Asset Schema
WebscriptsApi create POST /registry/v2/webscripts/ Create Webscript Version
WebscriptsApi delete_asset DELETE /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard} Delete Webscript Asset
WebscriptsApi get_archive GET /registry/v2/webscripts/{name}/versions/{version}/content Get Webscript Archive
WebscriptsApi get_asset GET /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard} Get File From Webscript Archive
WebscriptsApi get_latest GET /registry/v2/webscripts/{name} Get Latest Webscript Version
WebscriptsApi get GET /registry/v2/webscripts/{name}/versions/{version} Get Webscript Version
WebscriptsApi jobs GET /registry/v2/webscripts/{name}/versions/{version}/jobs List Webscript Jobs
WebscriptsApi list_versions GET /registry/v2/webscripts/{name}/versions List Webscript Versions
WebscriptsApi list GET /registry/v2/webscripts/ List Webscripts
WebscriptsApi patch_metadata PATCH /registry/v2/webscripts/{name}/versions/{version}/metadata Patch Webscript Metadata
WebscriptsApi publish POST /registry/v2/webscripts/{name}/versions/{version}/publish Publish Draft Webscript
WebscriptsApi rebuild POST /registry/v2/webscripts/{name}/versions/{version}/rebuild Rebuild Webscript
WebscriptsApi remove_version DELETE /registry/v2/webscripts/{name}/versions/{version} Remove Webscript Version
WebscriptsApi remove_versions DELETE /registry/v2/webscripts/{name} Remove Webscript
WebscriptsApi update_asset PUT /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard} Update Webscript Asset
WebscriptsApi update_assets PUT /registry/v2/webscripts/{name}/versions/{version}/content Update Webscript Assets
WebscriptsApi verify POST /registry/v2/webscripts/{name}/versions/{version}/verify Verify Health Of Webscript

Documentation For Models