Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 9.21 KB

ReplyV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 9.21 KB

halo_client.api.ReplyV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
createReply POST /apis/content.halo.run/v1alpha1/replies
deleteReply DELETE /apis/content.halo.run/v1alpha1/replies/{name}
getReply GET /apis/content.halo.run/v1alpha1/replies/{name}
listReply GET /apis/content.halo.run/v1alpha1/replies
patchReply PATCH /apis/content.halo.run/v1alpha1/replies/{name}
updateReply PUT /apis/content.halo.run/v1alpha1/replies/{name}

createReply

Reply createReply(reply)

Create Reply

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().getReplyV1alpha1Api();
final Reply reply = ; // Reply | Fresh reply

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

Parameters

Name Type Description Notes
reply Reply Fresh reply [optional]

Return type

Reply

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]

deleteReply

deleteReply(name)

Delete Reply

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().getReplyV1alpha1Api();
final String name = name_example; // String | Name of reply

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

Parameters

Name Type Description Notes
name String Name of reply

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]

getReply

Reply getReply(name)

Get Reply

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().getReplyV1alpha1Api();
final String name = name_example; // String | Name of reply

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

Parameters

Name Type Description Notes
name String Name of reply

Return type

Reply

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]

listReply

ReplyList listReply(page, size, labelSelector, fieldSelector, sort)

List Reply

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().getReplyV1alpha1Api();
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.listReply(page, size, labelSelector, fieldSelector, sort);
    print(response);
} catch on DioException (e) {
    print('Exception when calling ReplyV1alpha1Api->listReply: $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

ReplyList

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]

patchReply

Reply patchReply(name, jsonPatchInner)

Patch Reply

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().getReplyV1alpha1Api();
final String name = name_example; // String | Name of reply
final BuiltSet<JsonPatchInner> jsonPatchInner = ; // BuiltSet<JsonPatchInner> | 

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

Parameters

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

Return type

Reply

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]

updateReply

Reply updateReply(name, reply)

Update Reply

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().getReplyV1alpha1Api();
final String name = name_example; // String | Name of reply
final Reply reply = ; // Reply | Updated reply

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

Parameters

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

Return type

Reply

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]