Skip to content
ADP
API Design PrincipleBETA

[ADP-150] Soft Deletion

  • In certain situations, it should be considered to implement a soft deletion mechanism at the API layer, allowing users to obtain information about deleted resources and providing the option to restore deletions.
  • Resources that have been soft-deleted should not appear in related collection lists, unless a special API is designed to display these resources. For example: /deleted-resources.
  • A mechanism should be designed to delete resources that have been marked as soft-deleted after a certain period of time.
  • It may be considered to implement an API for restoring deletions, allowing users to restore resources that have been deleted.
    • DRAFT Deletion operations should (SHOULD) uniformly use the DELETE method, while there is no general standard for restore operations. For the sake of consistency and readability, it is recommended to use the POST /deleted-resources/${id}/recover method for restore operations.

Reference