Skip to content

Latest commit

 

History

History
216 lines (162 loc) · 7.48 KB

TagsApi.md

File metadata and controls

216 lines (162 loc) · 7.48 KB
Raw

waylay.services.registry.TagsApi

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

Method HTTP request Description
get GET /registry/v2/tags/{tagName} Get
list GET /registry/v2/tags/ List
remove DELETE /registry/v2/tags/ Remove Unused

get

get( tag_name: str, headers ) -> FunctionTagResponse

Get

Get the metadata of a function 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.function_tag_response import FunctionTagResponse
try:
    # Get
    # calls `GET /registry/v2/tags/{tagName}`
    api_response = await waylay_client.registry.tags.get(
        'tag_name_example', # tag_name | path param "tagName"
    )
    print("The response of registry.tags.get:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling registry.tags.get: %s\n" % e)

Endpoint

GET /registry/v2/tags/{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) FunctionTagResponse FunctionTagResponse
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 ) -> FunctionTagsResponse

List

List tags used on any plug, webscript or model.

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

Endpoint

GET /registry/v2/tags/

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) FunctionTagsResponse FunctionTagsResponse
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]

remove

remove( headers ) -> FunctionTagsResponse

Remove Unused

Remove tags that are not referenced by any plug, webscript or model. This is normally executed as background task.

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.function_tags_response import FunctionTagsResponse
try:
    # Remove Unused
    # calls `DELETE /registry/v2/tags/`
    api_response = await waylay_client.registry.tags.remove(
    )
    print("The response of registry.tags.remove:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling registry.tags.remove: %s\n" % e)

Endpoint

DELETE /registry/v2/tags/

Parameters

This endpoint does not need any parameter. headers | HeaderTypes | request headers | |

Return type

Selected path param Raw response param Return Type Description Links
Literal[""] (default) False (default) FunctionTagsResponse FunctionTagsResponse
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]