StackStorm-Exchange / StackStorm-Exchange/stackstorm-netbox

Patch actions have too many required parameters

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

Nobody has claimed this yet.

Dominant language
Python
Stars
14
Forks
19
Avg merge
1d 2h
Merged PRs (30d)
1

Description

Due to an issue with the generation of Swagger documentation (https://github.com/axnsan12/drf-yasg/issues/70) PATCH actions have too many required parameters. Generally only id and the changed parameter are required.

When the actions are auto generated these required parameters are read and hence the auto generated actions have too many required parameters.

Contributor guide

No contributing guide indexed for this repository

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 tracing how Swagger documentation produces required parameters for PATCH actions and how those parameters are consumed when actions are auto generated. Confirm the expected behavior: only the id and changed parameter should be required. The issue names no files or tests, so locating the generation and action-registration entry points is the first task.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.