Skip to content

Latest commit

 

History

History
115 lines (78 loc) · 4.07 KB

SinglePageV1alpha1PublicApi.md

File metadata and controls

115 lines (78 loc) · 4.07 KB

halo_client.api.SinglePageV1alpha1PublicApi

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
querySinglePageByName GET /apis/api.content.halo.run/v1alpha1/singlepages/{name}
querySinglePages GET /apis/api.content.halo.run/v1alpha1/singlepages

querySinglePageByName

SinglePageVo querySinglePageByName(name)

Gets single page by name

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().getSinglePageV1alpha1PublicApi();
final String name = name_example; // String | SinglePage name

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

Parameters

Name Type Description Notes
name String SinglePage name

Return type

SinglePageVo

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]

querySinglePages

ListedSinglePageVoList querySinglePages(page, size, labelSelector, fieldSelector, sort)

Lists single pages

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

ListedSinglePageVoList

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]