feat(API): Add 'update_translation_keys' for Uploads [TSI-2292] #578
Conversation
| @@ -106,7 +107,7 @@ public void uploadCreateTest() throws ApiException, IOException, InterruptedExce | |||
| Boolean autotranslate = null; | |||
| Boolean markReviewed = null; | |||
| Boolean tagOnlyAffectedKeys = null; | |||
| Upload response = api.uploadCreate(projectId, xPhraseAppOTP, branch, file, fileFormat, localeId, tags, updateTranslations, updateDescriptions, convertEmoji, skipUploadTags, skipUnverification, fileEncoding, localeMapping, formatOptions, autotranslate, markReviewed, tagOnlyAffectedKeys); | |||
| Upload response = api.uploadCreate(projectId, xPhraseAppOTP, branch, file, fileFormat, localeId, tags, updateTranslations, updateTranslationKeys, updateDescriptions, convertEmoji, skipUploadTags, skipUnverification, fileEncoding, localeMapping, formatOptions, autotranslate, markReviewed, tagOnlyAffectedKeys); | |||
There was a problem hiding this comment.
it's interesting that this was needed. I thought this parameter is not required? any idea why it's part of the signature?
There was a problem hiding this comment.
I checked the newly built Java client, in fact other params that are marked as optional are all passed to the method. I guess all these arguments have to be passed to the method, we can set null for the ones that are optional.
There was a problem hiding this comment.
Because if I am not wrong, a Java method would expect all the options to be passed, its within the method where we check if the option is present, then assign it to the payload.
There was a problem hiding this comment.
interesting, technically that means that any such change should be marked as breaking for java lib :( but I guess we won't be doing that.
There was a problem hiding this comment.
Thats a good point, should we maybe change feat to feat! in the commit message? To represent a potentially breaking change via major version bump?
There was a problem hiding this comment.
I don't think so. This change shouldn't be a breaking one, we added an optional field. However, seems to me that Java generator is not correct so it generates a breaking change for Java. I don't think we have a way right now to declare breaking changes only for a single platform.
So, I'd keep this a minor version bump as usual, but we should be aware of this Java generator quirk, and perhaps try to address it in the future (perhaps updating the Java templates to newer version would be enough, although even that is no easy job).
|
Pending confirmation of the fix from customer. Once received, docs will be updated. |
hahmed-dev
force-pushed
the
update-translation-keys-for-uploads
branch
from
81eb7c5
to
3ffbcc9
Compare
|
@hahmed-dev How does this new parameter differ from 📖 It doesn't seem to be mentioned yet in the CLI docs or sample configuration file. |
|
@infotexture thanks for pointing out, at the moment its only documented in API docs. We will have CLI relevant docs updated as well.
This option prevents changing any attribute of an existing key or creating a new one (if its missing) during upload, by default its |
Documents the newly introduced option
update_translation_keysforPOST#Upload.Related Issues: