getRest method

Future<RestDescription> getRest(
  1. String api,
  2. String version, {
  3. String? $fields,
})

Retrieve the description of a particular version of an api.

Request parameters:

api - The name of the API.

version - The version of the API.

$fields - Selector specifying which fields to include in a partial response.

Completes with a RestDescription.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<RestDescription> getRest(
  core.String api,
  core.String version, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'apis/' +
      commons.escapeVariable('$api') +
      '/' +
      commons.escapeVariable('$version') +
      '/rest';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return RestDescription.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}