Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 9.96 KB

SearchEngineV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 9.96 KB

halo_client.api.SearchEngineV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
createSearchEngine POST /apis/plugin.halo.run/v1alpha1/searchengines
deleteSearchEngine DELETE /apis/plugin.halo.run/v1alpha1/searchengines/{name}
getSearchEngine GET /apis/plugin.halo.run/v1alpha1/searchengines/{name}
listSearchEngine GET /apis/plugin.halo.run/v1alpha1/searchengines
patchSearchEngine PATCH /apis/plugin.halo.run/v1alpha1/searchengines/{name}
updateSearchEngine PUT /apis/plugin.halo.run/v1alpha1/searchengines/{name}

createSearchEngine

SearchEngine createSearchEngine(searchEngine)

Create SearchEngine

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().getSearchEngineV1alpha1Api();
final SearchEngine searchEngine = ; // SearchEngine | Fresh searchengine

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

Parameters

Name Type Description Notes
searchEngine SearchEngine Fresh searchengine [optional]

Return type

SearchEngine

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]

deleteSearchEngine

deleteSearchEngine(name)

Delete SearchEngine

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

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

Parameters

Name Type Description Notes
name String Name of searchengine

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]

getSearchEngine

SearchEngine getSearchEngine(name)

Get SearchEngine

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

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

Parameters

Name Type Description Notes
name String Name of searchengine

Return type

SearchEngine

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]

listSearchEngine

SearchEngineList listSearchEngine(page, size, labelSelector, fieldSelector, sort)

List SearchEngine

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

SearchEngineList

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]

patchSearchEngine

SearchEngine patchSearchEngine(name, jsonPatchInner)

Patch SearchEngine

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

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

Parameters

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

Return type

SearchEngine

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]

updateSearchEngine

SearchEngine updateSearchEngine(name, searchEngine)

Update SearchEngine

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().getSearchEngineV1alpha1Api();
final String name = name_example; // String | Name of searchengine
final SearchEngine searchEngine = ; // SearchEngine | Updated searchengine

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

Parameters

Name Type Description Notes
name String Name of searchengine
searchEngine SearchEngine Updated searchengine [optional]

Return type

SearchEngine

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]