Skip to content

Commit

Permalink
feat(wip): connections ready
Browse files Browse the repository at this point in the history
  • Loading branch information
@outSH
outSH committed Dec 6, 2023
1 parent 9202c1c commit 320d80f
Show file tree
Hide file tree
Showing 8 changed files with 1,202 additions and 129 deletions.
274 changes: 272 additions & 2 deletions packages/cactus-plugin-ledger-connector-aries/src/main/json/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,81 @@
}
}
},

"AgentConnectionRecordV1": {
"type": "object",
"description": "Aries agent connection information.",
"additionalProperties": true,
"required": ["state", "role", "isReady"],
"properties": {
"state": {
"type": "string",
"nullable": false
},
"role": {
"type": "string",
"nullable": false
},
"isReady": {
"type": "boolean",
"nullable": false
},
"did": {
"type": "string",
"nullable": false
},
"theirDid": {
"type": "string",
"nullable": false
},
"theirLabel": {
"type": "string",
"nullable": false
},
"alias": {
"type": "string",
"nullable": false
},
"threadId": {
"type": "string",
"nullable": false
},
"errorMessage": {
"type": "string",
"nullable": false
},
"outOfBandId": {
"type": "string",
"nullable": false
},
"invitationDid": {
"type": "string",
"nullable": false
}
}
},
"GetConnectionsV1Request": {
"type": "object",
"description": "Request for GetConnections endpoint.",
"required": ["agentName"],
"properties": {
"agentName": {
"type": "string",
"nullable": false
},
"filter": {
"$ref": "#/components/schemas/AgentConnectionsFilterV1",
"nullable": false
}
}
},
"GetConnectionsV1Response": {
"type": "array",
"description": "Response for GetConnections endpoint.",
"default": [],
"items": {
"$ref": "#/components/schemas/AgentConnectionRecordV1"
}
},
"GetAgentsV1Response": {
"type": "array",
"description": "Response for GetAgents endpoint.",
Expand All @@ -227,6 +301,69 @@
"$ref": "#/components/schemas/AriesAgentSummaryV1"
}
},
"CreateNewConnectionInvitationV1Request": {
"type": "object",
"description": "Request for CreateNewConnectionInvitation endpoint.",
"required": ["agentName"],
"properties": {
"agentName": {
"type": "string",
"description": "Aries label of an agent to use to generate an invitation",
"nullable": false
},
"invitationDomain": {
"type": "string",
"description": "Invitation URL domain to use. If not specified, then connector default domain will be used",
"nullable": false
}
}
},
"CreateNewConnectionInvitationV1Response": {
"type": "object",
"description": "Response for CreateNewConnectionInvitation endpoint.",
"required": ["invitationUrl", "outOfBandRecordId"],
"properties": {
"invitationUrl": {
"type": "string",
"description": "Invitation URL that can be used by another aries agent to connect to us.",
"nullable": false
},
"outOfBandRecordId": {
"type": "string",
"description": "ID that can be used to track status of the connection",
"nullable": false
}
}
},
"AcceptInvitationV1Request": {
"type": "object",
"description": "Request for AcceptInvitation endpoint.",
"required": ["agentName", "invitationUrl"],
"properties": {
"agentName": {
"type": "string",
"description": "Aries label of an agent to be used to connect using URL",
"nullable": false
},
"invitationUrl": {
"type": "string",
"description": "Invitation URL generated by another aries agent.",
"nullable": false
}
}
},
"AcceptInvitationV1Response": {
"type": "object",
"description": "Response for AcceptInvitation endpoint.",
"required": ["outOfBandRecordId"],
"properties": {
"outOfBandRecordId": {
"type": "string",
"description": "ID that can be used to track status of the connection",
"nullable": false
}
}
},
"ErrorExceptionV1Response": {
"type": "object",
"description": "Error response from the connector.",
Expand Down Expand Up @@ -255,7 +392,7 @@
"path": "/api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-aries/get-agents"
}
},
"operationId": "getAgents",
"operationId": "getAgentsV1",
"summary": "Get all Aries agents configured in this connector plugin.",
"parameters": [],
"responses": {
Expand All @@ -281,6 +418,139 @@
}
}
}
},
"/api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-aries/get-connections": {
"post": {
"x-hyperledger-cacti": {
"http": {
"verbLowerCase": "post",
"path": "/api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-aries/get-connections"
}
},
"operationId": "getConnectionsV1",
"summary": "Get all connections of given aries agent.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetConnectionsV1Request"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetConnectionsV1Response"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorExceptionV1Response"
}
}
}
}
}
}
},

"/api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-aries/create-new-connection-invitation": {
"post": {
"x-hyperledger-cacti": {
"http": {
"verbLowerCase": "post",
"path": "/api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-aries/create-new-connection-invitation"
}
},
"operationId": "createNewConnectionInvitationV1",
"summary": "Create new aries agent invitation that other agents can use to connect.",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateNewConnectionInvitationV1Request"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateNewConnectionInvitationV1Response"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorExceptionV1Response"
}
}
}
}
}
}
},
"/api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-aries/accept-invitation": {
"post": {
"x-hyperledger-cacti": {
"http": {
"verbLowerCase": "post",
"path": "/api/v1/plugins/@hyperledger/cactus-plugin-ledger-connector-aries/accept-invitation"
}
},
"operationId": "acceptInvitationV1",
"summary": "Connect to another agent using it's invitation URL",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcceptInvitationV1Request"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcceptInvitationV1Response"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorExceptionV1Response"
}
}
}
}
}
}
}
}
}
Loading

0 comments on commit 320d80f

Please sign in to comment.