Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 11.2 KB

ExtensionPointDefinitionV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 11.2 KB

halo_client.api.ExtensionPointDefinitionV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
createExtensionPointDefinition POST /apis/plugin.halo.run/v1alpha1/extensionpointdefinitions
deleteExtensionPointDefinition DELETE /apis/plugin.halo.run/v1alpha1/extensionpointdefinitions/{name}
getExtensionPointDefinition GET /apis/plugin.halo.run/v1alpha1/extensionpointdefinitions/{name}
listExtensionPointDefinition GET /apis/plugin.halo.run/v1alpha1/extensionpointdefinitions
patchExtensionPointDefinition PATCH /apis/plugin.halo.run/v1alpha1/extensionpointdefinitions/{name}
updateExtensionPointDefinition PUT /apis/plugin.halo.run/v1alpha1/extensionpointdefinitions/{name}

createExtensionPointDefinition

ExtensionPointDefinition createExtensionPointDefinition(extensionPointDefinition)

Create ExtensionPointDefinition

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().getExtensionPointDefinitionV1alpha1Api();
final ExtensionPointDefinition extensionPointDefinition = ; // ExtensionPointDefinition | Fresh extensionpointdefinition

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

Parameters

Name Type Description Notes
extensionPointDefinition ExtensionPointDefinition Fresh extensionpointdefinition [optional]

Return type

ExtensionPointDefinition

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]

deleteExtensionPointDefinition

deleteExtensionPointDefinition(name)

Delete ExtensionPointDefinition

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

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

Parameters

Name Type Description Notes
name String Name of extensionpointdefinition

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]

getExtensionPointDefinition

ExtensionPointDefinition getExtensionPointDefinition(name)

Get ExtensionPointDefinition

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

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

Parameters

Name Type Description Notes
name String Name of extensionpointdefinition

Return type

ExtensionPointDefinition

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]

listExtensionPointDefinition

ExtensionPointDefinitionList listExtensionPointDefinition(page, size, labelSelector, fieldSelector, sort)

List ExtensionPointDefinition

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

ExtensionPointDefinitionList

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]

patchExtensionPointDefinition

ExtensionPointDefinition patchExtensionPointDefinition(name, jsonPatchInner)

Patch ExtensionPointDefinition

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

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

Parameters

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

Return type

ExtensionPointDefinition

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]

updateExtensionPointDefinition

ExtensionPointDefinition updateExtensionPointDefinition(name, extensionPointDefinition)

Update ExtensionPointDefinition

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().getExtensionPointDefinitionV1alpha1Api();
final String name = name_example; // String | Name of extensionpointdefinition
final ExtensionPointDefinition extensionPointDefinition = ; // ExtensionPointDefinition | Updated extensionpointdefinition

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

Parameters

Name Type Description Notes
name String Name of extensionpointdefinition
extensionPointDefinition ExtensionPointDefinition Updated extensionpointdefinition [optional]

Return type

ExtensionPointDefinition

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]