Skip to content

Commit

Permalink
fix(KD-12166): remove cancelled and denied statuses (#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
suejungshin authored Jun 18, 2024
1 parent a4d1d98 commit 73273f2
Show file tree
Hide file tree
Showing 8 changed files with 7 additions and 26 deletions.
2 changes: 1 addition & 1 deletion api/dsr/v1/Access.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ specified in the request.
The `results` and `documents` are merged with any cached results from previous events. New documents are
added and existing documents are updated.

Once the status is set to `completed`, `cancelled` or `denied`, then no further events will be accepted.
Once the status is set to `completed`, then no further events will be accepted.

The `Content-Type` MUST be `application/json`.

Expand Down
2 changes: 1 addition & 1 deletion api/dsr/v1/Correction.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ The `results` and `documents` are merged with any cached results from previous e
added and existing documents are updated.

When the status of Correction Request has changed, a `CorrectionStatusEvent` JSON object should be sent to all the
callbacks specified in the request. Once the status is set to `completed`, `cancelled` or `denied`, then no further
callbacks specified in the request. Once the status is set to `completed`, then no further
events will be accepted.

The `Content-Type` MUST be `application/json`.
Expand Down
2 changes: 1 addition & 1 deletion api/dsr/v1/Delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ added and existing documents are updated.
When the status of Delete Request has changed, a `DeleteStatusEvent` event should be sent to all the callbacks specified
in the request.

Once the status is set to `completed`, `cancelled` or `denied`, then no further events will be accepted.
Once the status is set to `completed`, then no further events will be accepted.

The `Content-Type` MUST be `application/json`.

Expand Down
2 changes: 1 addition & 1 deletion api/dsr/v1/RestrictProcessing.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ be sent to all the callbacks specified in the request.
The `results` and `documents` are merged with any cached results from previous events. New documents are
added and existing documents are updated.

Once the status is set to `completed`, `cancelled` or `denied`, then no further events will be accepted.
Once the status is set to `completed`, then no further events will be accepted.

The `Content-Type` MUST be `application/json`.

Expand Down
19 changes: 3 additions & 16 deletions api/dsr/v1/Status.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

The `status` of a Request progresses through the following state/activity diagram:

![](https://lucid.app/publicSegments/view/61b83862-bbc8-41b1-bdae-d92b7bf87af6/image.png)
![](https://lucid.app/publicSegments/view/6ee0ee1c-cf45-49fd-9a09-eabf6eba8b5e/image.png)

Note that multiple Status events can be received with each status. For example, a callback may be called daily with
a status of `in_progress` until finally the final status is sent with status of `completed`.

If a `Response` does not include return a status of `completed`, `cancelled` or `denied`, then a subsequent `StatusEvent`
If a `Response` does not include return a status of `completed`, then a subsequent `StatusEvent`
event MUST be sent to the callbacks with one of those statuses. Otherwise, the request will be marked as failed after
some time.

Expand All @@ -18,9 +18,7 @@ some time.
| *unknown* | the status is unknown |
| *pending* | the request is pending approval |
| *in_progress* | the request is in progress |
| *completed* | the request has been completed |
| *cancelled* | the request has been cancelled |
| *denied* | the request has been denied |
| *completed* | the request has been completed |

The status code is case sensitve.

Expand All @@ -36,14 +34,3 @@ The status code is case sensitve.
| completed | *insufficient_identification* | the [Data Subject](README.md#Subject) was not sufficiently identified |
| completed | *executed* | the request has been executed |
| completed | *executed_direct_subject_delivery* | the request completed and data will be delivered directly to [Data Subject](README.md#Subject) email or app portal |
| denied | *no_match* | there is no match for the [Data Subject](README.md#Subject) |
| denied | *insufficient_identification* | the [Data Subject](README.md#Subject) was not sufficiently identified |
| denied | *insufficient_verification* | the [Data Subject](README.md#Subject) has insufficiently completed identity verification |
| denied | *claim_not_covered* | the claim is not covered |
| denied | *outside_jurisdiction* | the [Data Subject](README.md#Subject) is outside the covered jurisdiction |
| denied | *too_many_requests* | the [Data Subject](README.md#Subject) has made too many requests |
| denied | *suspected_fraud* | the request is suspected fraud |
| denied | *invalid_credentials* | the request failed due to invalid credentials |
| denied | *insufficient_permission* | the request failed due to insufficient permission |
| denied | *internal_app_error* | the request failed due to an internal app error |
| denied | *sla_expiry* | the request failed due to SLA expiry |
2 changes: 0 additions & 2 deletions openapi/components/schemas/DSRRequestStatus.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,3 @@ enum:
- pending
- in_progress
- completed
- cancelled
- denied
2 changes: 0 additions & 2 deletions openapi/forwarder_gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -563,8 +563,6 @@ components:
- pending
- in_progress
- completed
- cancelled
- denied
SubscriptionTopicContactMethodStatus:
type: object
additionalProperties:
Expand Down
2 changes: 0 additions & 2 deletions openapi/index_gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -563,8 +563,6 @@ components:
- pending
- in_progress
- completed
- cancelled
- denied
SubscriptionTopicContactMethodStatus:
type: object
additionalProperties:
Expand Down

0 comments on commit 73273f2

Please sign in to comment.