Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 10.2 KB

LocalThumbnailV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 10.2 KB

halo_client.api.LocalThumbnailV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
createLocalThumbnail POST /apis/storage.halo.run/v1alpha1/localthumbnails
deleteLocalThumbnail DELETE /apis/storage.halo.run/v1alpha1/localthumbnails/{name}
getLocalThumbnail GET /apis/storage.halo.run/v1alpha1/localthumbnails/{name}
listLocalThumbnail GET /apis/storage.halo.run/v1alpha1/localthumbnails
patchLocalThumbnail PATCH /apis/storage.halo.run/v1alpha1/localthumbnails/{name}
updateLocalThumbnail PUT /apis/storage.halo.run/v1alpha1/localthumbnails/{name}

createLocalThumbnail

LocalThumbnail createLocalThumbnail(localThumbnail)

Create LocalThumbnail

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().getLocalThumbnailV1alpha1Api();
final LocalThumbnail localThumbnail = ; // LocalThumbnail | Fresh localthumbnail

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

Parameters

Name Type Description Notes
localThumbnail LocalThumbnail Fresh localthumbnail [optional]

Return type

LocalThumbnail

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]

deleteLocalThumbnail

deleteLocalThumbnail(name)

Delete LocalThumbnail

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

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

Parameters

Name Type Description Notes
name String Name of localthumbnail

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]

getLocalThumbnail

LocalThumbnail getLocalThumbnail(name)

Get LocalThumbnail

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

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

Parameters

Name Type Description Notes
name String Name of localthumbnail

Return type

LocalThumbnail

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]

listLocalThumbnail

LocalThumbnailList listLocalThumbnail(page, size, labelSelector, fieldSelector, sort)

List LocalThumbnail

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

LocalThumbnailList

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]

patchLocalThumbnail

LocalThumbnail patchLocalThumbnail(name, jsonPatchInner)

Patch LocalThumbnail

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

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

Parameters

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

Return type

LocalThumbnail

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]

updateLocalThumbnail

LocalThumbnail updateLocalThumbnail(name, localThumbnail)

Update LocalThumbnail

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().getLocalThumbnailV1alpha1Api();
final String name = name_example; // String | Name of localthumbnail
final LocalThumbnail localThumbnail = ; // LocalThumbnail | Updated localthumbnail

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

Parameters

Name Type Description Notes
name String Name of localthumbnail
localThumbnail LocalThumbnail Updated localthumbnail [optional]

Return type

LocalThumbnail

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]