Geoplateforme / sdk-entrepot

SDK Python pour utiliser l'API Entrepôt de la Géoplateforme.
GNU General Public License v3.0
1 stars 0 forks source link

Pouvoir mettre à jour les entitées depuis le workflow #66

Closed LudivineSchlegel closed 6 months ago

LudivineSchlegel commented 7 months ago

EDIT : Pour des soucis de nommage on passe de "update-entity" à "edit-entity". En référence à api_full_edit et api_partial_edit (modification de l'entité sur la géoplatforme) et à ne pas confondre avec api_update (mise à jour de l'entité locale en python)


Il est utile de pouvoir mettre à jour dans un workflow une entité. Pour l'instant limitation aux upload, stored_data, configuration et offering.

Requête API

Correspond au requête PUT et PATCH de l'api géoplatforme

Action du workflow

structure :

{
    "type": "edit-entity",
    // Type de l'entité à modifier : (upload, stored_data, configuration, offering)
    "entity_type": "configuration",
    // Id de l'entité à modifier
    "entity_id": "{uuid}",
    // Optionnel si non présent requête n'ai pas lancée ( => mise à jour des tags et commentaires uniquement)
    // si l'entité hérite de FullEditInterface (mise à jour totale) => fusion des informations récupérées sur l'API (GET) et de celle fournies,
    // sinon on envoie que celles fournies
    "body_parameters": { ... },
    // Optionnel : Liste des tags ajoutés à l'entité (uniquement si la classe hérite de TagInterface)
    "tags": {},
    // Optionnel : Liste des commentaires à ajouter (uniquement si la classe hérite de CommentInterface)
    "comments": [],
}