Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 9.75 KB

SinglePageV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 9.75 KB

halo_client.api.SinglePageV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
createSinglePage POST /apis/content.halo.run/v1alpha1/singlepages
deleteSinglePage DELETE /apis/content.halo.run/v1alpha1/singlepages/{name}
getSinglePage GET /apis/content.halo.run/v1alpha1/singlepages/{name}
listSinglePage GET /apis/content.halo.run/v1alpha1/singlepages
patchSinglePage PATCH /apis/content.halo.run/v1alpha1/singlepages/{name}
updateSinglePage PUT /apis/content.halo.run/v1alpha1/singlepages/{name}

createSinglePage

SinglePage createSinglePage(singlePage)

Create SinglePage

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().getSinglePageV1alpha1Api();
final SinglePage singlePage = ; // SinglePage | Fresh singlepage

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

Parameters

Name Type Description Notes
singlePage SinglePage Fresh singlepage [optional]

Return type

SinglePage

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]

deleteSinglePage

deleteSinglePage(name)

Delete SinglePage

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

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

Parameters

Name Type Description Notes
name String Name of singlepage

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]

getSinglePage

SinglePage getSinglePage(name)

Get SinglePage

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

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

Parameters

Name Type Description Notes
name String Name of singlepage

Return type

SinglePage

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]

listSinglePage

SinglePageList listSinglePage(page, size, labelSelector, fieldSelector, sort)

List SinglePage

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

SinglePageList

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]

patchSinglePage

SinglePage patchSinglePage(name, jsonPatchInner)

Patch SinglePage

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

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

Parameters

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

Return type

SinglePage

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]

updateSinglePage

SinglePage updateSinglePage(name, singlePage)

Update SinglePage

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().getSinglePageV1alpha1Api();
final String name = name_example; // String | Name of singlepage
final SinglePage singlePage = ; // SinglePage | Updated singlepage

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

Parameters

Name Type Description Notes
name String Name of singlepage
singlePage SinglePage Updated singlepage [optional]

Return type

SinglePage

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]