Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 9.42 KB

CommentV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 9.42 KB

halo_client.api.CommentV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
createComment POST /apis/content.halo.run/v1alpha1/comments
deleteComment DELETE /apis/content.halo.run/v1alpha1/comments/{name}
getComment GET /apis/content.halo.run/v1alpha1/comments/{name}
listComment GET /apis/content.halo.run/v1alpha1/comments
patchComment PATCH /apis/content.halo.run/v1alpha1/comments/{name}
updateComment PUT /apis/content.halo.run/v1alpha1/comments/{name}

createComment

Comment createComment(comment)

Create Comment

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getCommentV1alpha1Api();
final Comment comment = ; // Comment | Fresh comment

try {
    final response = api.createComment(comment);
    print(response);
} catch on DioException (e) {
    print('Exception when calling CommentV1alpha1Api->createComment: $e\n');
}

Parameters

Name Type Description Notes
comment Comment Fresh comment [optional]

Return type

Comment

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

deleteComment

deleteComment(name)

Delete Comment

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getCommentV1alpha1Api();
final String name = name_example; // String | Name of comment

try {
    api.deleteComment(name);
} catch on DioException (e) {
    print('Exception when calling CommentV1alpha1Api->deleteComment: $e\n');
}

Parameters

Name Type Description Notes
name String Name of comment

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

getComment

Comment getComment(name)

Get Comment

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getCommentV1alpha1Api();
final String name = name_example; // String | Name of comment

try {
    final response = api.getComment(name);
    print(response);
} catch on DioException (e) {
    print('Exception when calling CommentV1alpha1Api->getComment: $e\n');
}

Parameters

Name Type Description Notes
name String Name of comment

Return type

Comment

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

listComment

CommentList listComment(page, size, labelSelector, fieldSelector, sort)

List Comment

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getCommentV1alpha1Api();
final int page = 56; // int | Page number. Default is 0.
final int size = 56; // int | Size number. Default is 0.
final BuiltList<String> labelSelector = ; // BuiltList<String> | Label selector. e.g.: hidden!=true
final BuiltList<String> fieldSelector = ; // BuiltList<String> | Field selector. e.g.: metadata.name==halo
final BuiltList<String> sort = ; // BuiltList<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

try {
    final response = api.listComment(page, size, labelSelector, fieldSelector, sort);
    print(response);
} catch on DioException (e) {
    print('Exception when calling CommentV1alpha1Api->listComment: $e\n');
}

Parameters

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

Return type

CommentList

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

patchComment

Comment patchComment(name, jsonPatchInner)

Patch Comment

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getCommentV1alpha1Api();
final String name = name_example; // String | Name of comment
final BuiltSet<JsonPatchInner> jsonPatchInner = ; // BuiltSet<JsonPatchInner> | 

try {
    final response = api.patchComment(name, jsonPatchInner);
    print(response);
} catch on DioException (e) {
    print('Exception when calling CommentV1alpha1Api->patchComment: $e\n');
}

Parameters

Name Type Description Notes
name String Name of comment
jsonPatchInner BuiltSet<JsonPatchInner> [optional]

Return type

Comment

Authorization

basicAuth, bearerAuth

HTTP request headers

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

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

updateComment

Comment updateComment(name, comment)

Update Comment

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getCommentV1alpha1Api();
final String name = name_example; // String | Name of comment
final Comment comment = ; // Comment | Updated comment

try {
    final response = api.updateComment(name, comment);
    print(response);
} catch on DioException (e) {
    print('Exception when calling CommentV1alpha1Api->updateComment: $e\n');
}

Parameters

Name Type Description Notes
name String Name of comment
comment Comment Updated comment [optional]

Return type

Comment

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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