addString: CrowdinValidationError: Value is required and can't be empty

[beshur]

Hello.

Trying to add a string using SourceStrings class.

Setup:

const {SourceStrings} = require('@crowdin/crowdin-api-client');
const PROJECT_ID = <ID>;
const TOKEN = '...';

const sourceStringsApi = new SourceStrings({
  token: TOKEN,
});

// get all strings via CroQL query
const search = (croql) =>
  sourceStringsApi.listProjectStrings(PROJECT_ID, {
    croql,
    limit: 500,
  });

// add new string
const addString = (identifier, text) => {
  console.log('--addstring', {identifier, text});
  return sourceStringsApi.addString(PROJECT_ID, {
    identifier,
    text,
  });
};

Console output:

add test.doNotTranslate Do not translate, it's a test
--addstring {
  identifier: 'test.doNotTranslate',
  text: "Do not translate, it's a test"
}
proiseall error CrowdinValidationError: Value is required and can't be empty
    at handleError (.../node_modules/@crowdin/crowdin-api-client/out/core/index.js:43:15)
    at .../node_modules/@crowdin/crowdin-api-client/out/core/index.js:183:108
    at processTicksAndRejections (internal/process/task_queues.js:95:5)
    at async RetryService.executeAsyncFunc (.../node_modules/@crowdin/crowdin-api-client/out/core/internal/retry/index.js:14:32)
    at async Promise.all (index 0)
    at async .../tools/lang/diffToCrowdin.js:128:10 {
  code: 400,
  validationCodes: [ 'isEmpty' ]
}

identifier and text are in place, but I still get error 400.

[andrii-bodnar]

Hi @beshur!

You need to pass the fileId also. It's required for file-based projects. https://support.crowdin.com/api/v2/#operation/api.projects.strings.post

[andrii-bodnar]

@beshur could you please check the API logs in your Crowdin project? Tools > API

[beshur]

Oh, great, there are logs, thank you.

For input:

op: replace
path: /text
value: Do not translate, it's a test111

Says:

{
    "errors": [
        {
            "error": {
                "key": "op",
                "errors": [
                    {
                        "code": "jsonPatchInvalid",
                        "message": "Invalid operation given"
                    }
                ]
            }
        },
        {
            "error": {
                "key": "path",
                "errors": [
                    {
                        "code": "jsonPatchInvalid",
                        "message": "Invalid operation given"
                    }
                ]
            }
        },
        {
            "error": {
                "key": "value",
                "errors": [
                    {
                        "code": "jsonPatchInvalid",
                        "message": "Invalid operation given"
                    }
                ]
            }
        }
    ]
}

Looks like the params from the docs to me:

[beshur]

Oh wait,
so the second param is an array of changes object [{value: '', op: '', path: ''}]?

[andrii-bodnar]

@beshur it should be an array of operations, like this:

await crowdinInstance.sourceStringsApi.editString(PROJECT_ID, stringId, [
  {
    path: "/text",
    op: PatchOperation.REPLACE,
    value: "some value"
  },
  {
    path: "/context",
    op: PatchOperation.REPLACE,
    value: "some value"
  },
  {
    path: "/maxLength",
    op: PatchOperation.REPLACE,
    value: "some value"
  },
  {
    path: "/identifier",
    op: PatchOperation.REPLACE,
    value: "some value"
  }
])

[beshur]

Great, thank you.