search

GALAglobal / TAPICC-API-implementation

TAPICC API implementation using node.js framework sails.js
Other
6 stars 1 forks source link

file and isReference of Asset #19

Closed Alino closed 6 years ago

Alino commented 6 years ago

Yves was asking the following question

Could someone explain the function of the “file” and “isReference” fields in the Asset object?

Is “file? a URL used when “isReference” is set to true, and then the host is expected to get the document from that URL? And if isReference is set to false, “file” is not used and the document is uploaded using /job/{id}/asset/uploadfile? Or is “isReference” is saying that this specific asset is actually just part of the reference materials and should not be localized? Or something else?

If the answer is the first option, then I’m wondering if the mode of submission should be part of the data. We should probably have only one way to submit an asset and if different options are needed we could maybe base that on parameters.

Alino commented 6 years ago

file is currently always a binary type. So it's an actual file. We might want to change this to be an URL later.

isReference is a boolean type. If it is set to true, then it means that the Asset is there just for reference, it could be some manuals or examples which are not supposed to be translated.