Skip to content

fix(vault): route the two ways out of a pending transfer #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LKSNDRTMLKV wants to merge 1 commit into
base: refactor/repoint-core-layout
Choose a base branch
from
Open

fix(vault): route the two ways out of a pending transfer #194

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 112 additions & 0 deletions api/openapi.bundled.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -810,6 +810,118 @@
}
}
},
"/vault/api/v1/dpp/{dppId}/transfer/reject": {
"post": {
"operationId": "rejectDppTransfer",
"summary": "Reject a pending transfer of responsibility",
"description": "The incoming operator refuses the pending handover. The record becomes\nterminal and can never complete, and the passport's transfer chain is\nfree to carry a new handover.\n\nPaired with cancel, this is one of the two ways out of a handover the\ncounterparty never acted on. A chain refuses a new transfer while any\nrecord is still pending, so without these routes a passport whose\ncounterparty went silent could never be transferred again.\n",
"tags": [
"DPP Lifecycle"
],
"security": [
{
"BearerApiKey": []
},
{
"BasicAuth": []
}
],
"parameters": [
{
"name": "dppId",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/DppId"
}
}
],
"responses": {
"200": {
"description": "Transfer rejected.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransferRecord"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"description": "No pending transfer to reject for this DPP.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationError"
}
}
}
},
"/vault/api/v1/dpp/{dppId}/transfer/cancel": {
"post": {
"operationId": "cancelDppTransfer",
"summary": "Cancel a pending transfer of responsibility",
"description": "The outgoing operator withdraws the pending handover before it\ncompletes. The record becomes terminal and the passport's transfer chain\nis free to carry a new handover.\n\nValid from one state more than reject: a handover may be cancelled after\nthe acceptance step has run but before the record is completed.\n",
"tags": [
"DPP Lifecycle"
],
"security": [
{
"BearerApiKey": []
},
{
"BasicAuth": []
}
],
"parameters": [
{
"name": "dppId",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/DppId"
}
}
],
"responses": {
"200": {
"description": "Transfer cancelled.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransferRecord"
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"404": {
"description": "No pending transfer to cancel for this DPP.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
}
},
"422": {
"$ref": "#/components/responses/ValidationError"
}
}
}
},
"/vault/api/v1/dpp/{dppId}/history": {
"get": {
"operationId": "getDppHistory",
Expand Down
80 changes: 80 additions & 0 deletions api/openapi.bundled.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -589,6 +589,86 @@ paths:
$ref: '#/components/schemas/Problem'
'422':
$ref: '#/components/responses/ValidationError'
/vault/api/v1/dpp/{dppId}/transfer/reject:
post:
operationId: rejectDppTransfer
summary: Reject a pending transfer of responsibility
description: |
The incoming operator refuses the pending handover. The record becomes
terminal and can never complete, and the passport's transfer chain is
free to carry a new handover.

Paired with cancel, this is one of the two ways out of a handover the
counterparty never acted on. A chain refuses a new transfer while any
record is still pending, so without these routes a passport whose
counterparty went silent could never be transferred again.
tags:
- DPP Lifecycle
security:
- BearerApiKey: []
- BasicAuth: []
parameters:
- name: dppId
in: path
required: true
schema:
$ref: '#/components/schemas/DppId'
responses:
'200':
description: Transfer rejected.
content:
application/json:
schema:
$ref: '#/components/schemas/TransferRecord'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: No pending transfer to reject for this DPP.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'422':
$ref: '#/components/responses/ValidationError'
/vault/api/v1/dpp/{dppId}/transfer/cancel:
post:
operationId: cancelDppTransfer
summary: Cancel a pending transfer of responsibility
description: |
The outgoing operator withdraws the pending handover before it
completes. The record becomes terminal and the passport's transfer chain
is free to carry a new handover.

Valid from one state more than reject: a handover may be cancelled after
the acceptance step has run but before the record is completed.
tags:
- DPP Lifecycle
security:
- BearerApiKey: []
- BasicAuth: []
parameters:
- name: dppId
in: path
required: true
schema:
$ref: '#/components/schemas/DppId'
responses:
'200':
description: Transfer cancelled.
content:
application/json:
schema:
$ref: '#/components/schemas/TransferRecord'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
description: No pending transfer to cancel for this DPP.
content:
application/problem+json:
schema:
$ref: '#/components/schemas/Problem'
'422':
$ref: '#/components/responses/ValidationError'
/vault/api/v1/dpp/{dppId}/history:
get:
operationId: getDppHistory
Expand Down
4 changes: 4 additions & 0 deletions api/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,10 @@ paths:
$ref: paths/vault_api_v1_dpp_{dppId}_transfer_initiate.yaml
/vault/api/v1/dpp/{dppId}/transfer/accept:
$ref: paths/vault_api_v1_dpp_{dppId}_transfer_accept.yaml
/vault/api/v1/dpp/{dppId}/transfer/reject:
$ref: paths/vault_api_v1_dpp_{dppId}_transfer_reject.yaml
/vault/api/v1/dpp/{dppId}/transfer/cancel:
$ref: paths/vault_api_v1_dpp_{dppId}_transfer_cancel.yaml
/vault/api/v1/dpp/{dppId}/history:
$ref: paths/vault_api_v1_dpp_{dppId}_history.yaml
/vault/api/v1/dpp/{dppId}/stats:
Expand Down
38 changes: 38 additions & 0 deletions api/paths/vault_api_v1_dpp_{dppId}_transfer_cancel.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
post:
operationId: cancelDppTransfer
summary: Cancel a pending transfer of responsibility
description: |
The outgoing operator withdraws the pending handover before it
completes. The record becomes terminal and the passport's transfer chain
is free to carry a new handover.

Valid from one state more than reject: a handover may be cancelled after
the acceptance step has run but before the record is completed.
tags:
- DPP Lifecycle
security:
- BearerApiKey: []
- BasicAuth: []
parameters:
- name: dppId
in: path
required: true
schema:
$ref: ../components/schemas/DppId.yaml
responses:
'200':
description: Transfer cancelled.
content:
application/json:
schema:
$ref: ../components/schemas/TransferRecord.yaml
'401':
$ref: ../components/responses/Unauthorized.yaml
'404':
description: No pending transfer to cancel for this DPP.
content:
application/problem+json:
schema:
$ref: ../components/schemas/Problem.yaml
'422':
$ref: ../components/responses/ValidationError.yaml
40 changes: 40 additions & 0 deletions api/paths/vault_api_v1_dpp_{dppId}_transfer_reject.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
post:
operationId: rejectDppTransfer
summary: Reject a pending transfer of responsibility
description: |
The incoming operator refuses the pending handover. The record becomes
terminal and can never complete, and the passport's transfer chain is
free to carry a new handover.

Paired with cancel, this is one of the two ways out of a handover the
counterparty never acted on. A chain refuses a new transfer while any
record is still pending, so without these routes a passport whose
counterparty went silent could never be transferred again.
tags:
- DPP Lifecycle
security:
- BearerApiKey: []
- BasicAuth: []
parameters:
- name: dppId
in: path
required: true
schema:
$ref: ../components/schemas/DppId.yaml
responses:
'200':
description: Transfer rejected.
content:
application/json:
schema:
$ref: ../components/schemas/TransferRecord.yaml
'401':
$ref: ../components/responses/Unauthorized.yaml
'404':
description: No pending transfer to reject for this DPP.
content:
application/problem+json:
schema:
$ref: ../components/schemas/Problem.yaml
'422':
$ref: ../components/responses/ValidationError.yaml
Loading
Loading