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

[REQ][feature] 更新系APIで最終更新日を自動で取得するヘルパー

Open
#150 0 comments 1 reaction 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

Is your feature request related to a problem? Please describe.

AnnoFab の更新系APIは、リソースの「更新前の最終更新日」を必要としています。
https://annofab.com/docs/api/#section/API-Convention/API

API で何か更新するスクリプトを書くときに、毎回 GET して最終更新日を書くのは手間です。
また、もし GET してリソースがまだ作成されていないときには 404 エラーが発生するので、新規作成と更新を両方区別して実装する手間があります。

Describe the solution you'd like

先に書いたようなGET系APIと更新系APIを組み合わせることで、「APIユーザーが最終更新日を意識せずに使える」ような高レベルのAPIがあると、APIを使ったスクリプトが作りやすくなると思います。

更新系のAPIは多数ありますが、データ移行やシステム連携などでよく使いそうな以下 API だけでも高レベルAPIがあると、使いやすくなりそうです。

  • putAnnotation
  • putInputData
  • putTask

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 reviewing the client-library entry points for putAnnotation, putInputData, and putTask, along with their corresponding GET APIs and the Annofab API convention. Define how each helper handles an existing resource, a missing resource, and the last-updated date; done means the selected update workflows no longer require callers to fetch or provide that date manually.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.