Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 9.64 KB

ThumbnailV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 9.64 KB

halo_client.api.ThumbnailV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
createThumbnail POST /apis/storage.halo.run/v1alpha1/thumbnails
deleteThumbnail DELETE /apis/storage.halo.run/v1alpha1/thumbnails/{name}
getThumbnail GET /apis/storage.halo.run/v1alpha1/thumbnails/{name}
listThumbnail GET /apis/storage.halo.run/v1alpha1/thumbnails
patchThumbnail PATCH /apis/storage.halo.run/v1alpha1/thumbnails/{name}
updateThumbnail PUT /apis/storage.halo.run/v1alpha1/thumbnails/{name}

createThumbnail

Thumbnail createThumbnail(thumbnail)

Create Thumbnail

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().getThumbnailV1alpha1Api();
final Thumbnail thumbnail = ; // Thumbnail | Fresh thumbnail

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

Parameters

Name Type Description Notes
thumbnail Thumbnail Fresh thumbnail [optional]

Return type

Thumbnail

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]

deleteThumbnail

deleteThumbnail(name)

Delete Thumbnail

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

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

Parameters

Name Type Description Notes
name String Name of thumbnail

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]

getThumbnail

Thumbnail getThumbnail(name)

Get Thumbnail

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

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

Parameters

Name Type Description Notes
name String Name of thumbnail

Return type

Thumbnail

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]

listThumbnail

ThumbnailList listThumbnail(page, size, labelSelector, fieldSelector, sort)

List Thumbnail

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

ThumbnailList

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]

patchThumbnail

Thumbnail patchThumbnail(name, jsonPatchInner)

Patch Thumbnail

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

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

Parameters

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

Return type

Thumbnail

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]

updateThumbnail

Thumbnail updateThumbnail(name, thumbnail)

Update Thumbnail

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().getThumbnailV1alpha1Api();
final String name = name_example; // String | Name of thumbnail
final Thumbnail thumbnail = ; // Thumbnail | Updated thumbnail

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

Parameters

Name Type Description Notes
name String Name of thumbnail
thumbnail Thumbnail Updated thumbnail [optional]

Return type

Thumbnail

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]