taxonomy-editor icon indicating copy to clipboard operation
taxonomy-editor copied to clipboard

Published 20 hours ago • verified publisher icon openfoodfacts

feat: updated existing APIs to enable to generate OpenAPI documentation

Open Jagrutiti opened this issue 2 years ago • 2 comments

What

  • Added BaseModel and Body Parameters to the documentation, by updating existing APIs to enable to generate OpenAPI documentation

Closes

Change API to enable auto OpenAPI documentation #77

Jagrutiti avatar Dec 25 '22 13:12 Jagrutiti

BTW what is this taxonomy-editor-frontend/build directory you added ?

Sorry I misread this, it was removed, but it makes your tests fail… you should not remove the build/.empty file, it is important indeed !

alexgarel avatar Jan 03 '23 09:01 alexgarel

I think we have to go further to describe the API more deeply (on the response side).

Do you mean adding response description as give in this documentation: https://fastapi.tiangolo.com/advanced/additional-responses/#additional-response-with-model?

Did you test everything is still working after your changes ?

All the tests cases did pass. And the APIs are working fine.

Jagrutiti avatar Feb 14 '23 16:02 Jagrutiti