Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

api documentation #267

Open
marojenka opened this issue Oct 14, 2019 · 1 comment
Open

api documentation #267

marojenka opened this issue Oct 14, 2019 · 1 comment

Comments

@marojenka
Copy link

  • longclaw version: 1.0.2
  • Django version: 2.2

Description

Hi. I was trying to use drf-yasg to explore api and found it sometimes confusing.
Namely in basket viewset in some methods (create would be easiest example) expected post data is different from class defined serializer hence autodocumentation gives wrong mock request.

Suggestion

  • rewrite api with aim to strictly use same serializer per viewset. For basket it would mean to always list of variation_id, withoud productvariation inline serializer.
  • add dedicated annotation with request data for each method. May be with connection to some third party autodocumentation app.

I'm addicted to swagged documentation and willing to apply PR if you are interested in any of such solution. Sorry if I'm missing something.

@JamesRamm
Copy link
Collaborator

Hi
thanks for the interest in the project.
A PR is always welcome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants