MerginMaps / MerginMaps/python-api-client

CLI: Use the new DELETE project endpoint

オープン
#195 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
Python
スター
23
フォーク
12
平均マージ
2日 13時間
マージ済み PR(30日)
7

説明

See the description for https://app.clickup.com/t/861nayppe and https://app.clickup.com/t/861nayqwz and mimic the same in the py-client/plugin.

The existing remove CLI function:

  • should use the POST v2/project/{id}/scheduleDelete by default and returns when the project will be deleted
  • should have a new flag -f, --force-delete to remove the project immediately by calling DELETE /project/{id}

Also, add a help text to that CLI function explaining that normal remove will schedule the project for deletion and the force will remove it forever immediately.

In autotests, use the new version (immediate delete) when doing cleanup.

Comments
Martin D: immediate removal of projects added to python API: https://github.com/MerginMaps/mergin-py-client/pull/177
Martin D: For the time being, clients still use the "old" v1 delete endpoint - we should switch to the v2 delete endpoint only after some time when also CE/EE servers are likely to be migrated already...

Migrated from: https://app.clickup.com/t/861nayu2h

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

py-client/plugin にある既存の remove CLI 関数と、プロジェクトをクリーンアップする autotests から始めます。現在の削除リクエストを v2 scheduleDelete および即時 DELETE エンドポイントと比較し、そのうえでヘルプテキスト、force-delete オプション、返されるスケジュール情報、関連するテストによるクリーンアップ動作を確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
api, cli, testing
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。