validate method

Future<DynamiteResponse<OpenLocalEditorValidateResponseApplicationJson, void>> validate({
  1. required String path,
  2. required String token,
  3. bool? oCSAPIRequest,
})

Validate a local editor.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • path Path of the file.
  • token Token of the local editor.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Local editor validated successfully
  • 404: Local editor not found

See:

  • validateRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<OpenLocalEditorValidateResponseApplicationJson, void>> validate({
  required String path,
  required String token,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = validateRaw(
    path: path,
    token: token,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}