API version migration from v0.6 to v0.7 #17
Conversation
Bump version to 3.4.0-SNAPSHOT.
| /** | ||
| * Add special fields to the file object in the result. | ||
| * | ||
| * @param fields Example: "rekognition_info" | ||
| */ | ||
| fun addFields(fields: String): FilesQueryBuilder { | ||
| parameters["add_fields"] = AddFieldsParameter(fields) | ||
| fun include(fields: String): FilesQueryBuilder { |
There was a problem hiding this comment.
А ничего что мы ломаем апи взаимодействия с либой? Мы же можем оставить тот же нейминг чтобы клиентам было меньше рефакторить кода после обновления на новую версию либы?
There was a problem hiding this comment.
Мы можем оставить тот же нейминг, чтобы не ломать обратную совместимость, но это будет выглядеть странно, как минимум потому, что в доке апи они для либы свифта используют именно include. Можно сделать, конечно старый метод deprecated, и вызывать в нем include. Но я изначально в issue описывал именно переименование методов
| fun addFields(fields: String): FilesQueryBuilder { | ||
| parameters["add_fields"] = AddFieldsParameter(fields) | ||
| fun include(fields: String): FilesQueryBuilder { | ||
| parameters["include"] = IncludeParameter(fields) |
There was a problem hiding this comment.
Тот же вопрос по сути тут, зачем переименовал класс, только для семантики?
| @@ -142,11 +142,11 @@ class UploadcareClient constructor(val publicKey: String, | |||
| * @param fileId Resource UUID | |||
| * @return UploadcareFile resource | |||
| */ | |||
| fun getFileWithRekognitionInfo(fileId: String): UploadcareFile { | |||
| fun getFileWithAppData(fileId: String): UploadcareFile { | |||
There was a problem hiding this comment.
Название метода поменял, а в комментах Rekognition Info так и оставил.
И настолько ли важно переименовывать метод?
There was a problem hiding this comment.
Что вообще такое RecognitionInfo и AppData, мб я что-то не понимаю без контекста?
There was a problem hiding this comment.
Как я понял, AppData это объект с результатами аддонов, они были добавлены в 0.7 версии и позволяют проводить разные операции над файлом, типа удалить бэкграунд изображения, просканировать на вирусы и подобное. Переименование здесь обязательно, потому что это другая модель, RekognitionInfo был какой-то мапой категориями
| append("Variations: $variations").append(newline) | ||
| append("Rekognition Info: $rekognitionInfo").append(newline) | ||
| append("Appdata: $appdata").append(newline) |
There was a problem hiding this comment.
appendLine("Appdata: $appdata")
appendLine("Content info: $contentInfo")
appendLine("Metadata: $metadata")?
|
|
||
| @Suppress("unused") | ||
| enum class ColorMode { | ||
| RGB, RGBA, RGBa, RGBX, L, LA, La, P, PA, CMYK, YCbCr, HSV, LAB | ||
| } | ||
|
|
||
| @Parcelize | ||
| data class Appdata( |
There was a problem hiding this comment.
У меня такой вопрос, а ты проверял как все это работает, что все запросы которые с бэка приходят норм в эти модели десериализуются?
Co-authored-by: Roman Sedykh <[email protected]>
Co-authored-by: Roman Sedykh <[email protected]>
Co-authored-by: Roman Sedykh <[email protected]>
Co-authored-by: Roman Sedykh <[email protected]>
This pull request closes uploadcare#78