Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 9.21 KB

GroupV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 9.21 KB

halo_client.api.GroupV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
createGroup POST /apis/storage.halo.run/v1alpha1/groups
deleteGroup DELETE /apis/storage.halo.run/v1alpha1/groups/{name}
getGroup GET /apis/storage.halo.run/v1alpha1/groups/{name}
listGroup GET /apis/storage.halo.run/v1alpha1/groups
patchGroup PATCH /apis/storage.halo.run/v1alpha1/groups/{name}
updateGroup PUT /apis/storage.halo.run/v1alpha1/groups/{name}

createGroup

Group createGroup(group)

Create Group

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().getGroupV1alpha1Api();
final Group group = ; // Group | Fresh group

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

Parameters

Name Type Description Notes
group Group Fresh group [optional]

Return type

Group

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]

deleteGroup

deleteGroup(name)

Delete Group

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

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

Parameters

Name Type Description Notes
name String Name of group

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]

getGroup

Group getGroup(name)

Get Group

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

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

Parameters

Name Type Description Notes
name String Name of group

Return type

Group

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]

listGroup

GroupList listGroup(page, size, labelSelector, fieldSelector, sort)

List Group

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

GroupList

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]

patchGroup

Group patchGroup(name, jsonPatchInner)

Patch Group

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

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

Parameters

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

Return type

Group

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]

updateGroup

Group updateGroup(name, group)

Update Group

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().getGroupV1alpha1Api();
final String name = name_example; // String | Name of group
final Group group = ; // Group | Updated group

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

Parameters

Name Type Description Notes
name String Name of group
group Group Updated group [optional]

Return type

Group

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]