Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 9.31 KB

PluginV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 9.31 KB

halo_client.api.PluginV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
createPlugin POST /apis/plugin.halo.run/v1alpha1/plugins
deletePlugin DELETE /apis/plugin.halo.run/v1alpha1/plugins/{name}
getPlugin GET /apis/plugin.halo.run/v1alpha1/plugins/{name}
listPlugin GET /apis/plugin.halo.run/v1alpha1/plugins
patchPlugin PATCH /apis/plugin.halo.run/v1alpha1/plugins/{name}
updatePlugin PUT /apis/plugin.halo.run/v1alpha1/plugins/{name}

createPlugin

Plugin createPlugin(plugin)

Create Plugin

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().getPluginV1alpha1Api();
final Plugin plugin = ; // Plugin | Fresh plugin

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

Parameters

Name Type Description Notes
plugin Plugin Fresh plugin [optional]

Return type

Plugin

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]

deletePlugin

deletePlugin(name)

Delete Plugin

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

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

Parameters

Name Type Description Notes
name String Name of plugin

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]

getPlugin

Plugin getPlugin(name)

Get Plugin

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

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

Parameters

Name Type Description Notes
name String Name of plugin

Return type

Plugin

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]

listPlugin

PluginList listPlugin(page, size, labelSelector, fieldSelector, sort)

List Plugin

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

PluginList

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]

patchPlugin

Plugin patchPlugin(name, jsonPatchInner)

Patch Plugin

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

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

Parameters

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

Return type

Plugin

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]

updatePlugin

Plugin updatePlugin(name, plugin)

Update Plugin

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().getPluginV1alpha1Api();
final String name = name_example; // String | Name of plugin
final Plugin plugin = ; // Plugin | Updated plugin

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

Parameters

Name Type Description Notes
name String Name of plugin
plugin Plugin Updated plugin [optional]

Return type

Plugin

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]