manosim / manosim/django-rest-framework-docs

Showing request body, just like response body

Open
#128 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
641
Forks
178
PR merge metrics
No merged PRs in 30d

Description

Hi guys, great work on the docs so far. I have try it on a toy project and is fantastic.

However one of the feature i am looking for is actually to show the request body just like a response body when the request is send. Do you think this is a reasonable feature ?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how this Django REST Framework documentation project currently presents response bodies and identify the corresponding place where request bodies would be represented. Define the expected request-body display and verify it against the existing API documentation behavior; the issue does not name specific files or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
django, python
Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.