Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 10.4 KB

AnnotationSettingV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 10.4 KB

halo_client.api.AnnotationSettingV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
createAnnotationSetting POST /api/v1alpha1/annotationsettings
deleteAnnotationSetting DELETE /api/v1alpha1/annotationsettings/{name}
getAnnotationSetting GET /api/v1alpha1/annotationsettings/{name}
listAnnotationSetting GET /api/v1alpha1/annotationsettings
patchAnnotationSetting PATCH /api/v1alpha1/annotationsettings/{name}
updateAnnotationSetting PUT /api/v1alpha1/annotationsettings/{name}

createAnnotationSetting

AnnotationSetting createAnnotationSetting(annotationSetting)

Create AnnotationSetting

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().getAnnotationSettingV1alpha1Api();
final AnnotationSetting annotationSetting = ; // AnnotationSetting | Fresh annotationsetting

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

Parameters

Name Type Description Notes
annotationSetting AnnotationSetting Fresh annotationsetting [optional]

Return type

AnnotationSetting

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]

deleteAnnotationSetting

deleteAnnotationSetting(name)

Delete AnnotationSetting

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

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

Parameters

Name Type Description Notes
name String Name of annotationsetting

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]

getAnnotationSetting

AnnotationSetting getAnnotationSetting(name)

Get AnnotationSetting

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

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

Parameters

Name Type Description Notes
name String Name of annotationsetting

Return type

AnnotationSetting

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]

listAnnotationSetting

AnnotationSettingList listAnnotationSetting(page, size, labelSelector, fieldSelector, sort)

List AnnotationSetting

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

AnnotationSettingList

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]

patchAnnotationSetting

AnnotationSetting patchAnnotationSetting(name, jsonPatchInner)

Patch AnnotationSetting

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

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

Parameters

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

Return type

AnnotationSetting

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]

updateAnnotationSetting

AnnotationSetting updateAnnotationSetting(name, annotationSetting)

Update AnnotationSetting

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().getAnnotationSettingV1alpha1Api();
final String name = name_example; // String | Name of annotationsetting
final AnnotationSetting annotationSetting = ; // AnnotationSetting | Updated annotationsetting

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

Parameters

Name Type Description Notes
name String Name of annotationsetting
annotationSetting AnnotationSetting Updated annotationsetting [optional]

Return type

AnnotationSetting

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]