Skip to content

ReplyV1alpha1Api.md

Latest commit

 

History

History
516 lines (362 loc) · 15.9 KB

ReplyV1alpha1Api.md

File metadata and controls

516 lines (362 loc) · 15.9 KB

halo_client.ReplyV1alpha1Api

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

Method HTTP request Description
create_reply POST /apis/content.halo.run/v1alpha1/replies
delete_reply DELETE /apis/content.halo.run/v1alpha1/replies/{name}
get_reply GET /apis/content.halo.run/v1alpha1/replies/{name}
list_reply GET /apis/content.halo.run/v1alpha1/replies
patch_reply PATCH /apis/content.halo.run/v1alpha1/replies/{name}
update_reply PUT /apis/content.halo.run/v1alpha1/replies/{name}

create_reply

Reply create_reply(reply=reply)

Create Reply

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.models.reply import Reply
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.ReplyV1alpha1Api(api_client)
    reply = halo_client.Reply() # Reply | Fresh reply (optional)

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

Parameters

Name Type Description Notes
reply Reply Fresh reply [optional]

Return type

Reply

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

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

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

delete_reply

delete_reply(name)

Delete Reply

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.ReplyV1alpha1Api(api_client)
    name = 'name_example' # str | Name of reply

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

Parameters

Name Type Description Notes
name str Name of reply

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 reply deleted just now -

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

get_reply

Reply get_reply(name)

Get Reply

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.models.reply import Reply
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.ReplyV1alpha1Api(api_client)
    name = 'name_example' # str | Name of reply

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

Parameters

Name Type Description Notes
name str Name of reply

Return type

Reply

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 Response single reply -

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

list_reply

ReplyList list_reply(page=page, size=size, label_selector=label_selector, field_selector=field_selector, sort=sort)

List Reply

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.models.reply_list import ReplyList
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.ReplyV1alpha1Api(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_reply(page=page, size=size, label_selector=label_selector, field_selector=field_selector, sort=sort)
        print("The response of ReplyV1alpha1Api->list_reply:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ReplyV1alpha1Api->list_reply: %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

ReplyList

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
200 Response replies -

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

patch_reply

Reply patch_reply(name, json_patch_inner=json_patch_inner)

Patch Reply

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.models.json_patch_inner import JsonPatchInner
from halo_client.models.reply import Reply
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.ReplyV1alpha1Api(api_client)
    name = 'name_example' # str | Name of reply
    json_patch_inner = [halo_client.JsonPatchInner()] # List[JsonPatchInner] |  (optional)

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

Parameters

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

Return type

Reply

Authorization

basicAuth, bearerAuth

HTTP request headers

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

HTTP response details

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

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

update_reply

Reply update_reply(name, reply=reply)

Update Reply

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.models.reply import Reply
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.ReplyV1alpha1Api(api_client)
    name = 'name_example' # str | Name of reply
    reply = halo_client.Reply() # Reply | Updated reply (optional)

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

Parameters

Name Type Description Notes
name str Name of reply
reply Reply Updated reply [optional]

Return type

Reply

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

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

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