akeneo / pim-docs

[Community Documentation Repository] The open source Product Information Management (PIM)
http://docs.akeneo.com/latest/index.html
58 stars 147 forks source link

Http status code documentation/implementation mismatch #560

Closed pardahlman closed 7 years ago

pardahlman commented 7 years ago

I found a discrepancy in the API documentation over at api.akeneo.com. From what I can gather, this repo contains the source code to the "normal" documentation, so I suspect this isn't the right place to report this. Sorry! Is there a dedicated (public) repo for the API docs?

The endpoint for deleting products is expected to return 200 OK if the operation was successful (according to docs). When I use the endpoint in version 1.7.2, I get a 204 No Content when the operation is successful.

This isn't holding me up, I just thought I'd report this so that the documentation for the new API is spotless ✨

Thanks!

nidup commented 7 years ago

Hi @pardahlman !

Thank you for your feedback! We just open sourced the repository of the api doc https://github.com/akeneo/pim-api-docs

Feel free to contribute by opening a PR on this repo! :tada:

pardahlman commented 7 years ago

Hello again @nidup - thanks for pointing me in the right direction! I'll see if I find the time in the coming days to help out!

ahocquard commented 7 years ago

Fixed in this PR : https://github.com/akeneo/pim-api-docs/pull/48

Thanks for the report :)