Pylons / Pylons/pyramid_openapi3

Provide an enhanced JSON renderer

Open
#23 16 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
Python
Stars
84
Forks
46
Avg merge
5d 20h
Merged PRs (30d)
3

Description

I like the pyramid_swagger renderer from pyramid_swagger library.

With it, I can remove custom renderers from the realworld example app. And less code is always nice.

We can probably reuse the idea, or possibly even some code.

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 reading the pyramid_swagger renderer documentation linked in the issue and the custom renderer in the realworld example app's src/conduit/openapi.py. Compare the existing custom behavior with the proposed enhanced JSON renderer and determine what can be reused. Done means the addon provides a renderer that lets the example app remove its custom renderers.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.