getDocumentation method

Future<GoogleCloudApigeeV1ApiDocDocumentationResponse> getDocumentation(
  1. String name, {
  2. String? $fields,
})

Gets the documentation for the specified catalog item.

Request parameters:

name - Required. Resource name of the catalog item documentation. Use the following structure in your request: organizations/{org}/sites/{site}/apidocs/{apidoc}/documentation Value must have pattern ^organizations/\[^/\]+/sites/\[^/\]+/apidocs/\[^/\]+/documentation$.

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

Completes with a GoogleCloudApigeeV1ApiDocDocumentationResponse.

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<GoogleCloudApigeeV1ApiDocDocumentationResponse> getDocumentation(
  core.String name, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ = 'v1/' + core.Uri.encodeFull('$name');

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