Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 9.43 KB

MenuItemV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 9.43 KB

halo_client.api.MenuItemV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
createMenuItem POST /api/v1alpha1/menuitems
deleteMenuItem DELETE /api/v1alpha1/menuitems/{name}
getMenuItem GET /api/v1alpha1/menuitems/{name}
listMenuItem GET /api/v1alpha1/menuitems
patchMenuItem PATCH /api/v1alpha1/menuitems/{name}
updateMenuItem PUT /api/v1alpha1/menuitems/{name}

createMenuItem

MenuItem createMenuItem(menuItem)

Create MenuItem

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().getMenuItemV1alpha1Api();
final MenuItem menuItem = ; // MenuItem | Fresh menuitem

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

Parameters

Name Type Description Notes
menuItem MenuItem Fresh menuitem [optional]

Return type

MenuItem

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]

deleteMenuItem

deleteMenuItem(name)

Delete MenuItem

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

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

Parameters

Name Type Description Notes
name String Name of menuitem

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]

getMenuItem

MenuItem getMenuItem(name)

Get MenuItem

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

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

Parameters

Name Type Description Notes
name String Name of menuitem

Return type

MenuItem

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]

listMenuItem

MenuItemList listMenuItem(page, size, labelSelector, fieldSelector, sort)

List MenuItem

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

MenuItemList

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]

patchMenuItem

MenuItem patchMenuItem(name, jsonPatchInner)

Patch MenuItem

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

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

Parameters

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

Return type

MenuItem

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]

updateMenuItem

MenuItem updateMenuItem(name, menuItem)

Update MenuItem

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().getMenuItemV1alpha1Api();
final String name = name_example; // String | Name of menuitem
final MenuItem menuItem = ; // MenuItem | Updated menuitem

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

Parameters

Name Type Description Notes
name String Name of menuitem
menuItem MenuItem Updated menuitem [optional]

Return type

MenuItem

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]