kurusugawa-computer / kurusugawa-computer/annofab-api-python-client

[REQ][feature] `generated_api.py`で定義されている関数の`queyr_params`や`request_body`引数などは、`kw_only`にする

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

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
11
Forks
1
PR merge metrics
No merged PRs in 30d

Description

背景

https://kurusugawajp.slack.com/archives/CDKUX0M8E/p1752051185252579?thread_ts=1751960766.126749&cid=CDKUX0M8E

もともとのコードでは、put_annotation関数に位置引数でrequest_bodyを渡していた。
annofabapiをバージョンアップしたら、put_annotationquery_params引数が、reuqest_body引数の前に追加された。
したがって、今までのコードだと、request_bodyに渡していた内容がquery_paramsに渡されてしまい、期待していないエラーが発生した。

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 in generated_api.py and inventory the functions exposing query_params or request_body, using the reported positional-argument failure as the motivating case. Make the affected arguments keyword-only and confirm that the generated client no longer accepts them positionally.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.