Skip to content

Latest commit

 

History

History
671 lines (532 loc) · 32.7 KB

RuntimesApi.md

File metadata and controls

671 lines (532 loc) · 32.7 KB
Raw

waylay.services.registry.RuntimesApi

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

Method HTTP request Description
example_archive GET /registry/v2/runtimes/{name}/versions/{version}/example Get Runtime Example Archive
get_example_asset GET /registry/v2/runtimes/{name}/versions/{version}/example/{wildcard} Get File From Runtime Example Archive
get_latest GET /registry/v2/runtimes/{name} Get Latest Runtime Version
get GET /registry/v2/runtimes/{name}/versions/{version} Get Runtime Version
list GET /registry/v2/runtimes/ List Runtimes
list_versions GET /registry/v2/runtimes/{name}/versions List Runtime Versions
tag GET /registry/v2/runtimeTags/{tagName} Get Runtime Tag
tags GET /registry/v2/runtimeTags/ List Runtime Tags

example_archive

example_archive( name: str, version: SemanticVersionRange, query: ExampleArchiveQuery, headers ) -> bytearray

Get Runtime Example Archive

Get an example of the specification archive of the runtime.

Example

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.show_embedding import ShowEmbedding
try:
    # Get Runtime Example Archive
    # calls `GET /registry/v2/runtimes/{name}/versions/{version}/example`
    api_response = await waylay_client.registry.runtimes.example_archive(
        'name_example', # name | path param "name"
        waylay.services.registry.SemanticVersionRange(), # version | path param "version"
        # query parameters:
        query = {
            'ls': False
            'showTags': 'embed'
            'includeDeprecated': True
        },
    )
    print("The response of registry.runtimes.example_archive:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling registry.runtimes.example_archive: %s\n" % e)

Endpoint

GET /registry/v2/runtimes/{name}/versions/{version}/example

Parameters

Name Type API binding Description Notes
name str path parameter "name" The name of a <em>runtime</em>
version SemanticVersionRange path parameter "version" A version range for a <em>runtime</em>
query QueryParamTypes | None URL query parameter
query['ls'] (dict)
query.ls (Query)		 bool query parameter "ls" If set to `true`, the result will be a listing of the files in the asset, annotated with metadata and validation report from the asset conditions of the functions runtime. [optional] [default False]
query['showTags'] (dict)
query.show_tags (Query)		 ShowEmbedding query parameter "showTags" Sets the representation of related tags in the response. - `embed`: as full summary representation (in `_embedded`). - `none`: omitted. [optional]
query['includeDeprecated'] (dict)
query.include_deprecated (Query)		 bool query parameter "includeDeprecated" If set to `true`, deprecated runtimes will be included in the query. [optional] [default True]
headers HeaderTypes request headers

Return type

Selected path param Raw response param Return Type Description Links
Literal[""] (default) False (default) bytearray
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: Not defined
  • Accept: application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json

HTTP response details

Status code Description Response headers
200 Successful Response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_example_asset

get_example_asset( name: str, version: SemanticVersionRange, wildcard: str, query: GetExampleAssetQuery, headers ) -> bytearray

Get File From Runtime Example Archive

Get a file from the example specification archive of the runtime.

Example

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.show_embedding import ShowEmbedding
try:
    # Get File From Runtime Example Archive
    # calls `GET /registry/v2/runtimes/{name}/versions/{version}/example/{wildcard}`
    api_response = await waylay_client.registry.runtimes.get_example_asset(
        'name_example', # name | path param "name"
        waylay.services.registry.SemanticVersionRange(), # version | path param "version"
        'wildcard_example', # wildcard | path param "wildcard"
        # query parameters:
        query = {
            'ls': False
            'showTags': 'embed'
            'includeDeprecated': True
        },
    )
    print("The response of registry.runtimes.get_example_asset:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling registry.runtimes.get_example_asset: %s\n" % e)

Endpoint

GET /registry/v2/runtimes/{name}/versions/{version}/example/{wildcard}

Parameters

Name Type API binding Description Notes
name str path parameter "name" The name of a <em>runtime</em>
version SemanticVersionRange path parameter "version" A version range for a <em>runtime</em>
wildcard str path parameter "wildcard" Full path or path prefix of the asset within the archive
query QueryParamTypes | None URL query parameter
query['ls'] (dict)
query.ls (Query)		 bool query parameter "ls" If set to `true`, the result will be a listing of the files in the asset, annotated with metadata and validation report from the asset conditions of the functions runtime. [optional] [default False]
query['showTags'] (dict)
query.show_tags (Query)		 ShowEmbedding query parameter "showTags" Sets the representation of related tags in the response. - `embed`: as full summary representation (in `_embedded`). - `none`: omitted. [optional]
query['includeDeprecated'] (dict)
query.include_deprecated (Query)		 bool query parameter "includeDeprecated" If set to `true`, deprecated runtimes will be included in the query. [optional] [default True]
headers HeaderTypes request headers

Return type

Selected path param Raw response param Return Type Description Links
Literal[""] (default) False (default) bytearray
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: Not defined
  • Accept: application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json

HTTP response details

Status code Description Response headers
200 Successful Response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_latest

get_latest( name: str, query: GetLatestQuery, headers ) -> RuntimeVersionResponse

Get Latest Runtime Version

Get a representation of the default runtime version by name.

Example

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.archive_format_filter import ArchiveFormatFilter
from waylay.services.registry.models.function_type_filter import FunctionTypeFilter
from waylay.services.registry.models.runtime_version_response import RuntimeVersionResponse
from waylay.services.registry.models.show_embedding import ShowEmbedding
try:
    # Get Latest Runtime Version
    # calls `GET /registry/v2/runtimes/{name}`
    api_response = await waylay_client.registry.runtimes.get_latest(
        'name_example', # name | path param "name"
        # query parameters:
        query = {
            'showTags': 'embed'
            'version': waylay.services.registry.SemanticVersionRange()
            'includeDeprecated': False
            'functionType': []
            'archiveFormat': []
        },
    )
    print("The response of registry.runtimes.get_latest:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling registry.runtimes.get_latest: %s\n" % e)

Endpoint

GET /registry/v2/runtimes/{name}

Parameters

Name Type API binding Description Notes
name str path parameter "name" The name of a <em>runtime</em>
query QueryParamTypes | None URL query parameter
query['showTags'] (dict)
query.show_tags (Query)		 ShowEmbedding query parameter "showTags" Sets the representation of related tags in the response. - `embed`: as full summary representation (in `_embedded`). - `none`: omitted. [optional]
query['version'] (dict)
query.version (Query)		 SemanticVersionRange query parameter "version" If set, filters on the <code>version</code> of a runtime. Supports version ranges. [optional]
query['includeDeprecated'] (dict)
query.include_deprecated (Query)		 bool query parameter "includeDeprecated" If set to `true`, deprecated runtimes will be included in the query. [optional] [default False]
query['tags'] (dict)
query.tags (Query)		 ListRuntimesTagsParameter query parameter "tags" If set, filters on the <code>tags</code> of a runtime version. Filter values with a `-` postfix exclude the tag. [optional]
query['functionType'] (dict)
query.function_type (Query)		 List[FunctionTypeFilter] query parameter "functionType" If set, filters on the <code>functionType</code> of a runtime. Uses an exact match. [optional]
query['archiveFormat'] (dict)
query.archive_format (Query)		 List[ArchiveFormatFilter] query parameter "archiveFormat" If set, filters on the <code>archiveFormat</code> of a runtime. Uses an exact match. [optional]
headers HeaderTypes request headers

Return type

Selected path param Raw response param Return Type Description Links
Literal[""] (default) False (default) RuntimeVersionResponse RuntimeVersionResponse
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: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Default Response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get

get( name: str, version: SemanticVersionRange, query: GetQuery, headers ) -> RuntimeVersionResponse

Get Runtime Version

Get a representation of the default runtime version by name.

Example

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.runtime_version_response import RuntimeVersionResponse
from waylay.services.registry.models.show_embedding import ShowEmbedding
try:
    # Get Runtime Version
    # calls `GET /registry/v2/runtimes/{name}/versions/{version}`
    api_response = await waylay_client.registry.runtimes.get(
        'name_example', # name | path param "name"
        waylay.services.registry.SemanticVersionRange(), # version | path param "version"
        # query parameters:
        query = {
            'showTags': 'embed'
            'includeDeprecated': True
        },
    )
    print("The response of registry.runtimes.get:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling registry.runtimes.get: %s\n" % e)

Endpoint

GET /registry/v2/runtimes/{name}/versions/{version}

Parameters

Name Type API binding Description Notes
name str path parameter "name" The name of a <em>runtime</em>
version SemanticVersionRange path parameter "version" A version range for a <em>runtime</em>
query QueryParamTypes | None URL query parameter
query['showTags'] (dict)
query.show_tags (Query)		 ShowEmbedding query parameter "showTags" Sets the representation of related tags in the response. - `embed`: as full summary representation (in `_embedded`). - `none`: omitted. [optional]
query['includeDeprecated'] (dict)
query.include_deprecated (Query)		 bool query parameter "includeDeprecated" If set to `true`, deprecated runtimes will be included in the query. [optional] [default True]
headers HeaderTypes request headers

Return type

Selected path param Raw response param Return Type Description Links
Literal[""] (default) False (default) RuntimeVersionResponse RuntimeVersionResponse
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: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Default Response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

list( query: ListQuery, headers ) -> RuntimeSummaryResponse

List Runtimes

List the runtimes that function registry supports.

Example

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.archive_format_filter import ArchiveFormatFilter
from waylay.services.registry.models.function_type_filter import FunctionTypeFilter
from waylay.services.registry.models.latest_version_level import LatestVersionLevel
from waylay.services.registry.models.runtime_summary_response import RuntimeSummaryResponse
from waylay.services.registry.models.show_embedding import ShowEmbedding
try:
    # List Runtimes
    # calls `GET /registry/v2/runtimes/`
    api_response = await waylay_client.registry.runtimes.list(
        # query parameters:
        query = {
            'showTags': 'embed'
            'version': waylay.services.registry.SemanticVersionRange()
            'latest': 'major'
            'includeDeprecated': False
            'name': 'node*'
            'functionType': []
            'archiveFormat': []
        },
    )
    print("The response of registry.runtimes.list:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling registry.runtimes.list: %s\n" % e)

Endpoint

GET /registry/v2/runtimes/

Parameters

Name Type API binding Description Notes
query QueryParamTypes | None URL query parameter
query['showTags'] (dict)
query.show_tags (Query)		 ShowEmbedding query parameter "showTags" Sets the representation of related tags in the response. - `embed`: as full summary representation (in `_embedded`). - `none`: omitted. [optional]
query['version'] (dict)
query.version (Query)		 SemanticVersionRange query parameter "version" If set, filters on the <code>version</code> of a runtime. Supports version ranges. [optional]
query['latest'] (dict)
query.latest (Query)		 LatestVersionLevel query parameter "latest" If set, filters on the level of latest versions that will be included in the query. * `major`: include at most one latest version per name and major release. * `minor`: include at most one latest version per name and minor release. * `patch`: include each matching patch version. * `true`: include the latest matching version. * `false`: include any matching version (same as `patch`). This filter is applied after all other selection criteria. [optional]
query['includeDeprecated'] (dict)
query.include_deprecated (Query)		 bool query parameter "includeDeprecated" If set to `true`, deprecated runtimes will be included in the query. [optional] [default False]
query['tags'] (dict)
query.tags (Query)		 ListRuntimesTagsParameter query parameter "tags" If set, filters on the <code>tags</code> of a runtime version. Filter values with a `-` postfix exclude the tag. [optional]
query['name'] (dict)
query.name (Query)		 str query parameter "name" If set, filters on the <code>name</code> of a runtime. Supports <code>*</code> and <code>?</code> wildcards and is case-insensitive. [optional]
query['functionType'] (dict)
query.function_type (Query)		 List[FunctionTypeFilter] query parameter "functionType" If set, filters on the <code>functionType</code> of a runtime. Uses an exact match. [optional]
query['archiveFormat'] (dict)
query.archive_format (Query)		 List[ArchiveFormatFilter] query parameter "archiveFormat" If set, filters on the <code>archiveFormat</code> of a runtime. Uses an exact match. [optional]
headers HeaderTypes request headers

Return type

Selected path param Raw response param Return Type Description Links
Literal[""] (default) False (default) RuntimeSummaryResponse RuntimeSummaryResponse
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: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Default Response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_versions

list_versions( name: str, query: ListVersionsQuery, headers ) -> RuntimeSummaryResponse

List Runtime Versions

List the supported versions of a specific runtime.

Example

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.archive_format_filter import ArchiveFormatFilter
from waylay.services.registry.models.function_type_filter import FunctionTypeFilter
from waylay.services.registry.models.latest_version_level import LatestVersionLevel
from waylay.services.registry.models.runtime_summary_response import RuntimeSummaryResponse
from waylay.services.registry.models.show_embedding import ShowEmbedding
try:
    # List Runtime Versions
    # calls `GET /registry/v2/runtimes/{name}/versions`
    api_response = await waylay_client.registry.runtimes.list_versions(
        'name_example', # name | path param "name"
        # query parameters:
        query = {
            'version': waylay.services.registry.SemanticVersionRange()
            'latest': 'major'
            'includeDeprecated': False
            'functionType': []
            'archiveFormat': []
            'showTags': 'embed'
        },
    )
    print("The response of registry.runtimes.list_versions:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling registry.runtimes.list_versions: %s\n" % e)

Endpoint

GET /registry/v2/runtimes/{name}/versions

Parameters

Name Type API binding Description Notes
name str path parameter "name" The name of a <em>runtime</em>
query QueryParamTypes | None URL query parameter
query['version'] (dict)
query.version (Query)		 SemanticVersionRange query parameter "version" If set, filters on the <code>version</code> of a runtime. Supports version ranges. [optional]
query['latest'] (dict)
query.latest (Query)		 LatestVersionLevel query parameter "latest" If set, filters on the level of latest versions that will be included in the query. * `major`: include at most one latest version per name and major release. * `minor`: include at most one latest version per name and minor release. * `patch`: include each matching patch version. * `true`: include the latest matching version. * `false`: include any matching version (same as `patch`). This filter is applied after all other selection criteria. [optional]
query['includeDeprecated'] (dict)
query.include_deprecated (Query)		 bool query parameter "includeDeprecated" If set to `true`, deprecated runtimes will be included in the query. [optional] [default False]
query['tags'] (dict)
query.tags (Query)		 ListRuntimesTagsParameter query parameter "tags" If set, filters on the <code>tags</code> of a runtime version. Filter values with a `-` postfix exclude the tag. [optional]
query['functionType'] (dict)
query.function_type (Query)		 List[FunctionTypeFilter] query parameter "functionType" If set, filters on the <code>functionType</code> of a runtime. Uses an exact match. [optional]
query['archiveFormat'] (dict)
query.archive_format (Query)		 List[ArchiveFormatFilter] query parameter "archiveFormat" If set, filters on the <code>archiveFormat</code> of a runtime. Uses an exact match. [optional]
query['showTags'] (dict)
query.show_tags (Query)		 ShowEmbedding query parameter "showTags" Sets the representation of related tags in the response. - `embed`: as full summary representation (in `_embedded`). - `none`: omitted. [optional]
headers HeaderTypes request headers

Return type

Selected path param Raw response param Return Type Description Links
Literal[""] (default) False (default) RuntimeSummaryResponse RuntimeSummaryResponse
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: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Default Response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tag

tag( tag_name: str, headers ) -> RuntimeTagResponse

Get Runtime Tag

Get the metadata of a Runtime Tag by name.

Example

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.runtime_tag_response import RuntimeTagResponse
try:
    # Get Runtime Tag
    # calls `GET /registry/v2/runtimeTags/{tagName}`
    api_response = await waylay_client.registry.runtimes.tag(
        'tag_name_example', # tag_name | path param "tagName"
    )
    print("The response of registry.runtimes.tag:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling registry.runtimes.tag: %s\n" % e)

Endpoint

GET /registry/v2/runtimeTags/{tagName}

Parameters

Name Type API binding Description Notes
tag_name str path parameter "tagName" The name of the tag that might be applied to a function.
headers HeaderTypes request headers

Return type

Selected path param Raw response param Return Type Description Links
Literal[""] (default) False (default) RuntimeTagResponse RuntimeTagResponse
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: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Default Response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

tags

tags( query: TagsQuery, headers ) -> RuntimeTagsResponse

List Runtime Tags

List the tags that are referenced by runtimes.

Example

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.runtime_tags_response import RuntimeTagsResponse
try:
    # List Runtime Tags
    # calls `GET /registry/v2/runtimeTags/`
    api_response = await waylay_client.registry.runtimes.tags(
        # query parameters:
        query = {
            'name': '*-demo-??'
            'color': '#4153ea'
        },
    )
    print("The response of registry.runtimes.tags:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling registry.runtimes.tags: %s\n" % e)

Endpoint

GET /registry/v2/runtimeTags/

Parameters

Name Type API binding Description Notes
query QueryParamTypes | None URL query parameter
query['name'] (dict)
query.name (Query)		 str query parameter "name" If set, filters on the <code>name</code> of a tag. Supports <code>*</code> and <code>?</code> wildcards and is case-insensitive. [optional]
query['color'] (dict)
query.color (Query)		 str query parameter "color" If set, filters on the <code>color</code> of a tag. Uses an exact match. [optional]
headers HeaderTypes request headers

Return type

Selected path param Raw response param Return Type Description Links
Literal[""] (default) False (default) RuntimeTagsResponse RuntimeTagsResponse
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: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Default Response -

[Back to top] [Back to API list] [Back to Model list] [Back to README]