MetricsV1alpha1PublicApi.md

halo_client.MetricsV1alpha1PublicApi

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

Method	HTTP request	Description
count	POST /apis/api.halo.run/v1alpha1/trackers/counter
downvote	POST /apis/api.halo.run/v1alpha1/trackers/downvote
upvote	POST /apis/api.halo.run/v1alpha1/trackers/upvote

count

count(counter_request)

Count an extension resource visits.

Example

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

import halo_client
from halo_client.models.counter_request import CounterRequest
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.MetricsV1alpha1PublicApi(api_client)
    counter_request = halo_client.CounterRequest() # CounterRequest | 

    try:
        api_instance.count(counter_request)
    except Exception as e:
        print("Exception when calling MetricsV1alpha1PublicApi->count: %s\n" % e)

Parameters

Name	Type	Description	Notes
counter_request	CounterRequest

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

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]

downvote

downvote(vote_request)

Downvote an extension resource.

Example

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

import halo_client
from halo_client.models.vote_request import VoteRequest
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.MetricsV1alpha1PublicApi(api_client)
    vote_request = halo_client.VoteRequest() # VoteRequest | 

    try:
        api_instance.downvote(vote_request)
    except Exception as e:
        print("Exception when calling MetricsV1alpha1PublicApi->downvote: %s\n" % e)

Parameters

Name	Type	Description	Notes
vote_request	VoteRequest

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

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]

upvote

upvote(vote_request)

Upvote an extension resource.

Example

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

import halo_client
from halo_client.models.vote_request import VoteRequest
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.MetricsV1alpha1PublicApi(api_client)
    vote_request = halo_client.VoteRequest() # VoteRequest | 

    try:
        api_instance.upvote(vote_request)
    except Exception as e:
        print("Exception when calling MetricsV1alpha1PublicApi->upvote: %s\n" % e)

Parameters

Name	Type	Description	Notes
vote_request	VoteRequest

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

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]