Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 10.2 KB

UserConnectionV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 10.2 KB

halo_client.api.UserConnectionV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
createUserConnection POST /apis/auth.halo.run/v1alpha1/userconnections
deleteUserConnection DELETE /apis/auth.halo.run/v1alpha1/userconnections/{name}
getUserConnection GET /apis/auth.halo.run/v1alpha1/userconnections/{name}
listUserConnection GET /apis/auth.halo.run/v1alpha1/userconnections
patchUserConnection PATCH /apis/auth.halo.run/v1alpha1/userconnections/{name}
updateUserConnection PUT /apis/auth.halo.run/v1alpha1/userconnections/{name}

createUserConnection

UserConnection createUserConnection(userConnection)

Create UserConnection

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().getUserConnectionV1alpha1Api();
final UserConnection userConnection = ; // UserConnection | Fresh userconnection

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

Parameters

Name Type Description Notes
userConnection UserConnection Fresh userconnection [optional]

Return type

UserConnection

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]

deleteUserConnection

deleteUserConnection(name)

Delete UserConnection

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

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

Parameters

Name Type Description Notes
name String Name of userconnection

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]

getUserConnection

UserConnection getUserConnection(name)

Get UserConnection

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

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

Parameters

Name Type Description Notes
name String Name of userconnection

Return type

UserConnection

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]

listUserConnection

UserConnectionList listUserConnection(page, size, labelSelector, fieldSelector, sort)

List UserConnection

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

UserConnectionList

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]

patchUserConnection

UserConnection patchUserConnection(name, jsonPatchInner)

Patch UserConnection

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

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

Parameters

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

Return type

UserConnection

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]

updateUserConnection

UserConnection updateUserConnection(name, userConnection)

Update UserConnection

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().getUserConnectionV1alpha1Api();
final String name = name_example; // String | Name of userconnection
final UserConnection userConnection = ; // UserConnection | Updated userconnection

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

Parameters

Name Type Description Notes
name String Name of userconnection
userConnection UserConnection Updated userconnection [optional]

Return type

UserConnection

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]