Skip to content

CommentV1alpha1ConsoleApi.md

Latest commit

 

History

History
275 lines (196 loc) · 9.45 KB

CommentV1alpha1ConsoleApi.md

File metadata and controls

275 lines (196 loc) · 9.45 KB

halo_client.CommentV1alpha1ConsoleApi

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

Method HTTP request Description
create_comment POST /apis/api.console.halo.run/v1alpha1/comments
create_reply POST /apis/api.console.halo.run/v1alpha1/comments/{name}/reply
list_comments GET /apis/api.console.halo.run/v1alpha1/comments

create_comment

Comment create_comment(comment_request)

Create a comment.

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.models.comment import Comment
from halo_client.models.comment_request import CommentRequest
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.CommentV1alpha1ConsoleApi(api_client)
    comment_request = halo_client.CommentRequest() # CommentRequest | 

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

Parameters

Name Type Description Notes
comment_request CommentRequest

Return type

Comment

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • 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]

create_reply

Reply create_reply(name, reply_request)

Create a reply.

Example

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

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

Parameters

Name Type Description Notes
name str
reply_request ReplyRequest

Return type

Reply

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • 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]

list_comments

ListedCommentList list_comments(page=page, size=size, label_selector=label_selector, field_selector=field_selector, sort=sort, keyword=keyword, owner_kind=owner_kind, owner_name=owner_name)

List comments.

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.models.listed_comment_list import ListedCommentList
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.CommentV1alpha1ConsoleApi(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)
    keyword = 'keyword_example' # str | Comments filtered by keyword. (optional)
    owner_kind = 'owner_kind_example' # str | Commenter kind. (optional)
    owner_name = 'owner_name_example' # str | Commenter name. (optional)

    try:
        api_response = api_instance.list_comments(page=page, size=size, label_selector=label_selector, field_selector=field_selector, sort=sort, keyword=keyword, owner_kind=owner_kind, owner_name=owner_name)
        print("The response of CommentV1alpha1ConsoleApi->list_comments:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling CommentV1alpha1ConsoleApi->list_comments: %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.
keyword str Comments filtered by keyword. [optional]
owner_kind str Commenter kind. [optional]
owner_name str Commenter name. [optional]

Return type

ListedCommentList

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]