Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 2.11 KB

StatusApi.md

File metadata and controls

71 lines (51 loc) · 2.11 KB
Raw

waylay.services.queries.StatusApi

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

Method HTTP request Description
get GET /queries/v1 Get Version And Health

get

get( headers ) -> Dict[str, str]

Get Version And Health

Get the version and health status for waylay-query.

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-queries-types` is installed
try:
    # Get Version And Health
    # calls `GET /queries/v1`
    api_response = await waylay_client.queries.status.get(
    )
    print("The response of queries.status.get:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling queries.status.get: %s\n" % e)

Endpoint

GET /queries/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) Dict[str, str]
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]