Skip to content

Commit

Permalink
Merge pull request #54 from DINA-Web/cgendreau-soft-delete
Browse files Browse the repository at this point in the history
Review API-Guidelines: Soft-delete
  • Loading branch information
cgendreau authored May 12, 2020
2 parents 52d2c9c + 343c3b5 commit e430ecf
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions DINA-Web-API-Guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -478,6 +478,13 @@ parameters, i.e.

**[under-discussion]** Is this a MUST?

### Delete

In order to reduce inter-module reference issues while maintaining the system simplicity, resources **SHOULD** be deleted in a "soft-delete" manner.

It implies that resources should not be completely deleted and still be resolvable after deletion. Such resources **SHOULD** return a `410 Gone` instead of a `404 Not Found`, with a body indicating how to access the deleted entity (e.g. sample/cf71a71e-2176-4d6f-9f17-a4c4f3dd104e?deleted=true). Deleted resources should not appear in a list operation.

Hard-delete **MUST** be available for administrator to completely remove a resource if required (e.g. sensitive information).

### Supported languages

Expand Down

0 comments on commit e430ecf

Please sign in to comment.