Skip to content

feat: updated existing APIs to enable to generate OpenAPI documentation - #157

Open
Jagrutiti wants to merge 30 commits into
openfoodfacts:mainfrom
Jagrutiti:change-to-enable-openapi-doc
Open

feat: updated existing APIs to enable to generate OpenAPI documentation #157
Jagrutiti wants to merge 30 commits into
openfoodfacts:mainfrom
Jagrutiti:change-to-enable-openapi-doc

Conversation

@Jagrutiti

@Jagrutiti Jagrutiti commented Dec 25, 2022 •
edited by teolemon
Loading

Copy link
Copy Markdown
Member

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
Jagrutiti requested a review from a team as a code owner December 25, 2022 13:02
aadarsh-ram
aadarsh-ram requested changes Dec 25, 2022
View reviewed changes

@aadarsh-ram aadarsh-ram left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Jagrutiti! There are some changes that I have requested, which can be easily rectified. Thanks for the contribution!

Comment thread backend/editor/api.py Outdated
Comment thread backend/editor/api.py Outdated
Comment thread backend/editor/api.py Outdated
Comment thread backend/editor/api.py Outdated
Comment thread backend/editor/api.py Outdated
Comment thread backend/editor/api.py Outdated
Comment thread backend/editor/api.py Outdated
Comment thread backend/editor/api.py Outdated
Comment thread backend/editor/api.py Outdated
Comment thread backend/editor/api.py Outdated
Jagrutiti and others added 7 commits December 26, 2022 20:24
@Jagrutiti @aadarsh-ram
Update backend/editor/api.py
7efdf13 
Co-authored-by: Aadarsh A <aadarsh.ram@gmail.com>
@Jagrutiti @aadarsh-ram
Update backend/editor/api.py
41ab8fe 
Co-authored-by: Aadarsh A <aadarsh.ram@gmail.com>
@Jagrutiti @aadarsh-ram
Update backend/editor/api.py
2b40472 
Co-authored-by: Aadarsh A <aadarsh.ram@gmail.com>
@Jagrutiti @aadarsh-ram
Update backend/editor/api.py
29099f2 
Co-authored-by: Aadarsh A <aadarsh.ram@gmail.com>
@Jagrutiti @aadarsh-ram
Update backend/editor/api.py
8f5a1ee 
Co-authored-by: Aadarsh A <aadarsh.ram@gmail.com>
@Jagrutiti @aadarsh-ram
Update backend/editor/api.py
7870910 
Co-authored-by: Aadarsh A <aadarsh.ram@gmail.com>
@Jagrutiti
fix: updated model names, and divided them into another file
a4d5071
@teolemon teolemon added 📚 documentation Improvements or additions to documentation OpenAPI labels Dec 27, 2022
alexgarel
alexgarel reviewed Jan 2, 2023
View reviewed changes
Comment thread backend/editor/models.py Outdated
alexgarel
alexgarel requested changes Jan 2, 2023
View reviewed changes

@alexgarel alexgarel left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR :-)

Some comments, I think we should improve a bit before merging.

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

Comment thread backend/editor/models.py Outdated
Comment thread backend/editor/models.py Outdated
@alexgarel

alexgarel commented Jan 3, 2023

Copy link
Copy Markdown
Member

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
alexgarel reviewed Jan 16, 2023
View reviewed changes
Comment thread backend/editor/models.py Outdated
Jagrutiti
Jagrutiti commented Feb 5, 2023
View reviewed changes
Comment thread backend/editor/models.py
alexgarel
alexgarel reviewed Feb 7, 2023
View reviewed changes
Comment thread backend/editor/api.py Outdated
Comment thread backend/editor/models.py Outdated
Comment thread backend/editor/models.py
Jagrutiti and others added 2 commits February 7, 2023 21:35
@Jagrutiti @alexgarel
Update backend/editor/models.py
e57c836 
Co-authored-by: Alex Garel <alex@garel.org>
@Jagrutiti
updated syntax
eb2b3b0
Jagrutiti
Jagrutiti commented Feb 7, 2023
View reviewed changes
Comment thread backend/editor/api.py
Jagrutiti
Jagrutiti commented Feb 12, 2023
View reviewed changes
Comment thread backend/editor/models.py
alexgarel
alexgarel approved these changes Feb 14, 2023
View reviewed changes

@alexgarel alexgarel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Jagrutiti ok, thanks, that's a good first step.

I think we have to go further to describe the API more deeply (on the response side). Did you test everything is still working after your changes ?

Comment thread backend/editor/models.py Outdated
@Jagrutiti

Jagrutiti commented Feb 14, 2023

Copy link
Copy Markdown
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alexgarel alexgarel alexgarel approved these changes
@aadarsh-ram aadarsh-ram Awaiting requested review from aadarsh-ram

Requested changes must be addressed to merge this pull request.

Assignees

@Jagrutiti Jagrutiti

Labels

📚 documentation Improvements or additions to documentation OpenAPI

Projects

📚 Document Open Food Facts
Status: Todo
🧬✎ Taxonomy Editor (General)
Status: Undecided
Taxonomy-editor - CentraleSupelec 2023
Status: Backlog

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@Jagrutiti @alexgarel @aadarsh-ram @teolemon