MenuV1alpha1PublicApi.md

halo_client.MenuV1alpha1PublicApi

All URIs are relative to http://localhost:8091

Method	HTTP request	Description
query_menu_by_name	GET /apis/api.halo.run/v1alpha1/menus/{name}
query_primary_menu	GET /apis/api.halo.run/v1alpha1/menus/-

query_menu_by_name

MenuVo query_menu_by_name(name)

Gets menu by name.

Example

• Basic Authentication (basicAuth):
• Bearer (JWT) Authentication (bearerAuth):

import halo_client
from halo_client.models.menu_vo import MenuVo
from halo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8091
# See configuration.py for a list of all supported configuration parameters.
configuration = halo_client.Configuration(
    host = "http://localhost:8091"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): bearerAuth
configuration = halo_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.MenuV1alpha1PublicApi(api_client)
    name = 'name_example' # str | Menu name

    try:
        api_response = api_instance.query_menu_by_name(name)
        print("The response of MenuV1alpha1PublicApi->query_menu_by_name:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MenuV1alpha1PublicApi->query_menu_by_name: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	Menu name

Return type

MenuVo

Authorization

basicAuth, bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: /

HTTP response details

Status code	Description	Response headers
0	default response	-

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

query_primary_menu

MenuVo query_primary_menu()

Gets primary menu.

Example

• Basic Authentication (basicAuth):
• Bearer (JWT) Authentication (bearerAuth):

import halo_client
from halo_client.models.menu_vo import MenuVo
from halo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8091
# See configuration.py for a list of all supported configuration parameters.
configuration = halo_client.Configuration(
    host = "http://localhost:8091"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Configure Bearer authorization (JWT): bearerAuth
configuration = halo_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.MenuV1alpha1PublicApi(api_client)

    try:
        api_response = api_instance.query_primary_menu()
        print("The response of MenuV1alpha1PublicApi->query_primary_menu:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MenuV1alpha1PublicApi->query_primary_menu: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MenuVo

Authorization

basicAuth, bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: /

HTTP response details

Status code	Description	Response headers
0	default response	-

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