updateDocumentationVersion method

Future<DocumentationVersion> updateDocumentationVersion({
  1. required String documentationVersion,
  2. required String restApiId,
  3. List<PatchOperation>? patchOperations,
})

Updates a documentation version.

May throw BadRequestException. May throw ConflictException. May throw LimitExceededException. May throw NotFoundException. May throw TooManyRequestsException. May throw UnauthorizedException.

Parameter documentationVersion : The version identifier of the to-be-updated documentation version.

Parameter restApiId : The string identifier of the associated RestApi.

Parameter patchOperations : For more information about supported patch operations, see Patch Operations.

Implementation

Future<DocumentationVersion> updateDocumentationVersion({
  required String documentationVersion,
  required String restApiId,
  List<PatchOperation>? patchOperations,
}) async {
  final $payload = <String, dynamic>{
    if (patchOperations != null) 'patchOperations': patchOperations,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'PATCH',
    requestUri:
        '/restapis/${Uri.encodeComponent(restApiId)}/documentation/versions/${Uri.encodeComponent(documentationVersion)}',
    exceptionFnMap: _exceptionFns,
  );
  return DocumentationVersion.fromJson(response);
}