MerginMaps / MerginMaps/python-api-client

CLI: Use the new DELETE project endpoint

Offen
#195 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Python
Sterne
23
Forks
12
Ø Merge
2 T. 13 Std.
Gemergte PRs (30 T.)
7

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der vorhandenen remove CLI-Funktion in py-client/plugin und den autotests, die Projekte bereinigen. Vergleiche ihre aktuelle Löschanfrage mit den v2 scheduleDelete- und sofortigen DELETE-Endpunkten und überprüfe anschließend den Hilfetext, die force-delete-Option, die zurückgegebenen Planungsinformationen und das Bereinigungsverhalten anhand der relevanten Tests.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
api, cli, testing
Issue-Typ
Feature
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.