Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 9 KB

MenuV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 9 KB

halo_client.api.MenuV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
createMenu POST /api/v1alpha1/menus
deleteMenu DELETE /api/v1alpha1/menus/{name}
getMenu GET /api/v1alpha1/menus/{name}
listMenu GET /api/v1alpha1/menus
patchMenu PATCH /api/v1alpha1/menus/{name}
updateMenu PUT /api/v1alpha1/menus/{name}

createMenu

Menu createMenu(menu)

Create Menu

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().getMenuV1alpha1Api();
final Menu menu = ; // Menu | Fresh menu

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

Parameters

Name Type Description Notes
menu Menu Fresh menu [optional]

Return type

Menu

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]

deleteMenu

deleteMenu(name)

Delete Menu

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

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

Parameters

Name Type Description Notes
name String Name of menu

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]

getMenu

Menu getMenu(name)

Get Menu

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

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

Parameters

Name Type Description Notes
name String Name of menu

Return type

Menu

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]

listMenu

MenuList listMenu(page, size, labelSelector, fieldSelector, sort)

List Menu

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

MenuList

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]

patchMenu

Menu patchMenu(name, jsonPatchInner)

Patch Menu

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

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

Parameters

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

Return type

Menu

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]

updateMenu

Menu updateMenu(name, menu)

Update Menu

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().getMenuV1alpha1Api();
final String name = name_example; // String | Name of menu
final Menu menu = ; // Menu | Updated menu

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

Parameters

Name Type Description Notes
name String Name of menu
menu Menu Updated menu [optional]

Return type

Menu

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]