Skip to content
Snippets Groups Projects
Commit 87e3d851 authored by Alexey Lunin's avatar Alexey Lunin
Browse files

Update swagger-json

parent 9b7e0496
No related branches found
No related tags found
No related merge requests found
...@@ -467,7 +467,7 @@ export default class PresentationProofsController { ...@@ -467,7 +467,7 @@ export default class PresentationProofsController {
@Post('send-presentation-request') @Post('send-presentation-request')
@ApiOperation({ @ApiOperation({
summary: 'Send presentation request', summary: 'Send presentation request',
description: 'This call provides the capability to create a new presentation request bound to existing connection. You need to provide in the body information about connection, schema for every requested attribute and attribute name. The call returns an information about proof request (proofRecordId, connectionId, credentialDefId, schemaId, theirDid, status, createdDate, updatedDate, threadId)' description: 'This call provides the capability to create a new presentation request bound to existing connection. It is mandatory to provide a schema for every requested attribute and attribute name in the body information of the connection. The call returns an information about proof request (proofRecordId, connectionId, credentialDefId, schemaId, theirDid, status, createdDate, updatedDate, threadId)'
}) })
@ApiResponse({ @ApiResponse({
status: HttpStatus.CREATED, status: HttpStatus.CREATED,
......
...@@ -4,7 +4,8 @@ ...@@ -4,7 +4,8 @@
"/v1/health": { "/v1/health": {
"get": { "get": {
"operationId": "HealthController_getHealth", "operationId": "HealthController_getHealth",
"summary": "This call provides the capability to check the service is working and up. The call returns 200 Status Code and current server time in json body", "summary": "Health check",
"description": "This call provides the capability to check the service is working and up. The call returns 200 Status Code and current server time in json body",
"parameters": [], "parameters": [],
"responses": { "responses": {
"200": { "200": {
...@@ -29,7 +30,8 @@ ...@@ -29,7 +30,8 @@
"/v1/find-proof-presentation": { "/v1/find-proof-presentation": {
"get": { "get": {
"operationId": "PresentationProofsController_findProofPresentation", "operationId": "PresentationProofsController_findProofPresentation",
"summary": "This call provides the capability to search proofs (Credential Presentation) by using pagination and filter parameters. This call returns a list of proof requests (Proof Presentations) and overall count of records. Filter supports following parameters: page, pageSize, proofRecordId, connectionId, credentialDefId, schemaId, theirDid, status, createdDateStart, createdDateEnd, updatedDateStart, updatedDateEnd", "summary": "Fetch list of proof requests",
"description": "This call provides the capability to search proofs (Credential Presentation) by using pagination and filter parameters. This call returns a list of proof requests (Proof Presentations) and overall count of records. Filter supports following parameters: page, pageSize, proofRecordId, connectionId, credentialDefId, schemaId, theirDid, status, createdDateStart, createdDateEnd, updatedDateStart, updatedDateEnd",
"parameters": [ "parameters": [
{ {
"name": "updatedDateEnd", "name": "updatedDateEnd",
...@@ -162,7 +164,8 @@ ...@@ -162,7 +164,8 @@
"/v1/find-by-presentation-id": { "/v1/find-by-presentation-id": {
"get": { "get": {
"operationId": "PresentationProofsController_findProofByProofRecordId", "operationId": "PresentationProofsController_findProofByProofRecordId",
"summary": "This call provides the capability to get proof request by providing proofRecordId (presentationId). The call returns an information about proof request and also (if user accepted proof request) information about requested user credentials", "summary": "Fetch proof presentation by proofRequestId",
"description": "This call provides the capability to get proof request by providing proofRecordId (presentationId). The call returns an information about proof request and also (if user accepted proof request) information about requested user credentials",
"parameters": [ "parameters": [
{ {
"name": "proofRecordId", "name": "proofRecordId",
...@@ -243,7 +246,8 @@ ...@@ -243,7 +246,8 @@
"/v1/send-presentation-request": { "/v1/send-presentation-request": {
"post": { "post": {
"operationId": "PresentationProofsController_sendPresentationRequest", "operationId": "PresentationProofsController_sendPresentationRequest",
"summary": "This call provides the capability to create a new presentation request bound to existing connection. You need to provide in the body information about connection, schema for every requested attribute and attribute name. The call returns an information about proof request (proofRecordId, connectionId, credentialDefId, schemaId, theirDid, status, createdDate, updatedDate, threadId)", "summary": "Send presentation request",
"description": "This call provides the capability to create a new presentation request bound to existing connection. It is mandatory to provide a schema for every requested attribute and attribute name in the body information of the connection. The call returns an information about proof request (proofRecordId, connectionId, credentialDefId, schemaId, theirDid, status, createdDate, updatedDate, threadId)",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
"required": true, "required": true,
...@@ -309,7 +313,8 @@ ...@@ -309,7 +313,8 @@
"/v1/send-out-of-band-presentation-request": { "/v1/send-out-of-band-presentation-request": {
"post": { "post": {
"operationId": "PresentationProofsController_sendOutOfBandPresentationRequest", "operationId": "PresentationProofsController_sendOutOfBandPresentationRequest",
"summary": "This call provides the capability to create a new presentation request not bound to any proposal or existing connection. The call returns an information about presentation request", "summary": "Send out of band presentation request",
"description": "This call provides the capability to create a new presentation request not bound to any proposal or existing connection. The call returns an information about presentation request",
"parameters": [], "parameters": [],
"requestBody": { "requestBody": {
"required": true, "required": true,
...@@ -376,7 +381,8 @@ ...@@ -376,7 +381,8 @@
"/v1/out-of-band-proof": { "/v1/out-of-band-proof": {
"post": { "post": {
"operationId": "PresentationProofsController_outOfBandProof", "operationId": "PresentationProofsController_outOfBandProof",
"summary": "This call provides the capability to create a new presentation request not bound to any proposal or existing connection but it creates just on type defined in attestation manager (type is bound to schema id there). The call returns an information about presentation request", "summary": "Send out of band proof",
"description": "This call provides the capability to create a new presentation request not bound to any proposal or existing connection but it creates just on type defined in attestation manager (type is bound to schema id there). The call returns an information about presentation request",
"parameters": [ "parameters": [
{ {
"name": "type", "name": "type",
...@@ -440,7 +446,8 @@ ...@@ -440,7 +446,8 @@
"/v1/accept-presentation/{proofRecordId}": { "/v1/accept-presentation/{proofRecordId}": {
"post": { "post": {
"operationId": "PresentationProofsController_acceptPresentation", "operationId": "PresentationProofsController_acceptPresentation",
"summary": "Accept a presentation as prover (by sending a presentation acknowledgement message) to the connection associated with the proof record.", "summary": "Accept presentation request by proofRecordId",
"description": "Accept a presentation as prover (by sending a presentation acknowledgement message) to the connection associated with the proof record.",
"parameters": [ "parameters": [
{ {
"name": "proofRecordId", "name": "proofRecordId",
...@@ -507,7 +514,8 @@ ...@@ -507,7 +514,8 @@
"/v1/accept-proof-request/{proofRecordId}": { "/v1/accept-proof-request/{proofRecordId}": {
"post": { "post": {
"operationId": "PresentationProofsController_acceptProofRequest", "operationId": "PresentationProofsController_acceptProofRequest",
"summary": "Accept a presentation request as prover (by sending a presentation message) to the connection associated with the proof record.", "summary": "Accept proof request by proofRecordId",
"description": "Accept a presentation request as prover (by sending a presentation message) to the connection associated with the proof record.",
"parameters": [], "parameters": [],
"responses": { "responses": {
"200": { "200": {
...@@ -612,7 +620,8 @@ ...@@ -612,7 +620,8 @@
"/v1/delete-proof-request/{proofRecordId}": { "/v1/delete-proof-request/{proofRecordId}": {
"post": { "post": {
"operationId": "PresentationProofsController_deleteProofRequest", "operationId": "PresentationProofsController_deleteProofRequest",
"summary": "Deletes a proofRecord in the proof repository.", "summary": "Delete proof request by proofRecordId",
"description": "Deletes a proofRecord in the proof repository.",
"parameters": [], "parameters": [],
"responses": { "responses": {
"200": { "200": {
...@@ -675,7 +684,8 @@ ...@@ -675,7 +684,8 @@
"/v1/decline-proof-request/{proofRecordId}": { "/v1/decline-proof-request/{proofRecordId}": {
"post": { "post": {
"operationId": "PresentationProofsController_declineProofRequest", "operationId": "PresentationProofsController_declineProofRequest",
"summary": "Decline proof request as proover (by sending a presentation message) to the connection associated with the proof record.", "summary": "Decline proof request by proofRecordId",
"description": "Decline proof request as prover (by sending a presentation message) to the connection associated with the proof record.",
"parameters": [], "parameters": [],
"responses": { "responses": {
"200": { "200": {
...@@ -780,7 +790,8 @@ ...@@ -780,7 +790,8 @@
"/v1/agent-proofs": { "/v1/agent-proofs": {
"get": { "get": {
"operationId": "PresentationProofsController_getAllProofRequest", "operationId": "PresentationProofsController_getAllProofRequest",
"summary": "This call provides the capability to get all proof records directly from agent. Pagination and sorting does not implemented in that version of Aries Framework Javascript", "summary": "Fetch all proofs directly from the agent",
"description": "This call provides the capability to get all proof records directly from agent. Pagination and sorting does not implemented in that version of Aries Framework Javascript",
"parameters": [ "parameters": [
{ {
"name": "threadId", "name": "threadId",
...@@ -889,6 +900,7 @@ ...@@ -889,6 +900,7 @@
"get": { "get": {
"operationId": "PresentationProofsController_redirectToOriginalUrl", "operationId": "PresentationProofsController_redirectToOriginalUrl",
"summary": "Get full url from short url id", "summary": "Get full url from short url id",
"description": "Get full url from short url id",
"parameters": [ "parameters": [
{ {
"name": "id", "name": "id",
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment