Skip to content

Latest commit

 

History

History
442 lines (421 loc) · 31.4 KB

README.md

File metadata and controls

442 lines (421 loc) · 31.4 KB
Raw

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.17.1) 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

Normally this package is installed together with support for other services using the 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:

  • 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

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
ModelTagsApi add_all PATCH /registry/v2/models/{name}/tags Add Tags On All
ModelTagsApi add PATCH /registry/v2/models/{name}/versions/{version}/tags Add Tags
ModelTagsApi clear_all DELETE /registry/v2/models/{name}/tags Clear Tags On Any/All
ModelTagsApi clear DELETE /registry/v2/models/{name}/versions/{version}/tags Clear Tags
ModelTagsApi find_all GET /registry/v2/models/{name}/tags/{tagName} Find Tags On Any/All
ModelTagsApi find GET /registry/v2/models/{name}/versions/{version}/tags/{tagName} Find Tag
ModelTagsApi list_all GET /registry/v2/models/{name}/tags List Tags On Any/All
ModelTagsApi list GET /registry/v2/models/{name}/versions/{version}/tags List Tags
ModelTagsApi put_all PUT /registry/v2/models/{name}/tags/{tagName} Put Tag On All
ModelTagsApi put PUT /registry/v2/models/{name}/versions/{version}/tags/{tagName} Put Tag
ModelTagsApi remove_all DELETE /registry/v2/models/{name}/tags/{tagName} Remove Tag On Any/All
ModelTagsApi remove DELETE /registry/v2/models/{name}/versions/{version}/tags/{tagName} Remove Tag
ModelTagsApi replace_all PUT /registry/v2/models/{name}/tags Replace Tags On Any/All
ModelTagsApi replace PUT /registry/v2/models/{name}/versions/{version}/tags Replace Tags
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 protect POST /registry/v2/models/{name}/versions/{version}/protect Protect Model Version
ModelsApi protect_versions POST /registry/v2/models/{name}/protect Protect Model
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
PlugTagsApi add_all PATCH /registry/v2/plugs/{name}/tags Add Tags On All
PlugTagsApi add PATCH /registry/v2/plugs/{name}/versions/{version}/tags Add Tags
PlugTagsApi clear_all DELETE /registry/v2/plugs/{name}/tags Clear Tags On Any/All
PlugTagsApi clear DELETE /registry/v2/plugs/{name}/versions/{version}/tags Clear Tags
PlugTagsApi find_all GET /registry/v2/plugs/{name}/tags/{tagName} Find Tags On Any/All
PlugTagsApi find GET /registry/v2/plugs/{name}/versions/{version}/tags/{tagName} Find Tag
PlugTagsApi list_all GET /registry/v2/plugs/{name}/tags List Tags On Any/All
PlugTagsApi list GET /registry/v2/plugs/{name}/versions/{version}/tags List Tags
PlugTagsApi put_all PUT /registry/v2/plugs/{name}/tags/{tagName} Put Tag On All
PlugTagsApi put PUT /registry/v2/plugs/{name}/versions/{version}/tags/{tagName} Put Tag
PlugTagsApi remove_all DELETE /registry/v2/plugs/{name}/tags/{tagName} Remove Tag On Any/All
PlugTagsApi remove DELETE /registry/v2/plugs/{name}/versions/{version}/tags/{tagName} Remove Tag
PlugTagsApi replace_all PUT /registry/v2/plugs/{name}/tags Replace Tags On Any/All
PlugTagsApi replace PUT /registry/v2/plugs/{name}/versions/{version}/tags Replace Tags
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 protect POST /registry/v2/plugs/{name}/versions/{version}/protect Protect Plug Version
PlugsApi protect_versions POST /registry/v2/plugs/{name}/protect Protect Plug
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
RuntimesApi tag GET /registry/v2/runtimeTags/{tagName} Get Runtime Tag
RuntimesApi tags GET /registry/v2/runtimeTags/ List Runtime Tags
SchemasApi get_by_role GET /registry/v2/schemas/{functionType}/{role}/schema Get Asset Schema
SchemasApi get GET /registry/v2/schemas/{schemaId} Get Asset Schema
TagsApi get GET /registry/v2/tags/{tagName} Get
TagsApi list GET /registry/v2/tags/ List
TagsApi remove DELETE /registry/v2/tags/ Remove Unused
WebscriptTagsApi add_all PATCH /registry/v2/webscripts/{name}/tags Add Tags On All
WebscriptTagsApi add PATCH /registry/v2/webscripts/{name}/versions/{version}/tags Add Tags
WebscriptTagsApi clear_all DELETE /registry/v2/webscripts/{name}/tags Clear Tags On Any/All
WebscriptTagsApi clear DELETE /registry/v2/webscripts/{name}/versions/{version}/tags Clear Tags
WebscriptTagsApi find_all GET /registry/v2/webscripts/{name}/tags/{tagName} Find Tags On Any/All
WebscriptTagsApi find GET /registry/v2/webscripts/{name}/versions/{version}/tags/{tagName} Find Tag
WebscriptTagsApi list_all GET /registry/v2/webscripts/{name}/tags List Tags On Any/All
WebscriptTagsApi list GET /registry/v2/webscripts/{name}/versions/{version}/tags List Tags
WebscriptTagsApi put_all PUT /registry/v2/webscripts/{name}/tags/{tagName} Put Tag On All
WebscriptTagsApi put PUT /registry/v2/webscripts/{name}/versions/{version}/tags/{tagName} Put Tag
WebscriptTagsApi remove_all DELETE /registry/v2/webscripts/{name}/tags/{tagName} Remove Tag On Any/All
WebscriptTagsApi remove DELETE /registry/v2/webscripts/{name}/versions/{version}/tags/{tagName} Remove Tag
WebscriptTagsApi replace_all PUT /registry/v2/webscripts/{name}/tags Replace Tags On Any/All
WebscriptTagsApi replace PUT /registry/v2/webscripts/{name}/versions/{version}/tags Replace Tags
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 protect_versions POST /registry/v2/webscripts/{name}/protect Protect Webscript
WebscriptsApi protect POST /registry/v2/webscripts/{name}/versions/{version}/protect Protect Webscript Version
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