AboutApi.md

waylay.services.resources.AboutApi

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

Method	HTTP request	Description
get	GET /resources/v1/	Get Service Information

get

get( headers ) -> VersionResponse

Get Service Information

Get the name and version of the service.

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

Endpoint

GET /resources/v1/

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)	VersionResponse		VersionResponse
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	Successful Response	-

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