updateDocumentationPart method

Future<DocumentationPart> updateDocumentationPart({
  1. required String documentationPartId,
  2. required String restApiId,
  3. List<PatchOperation>? patchOperations,
})

Updates a documentation part.

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

Parameter documentationPartId : The identifier of the to-be-updated documentation part.

Parameter restApiId : The string identifier of the associated RestApi.

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

Implementation

Future<DocumentationPart> updateDocumentationPart({
  required String documentationPartId,
  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/parts/${Uri.encodeComponent(documentationPartId)}',
    exceptionFnMap: _exceptionFns,
  );
  return DocumentationPart.fromJson(response);
}