open-api icon indicating copy to clipboard operation
open-api copied to clipboard

[ENDPOINT]: Proposed design change for getListingImages

Open DemiImp opened this issue 3 years ago • 0 comments

Is there an existing issue for this?

  • [X] I have searched the existing tickets

Current Endpoint Design

https://openapi.etsy.com/v3/application/shops/{shop_id}/listings/{listing_id}/images

Proposed Endpoint Design Change

https://openapi.etsy.com/v3/application/listings/{listing_id}/images

Why are you proposing this change?

The URL for getListing is:

https://openapi.etsy.com/v3/application/listings/{listing_id}

Requiring the shop_id in the URL for getListingImages breaks the pattern (it's not called getShopListingImages).

In addition, requiring the shop_id forces us to make an additional step where we must make a request to obtaining the shop_id... OR it forces us to request the entire listing data using the includes parameter, which ends up requesting a ton of information that we honestly don't care about.

DemiImp avatar Feb 05 '22 00:02 DemiImp