marshmallow-code / marshmallow-code/apispec

Docs via Python code

Open
#722 8 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
Python
Stars
1.2k
Forks
202
Avg merge
3h 38m
Merged PRs (30d)
3

Description

The aiohttp-apispec tool uses a wrapper to create the presentation documentation.

@docs(
    summary="Test method summary",
    description="Test method description",
    responses={
        200: {
            "schema": ResponseSchema,
            "description": "Success response",
        },
    },
)
async def index(request):
    return web.json_response({"msg": "done", "data": {}})

Is there any reason why you didn't do the same?
Seems to me it's simpler and gives less errors.

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 comparing the current presentation-documentation wrapper with the aiohttp-apispec @docs example quoted in the issue. Determine whether adopting that style is a defined, testable change; done should be an agreed scope with the relevant documentation or implementation work identified.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, 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.