marshmallow-code / marshmallow-code/apispec-webframeworks
Separate path_helper and operation_helper logic in web framework plugins
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 33
- Forks
- 24
- Avg merge
- 5h 38m
- Merged PRs (30d)
- 4
Description
_Monday Jul 30, 2018 at 00:44 GMT_
_Originally opened as https://github.com/marshmallow-code/apispec/issues/257_
----
From #246:
> Also the web framework path helpers deal with operations quite a lot, and perhaps this logic should be split into path_helper and operation_helper. From a quick glance, the coupling between the two seems loose. Could be a bit trickier with flask due to the if method in rule.methods test, which covers what looks like a twisted but legit case (method declared in the view but not in the rule).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the web framework plugin helper implementations and the related discussion in #246, focusing on the Flask handling of rule.methods. Separate path_helper and operation_helper responsibilities while preserving the existing method-detection behavior; done means the helpers have loose responsibilities and plugin behavior remains correct.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- flask, python
- Domain
- api, backend
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100