AboutApi.md

waylay.services.storage.AboutApi

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

Method	HTTP request	Description
get	GET /storage/v1/	Version
status	GET /storage/v1/status	Status

get

get( headers ) -> str

Version

Get the application version.

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

Endpoint

GET /storage/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)	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]

status

status( query: StatusQuery, headers ) -> TenantStatusReport

Status

Validate consistency of buckets and notification queues for this tenant.

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-storage-types` is installed
from waylay.services.storage.models.tenant_status_report import TenantStatusReport
try:
    # Status
    # calls `GET /storage/v1/status`
    api_response = await waylay_client.storage.about.status(
        # query parameters:
        query = {
            'include_buckets': True
            'include_queues': True
            'include_disk_usage': False
        },
    )
    print("The response of storage.about.status:\n")
    pprint(api_response)
except ApiError as e:
    print("Exception when calling storage.about.status: %s\n" % e)

Endpoint

GET /storage/v1/status

Parameters

Name	Type	API binding	Description	Notes
query	QueryParamTypes | None	URL query parameter
query['store'] (dict) query.store (Query)	str	query parameter "store"		[optional]
query['include_buckets'] (dict) query.include_buckets (Query)	bool	query parameter "include_buckets"		[optional] [default True]
query['include_queues'] (dict) query.include_queues (Query)	bool	query parameter "include_queues"		[optional] [default True]
query['include_disk_usage'] (dict) query.include_disk_usage (Query)	bool	query parameter "include_disk_usage"		[optional] [default False]
headers	HeaderTypes	request headers

Return type

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

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