Viewing last 25 versions of post by Damaged in topic Philomena open beta / breaking API changes

Been meaning to get around to doing this. This is just a list of gotchas on the API side of things. These are not bugs, but rather differences in how data are expressed.

_
 
***ALL*_

*@*
 
**`image@` objects*

[bq]@*
 

> `file_name@` value is now just @`name@
@`
> `tags@` is now type @`list@` instead of a comma-separated string.
@
> `representations@` are now full URLs (complete with protocol). ex @`https://derpicdn.net/img/2012/1/2/0/small.jpg@
@`
> `image@` is now @`view_url@
@`
> `original_format@` is now @`format@
@`
> `is_optimized@` and @`is_rendered@` are now just @`processed@[/bq]

`

 
**GET /api/v1/json/images/:image_id*

[bq]*
 

> Image data is now wrapped in an @`image@` object.[/bq]



 
**GET /api/v1/json/search*

[bq]@*
 

> `search@` container is now named @`images@[`
> RFC3339 date/bq]

time strings must not have fractions of seconds

 
**GET /api/v1/json/tags/:tag-slug*

[bq]*
 

> Tag data wrapped in a @`tag@` object.

> Only contains the tag's data without any extras (image data, etc).[/bq]



 
**POST /api/v1/json/search/reverse*

*
 
ex: @`https://philomena.derpibooru.org/api/v1/json/search/reverse?url=https%3A%2F%2Fderpicdn.net%2Fimg%2Fview%2F2019%2F12%2F16%2F2221988.jpg&image[distance]=0.5@

[bq]`
 

> Takes @`url@` and @`image[distance]@` params.

> Returns @`images@` obejects. If list is empty, no results were found.[/bq]



 
I'll update this as more things come out

Been meaning to get around to doing this. This is just a list of gotchas on the API side of things. These are not bugs, but rather differences in how data are expressed.

_*ALL*_

*@image@ objects*

[bq]@file_name@ value is now just @name@
@tags@ is now type @list@ instead of a comma-separated string.
@representations@ are now full URLs (complete with protocol). ex @https://derpicdn.net/img/2012/1/2/0/small.jpg@
@image@ is now @view_url@
@original_format@ is now @format@
@is_optimized@ and @is_rendered@ are now just @processed@[/bq]

*GET /api/v1/json/images/:image_id*

[bq]Image data is now wrapped in an @image@ object.[/bq]

*GET /api/v1/json/search*

[bq]@search@ container is now named @images@[/bq]

*GET /api/v1/json/tags/:tag-slug*

[bq]Tag data wrapped in a @tag@ object.
Only contains the tag's data without any extras (image data, etc).[/bq]

*POST /api/v1/json/search/reverse*

ex: @https://philomena.derpibooru.org/api/v1/json/search/reverse?url=https%3A%2F%2Fderpicdn.net%2Fimg%2Fview%2F2019%2F12%2F16%2F2221988.jpg&image[distance]=0.5@

[bq]Takes @url@ and @image[distance]@ params.
Returns @images@ obejects. If list is empty, no results were found.[/bq]

I'll update this as more things come out

Been meaning to get around to doing this. This is just a list of gotchas on the API side of things. These are not bugs, but rather differences in how data are expressed.

_*ALL*_

*@image@ objects*

[bq]@file_name@ value is now just @name@
@tags@ is now type @list@ instead of a comma-separated string.
@representations@ are now full URLs (complete with protocol). ex @https://derpicdn.net/img/2012/1/2/0/small.jpg@[/bq]

*GET /api/v1/json/images/:image_id*

[bq]Image data is now wrapped in an @image@ object.[/bq]

*GET /api/v1/json/search*

[bq]@search@ container is now named @images@[/bq]

*GET /api/vi1/json/tags/:tag-slug*

[bq]Tag data wrapped in a @tag@ object.
Only contains the tag's data without any extras (image data, etc).[/bq]

*POST /api/v1/json/search/reverse*

ex: @https://philomena.derpibooru.org/api/v1/json/search/reverse?url=https%3A%2F%2Fderpicdn.net%2Fimg%2Fview%2F2019%2F12%2F16%2F2221988.jpg&image[distance]=0.5@

[bq]Takes @url@ and @image[distance]@ params.
Returns @images@ obejects. If list is empty, no results were found.[/bq]

I'll update this as more things come out

Been meaning to get around to doing this. This is just a list of gotchas on the API side of things. These are not bugs, but rather differences in how data are expressed.

_*ALL*_

*@image@ objects*

[bq]@file_name@ value is now just @name@
@tags@ is now type @list@ instead of a comma-separated string.
@representations@ are now full URLs (complete with protocol). ex @https://derpicdn.net/img/2012/1/2/0/small.jpg@[/bq]

*GET /api/v1/json/images/:image_id*

[bq]Image data is now wrapped in an @image@ object.[/bq]

*GET /api/v1/json/search*

[bq]@search@ container is now named @images@[/bq]

*GET /api/vi/json/tags/:tag-slug*

[bq]Tag data wrapped in a @tag@ object.
Only contains the tag's data without any extras (image data, etc).[/bq]

I'll update this as more things come out