halo_client.CategoryV1alpha1Api

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

Method	HTTP request	Description
create_category	POST /apis/content.halo.run/v1alpha1/categories
delete_category	DELETE /apis/content.halo.run/v1alpha1/categories/{name}
get_category	GET /apis/content.halo.run/v1alpha1/categories/{name}
list_category	GET /apis/content.halo.run/v1alpha1/categories
patch_category	PATCH /apis/content.halo.run/v1alpha1/categories/{name}
update_category	PUT /apis/content.halo.run/v1alpha1/categories/{name}

create_category

Category create_category(category=category)

Create Category

Example

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

import halo_client
from halo_client.models.category import Category
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.CategoryV1alpha1Api(api_client)
    category = halo_client.Category() # Category | Fresh category (optional)

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

Parameters

Name	Type	Description	Notes
category	Category	Fresh category	[optional]

Return type

Category

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	Response categories created just now	-

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

delete_category

delete_category(name)

Delete Category

Example

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

import halo_client
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.CategoryV1alpha1Api(api_client)
    name = 'name_example' # str | Name of category

    try:
        api_instance.delete_category(name)
    except Exception as e:
        print("Exception when calling CategoryV1alpha1Api->delete_category: %s\n" % e)

Parameters

Name	Type	Description	Notes
name	str	Name of category

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	Response category deleted just now	-

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

get_category

Category get_category(name)

Get Category

Example

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

import halo_client
from halo_client.models.category import Category
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.CategoryV1alpha1Api(api_client)
    name = 'name_example' # str | Name of category

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

Parameters

Name	Type	Description	Notes
name	str	Name of category

Return type

Category

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	Response single category	-

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

list_category

CategoryList list_category(page=page, size=size, label_selector=label_selector, field_selector=field_selector, sort=sort)

List Category

Example

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

import halo_client
from halo_client.models.category_list import CategoryList
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.CategoryV1alpha1Api(api_client)
    page = 56 # int | Page number. Default is 0. (optional)
    size = 56 # int | Size number. Default is 0. (optional)
    label_selector = ['label_selector_example'] # List[str] | Label selector. e.g.: hidden!=true (optional)
    field_selector = ['field_selector_example'] # List[str] | Field selector. e.g.: metadata.name==halo (optional)
    sort = ['sort_example'] # List[str] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. (optional)

    try:
        api_response = api_instance.list_category(page=page, size=size, label_selector=label_selector, field_selector=field_selector, sort=sort)
        print("The response of CategoryV1alpha1Api->list_category:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CategoryV1alpha1Api->list_category: %s\n" % e)

Parameters

Name	Type	Description	Notes
page	int	Page number. Default is 0.	[optional]
size	int	Size number. Default is 0.	[optional]
label_selector	List[str]	Label selector. e.g.: hidden!=true	[optional]
field_selector	List[str]	Field selector. e.g.: metadata.name==halo	[optional]
sort	List[str]	Sorting criteria in the format: property,(asc	desc). Default sort order is ascending. Multiple sort criteria are supported.

Return type

CategoryList

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	Response categories	-

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

patch_category

Category patch_category(name, json_patch_inner=json_patch_inner)

Patch Category

Example

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

import halo_client
from halo_client.models.category import Category
from halo_client.models.json_patch_inner import JsonPatchInner
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.CategoryV1alpha1Api(api_client)
    name = 'name_example' # str | Name of category
    json_patch_inner = [halo_client.JsonPatchInner()] # List[JsonPatchInner] |  (optional)

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

Parameters

Name	Type	Description	Notes
name	str	Name of category
json_patch_inner	List[JsonPatchInner]		[optional]

Return type

Category

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: application/json-patch+json
Accept: /

HTTP response details

Status code	Description	Response headers
200	Response category patched just now	-

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

update_category

Category update_category(name, category=category)

Update Category

Example

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

import halo_client
from halo_client.models.category import Category
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.CategoryV1alpha1Api(api_client)
    name = 'name_example' # str | Name of category
    category = halo_client.Category() # Category | Updated category (optional)

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

Parameters

Name	Type	Description	Notes
name	str	Name of category
category	Category	Updated category	[optional]

Return type

Category

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: /

HTTP response details

Status code	Description	Response headers
200	Response categories updated just now	-

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

FilesExpand file tree

CategoryV1alpha1Api.md

Latest commit

History

CategoryV1alpha1Api.md

File metadata and controls

halo_client.CategoryV1alpha1Api

create_category

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_category

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_category

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_category

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_category

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_category

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details