{
"openapi": "3.0.0",
"paths": {
"/api/v1/invitations": {
"post": {
"operationId": "RestController_createInvitation",
"parameters": [],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateInvitationResponseDto"
}
}
}
}
}
}
},
"/api/v1/invitations/accept": {
"post": {
"operationId": "RestController_acceptInvitation",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateInvitationResponseDto"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionRecordDto"
}
}
}
}
}
}
},
"/api/v1/connections": {
"get": {
"operationId": "RestController_fetchConnections",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ConnectionRecordDto"
}
}
}
}
}
}
}
},
"/api/v1/connections/{id}": {
"get": {
"operationId": "RestController_getConnectionById",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionRecordDto"
}
}
}
}
}
},
"delete": {
"operationId": "RestController_deleteConnectionById",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
}
}
},
"/api/v1/schemas": {
"post": {
"operationId": "RestController_createSchema",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSchemaRequestDto"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SchemaRecordDto"
}
}
}
}
}
},
"get": {
"operationId": "RestController_fetchSchemas",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SchemaRecordDto"
}
}
}
}
}
}
}
},
"/api/v1/schemas/get-by-id": {
"post": {
"operationId": "RestController_getSchemaById",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdReqDto"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SchemaRecordDto"
}
}
}
}
}
}
},
"/api/v1/definitions": {
"get": {
"operationId": "RestController_fetchCredentialDefinitions",
"parameters": [],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CreddefRecordDto"
}
}
}
}
}
}
},
"post": {
"operationId": "RestController_createCredentialDefinition",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCredentialDefinitionRequestDto"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreddefRecordDto"
}
}
}
}
}
}
},
"/api/v1/definitions/get-by-id": {
"post": {
"operationId": "RestController_getCredentialDefinitionById",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdReqDto"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreddefRecordDto"
}
}
}
}
}
}
},
"/api/v1/credentials/offers": {
"post": {
"operationId": "RestController_offerCredential",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OfferCredentialRequestDto"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CredentialOfferResponseDto"
}
}
}
}
}
}
},
"/api/v1/credentials": {
"get": {
"operationId": "RestController_fetchCredentials",
"parameters": [
{
"name": "states",
"required": false,
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"proposal-sent",
"proposal-received",
"offer-sent",
"offer-received",
"declined",
"request-sent",
"request-received",
"credential-issued",
"credential-received",
"done",
"abandoned"
]
}
}
},
{
"name": "connectionId",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CredentialRecordDto"
}
}
}
}
}
}
}
},
"/api/v1/credentials/{id}": {
"get": {
"operationId": "RestController_getCredentialById",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CredentialRecordDto"
}
}
}
}
}
},
"delete": {
"operationId": "RestController_deleteCredentialById",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
}
}
},
"/api/v1/credentials/{id}/format-data": {
"get": {
"operationId": "RestController_getCredentialFormatDataById",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CredentialFormatDataDto"
}
}
}
}
}
}
},
"/api/v1/credentials/offers/accept": {
"post": {
"operationId": "RestController_acceptCredential",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcceptCredentialDto"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CredentialRecordDto"
}
}
}
}
}
}
},
"/api/v1/credentials/offers/{credential_record_id}/decline": {
"post": {
"operationId": "RestController_declineCredential",
"parameters": [
{
"name": "credential_record_id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CredentialRecordDto"
}
}
}
}
}
}
},
"/api/v1/messages": {
"post": {
"operationId": "RestController_sendMessage",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MakeBasicMessageRequestDto"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageRecordDto"
}
}
}
}
}
},
"get": {
"operationId": "RestController_fetchBasicMessages",
"parameters": [
{
"name": "role",
"required": false,
"in": "query",
"schema": {
"enum": [
"sender",
"receiver"
],
"type": "string"
}
},
{
"name": "connectionId",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageRecordDto"
}
}
}
}
}
}
}
},
"/api/v1/messages/{id}": {
"delete": {
"operationId": "RestController_deleteBasicMessage",
"parameters": [
{
"name": "id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
}
}
},
"/api/v1/proofs": {
"get": {
"operationId": "RestController_fetchProofs",
"parameters": [
{
"name": "states",
"required": false,
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"proposal-sent",
"proposal-received",
"request-sent",
"request-received",
"presentation-sent",
"presentation-received",
"declined",
"abandoned",
"done"
]
}
}
},
{
"name": "connectionId",
"required": false,
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProofRecordDto"
}
}
}
}
}
}
}
},
"/api/v1/proofs/{proof_record_id}": {
"get": {
"operationId": "RestController_getProofById",
"parameters": [
{
"name": "proof_record_id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofRecordDto"
}
}
}
}
}
},
"delete": {
"operationId": "RestController_deleteProofById",
"parameters": [
{
"name": "proof_record_id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": ""
}
}
}
},
"/api/v1/proofs/{proof_record_id}/format-data": {
"get": {
"operationId": "RestController_getProofFormatDataById",
"parameters": [
{
"name": "proof_record_id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofFormatDataDto"
}
}
}
}
}
}
},
"/api/v1/proofs/{proof_record_id}/acceptance-wait": {
"post": {
"operationId": "RestController_proofAcceptanceWait",
"parameters": [
{
"name": "proof_record_id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofFormatDataDto"
}
}
}
}
}
}
},
"/api/v1/proofs/request": {
"post": {
"operationId": "RestController_requestProof",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestProofDto"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RequestProofResponseDto"
}
}
}
}
}
}
},
"/api/v1/proofs/accept": {
"post": {
"operationId": "RestController_acceptProof",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AcceptProofDto"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofRecordDto"
}
}
}
}
}
}
},
"/api/v1/proofs/{proof_record_id}/decline": {
"post": {
"operationId": "RestController_declineProofRequest",
"parameters": [
{
"name": "proof_record_id",
"required": true,
"in": "path",
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProofRecordDto"
}
}
}
}
}
}
},
"/api/v1/resolve-did": {
"post": {
"operationId": "RestController_resolveDid",
"parameters": [],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdReqDto"
}
}
}
},
"responses": {
"201": {
"description": "",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
}
}
},
"info": {
"title": "Agent",
"description": "Agent API",
"version": "1.0",
"contact": {}
},
"tags": [],
"servers": [],
"components": {
"schemas": {
"CreateInvitationResponseDto": {
"type": "object",
"properties": {
"invitationUrl": {
"type": "string",
"description": "Example of long invitation url",
"example": "http://0.0.0.0:8001?oob=eyJAdHlwZSI6Imh0dHBzOi8vZGlkY29tbS5vcmcvb3V0LW9mLWJhbmQvMS4xL2ludml0YXRpb24iLCJAaWQiOiIzYWExNGIzNC04YTk5LTQxY2UtYTY3NC1jODUxYmVhMTIxMWEiLCJsYWJlbCI6IkRFeGNWYXNkX0FHRU5UXzQ1IiwiYWNjZXB0IjpbImRpZGNvbW0vYWlwMSIsImRpZGNvbW0vYWlwMjtlbnY9cmZjMTkiXSwiaGFuZHNoYWtlX3Byb3RvY29scyI6WyJodHRwczovL2RpZGNvbW0ub3JnL2RpZGV4Y2hhbmdlLzEuMCIsImh0dHBzOi8vZGlkY29tbS5vcmcvY29ubmVjdGlvbnMvMS4wIl0sInNlcnZpY2VzIjpbeyJpZCI6IiNpbmxpbmUtMCIsInNlcnZpY2VFbmRwb2ludCI6Imh0dHA6Ly8wLjAuMC4wOjgwMDEiLCJ0eXBlIjoiZGlkLWNvbW11bmljYXRpb24iLCJyZWNpcGllbnRLZXlzIjpbImRpZDprZXk6ejZNa3VFcHllc1pNa3k0a1BpQzhEOEplZERlcm55YTFuaTREMUF3ZmdnWWt6YmR4Il0sInJvdXRpbmdLZXlzIjpbXX1dfQ"
},
"shortInvitationUrl": {
"type": "string",
"example": "http://0.0.0.0:8001/invitations/85a7c179-122b-4d2d-9a86-d92ad31cef2b"
}
},
"required": [
"invitationUrl",
"shortInvitationUrl"
]
},
"ConnectionRecordDto": {
"type": "object",
"properties": {
"state": {
"enum": [
"start",
"invitation-sent",
"invitation-received",
"request-sent",
"request-received",
"response-sent",
"response-received",
"abandoned",
"completed"
],
"type": "string"
},
"connectionName": {
"type": "string"
},
"alias": {
"type": "string"
},
"did": {
"type": "string"
},
"invitationDid": {
"type": "string"
},
"outOfBandId": {
"type": "string"
},
"id": {
"type": "string"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"type": "string"
}
},
"required": [
"state",
"id",
"createdAt"
]
},
"CreateSchemaRequestDto": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "my test schema"
},
"attributes": {
"example": [
"first_name, last_name"
],
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "string",
"example": "1.0.2",
"pattern": "/^(\\d+\\.)?(\\d+\\.)?(\\*|\\d+)$/"
}
},
"required": [
"name",
"attributes",
"version"
]
},
"SchemaRecordDto": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"attributes": {
"type": "array",
"items": {
"type": "string"
}
},
"version": {
"type": "string"
},
"issuerId": {
"type": "string"
},
"methodName": {
"type": "string"
},
"id": {
"type": "string"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"attributes",
"version",
"id",
"createdAt"
]
},
"IdReqDto": {
"type": "object",
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
]
},
"CreddefRecordDto": {
"type": "object",
"properties": {
"schemaId": {
"type": "string"
},
"issuerId": {
"type": "string"
},
"tag": {
"type": "string"
},
"id": {
"type": "string"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"type": "string"
}
},
"required": [
"schemaId",
"issuerId",
"tag",
"id",
"createdAt"
]
},
"CreateCredentialDefinitionRequestDto": {
"type": "object",
"properties": {
"schemaId": {
"type": "string"
},
"tag": {
"type": "string"
}
},
"required": [
"schemaId",
"tag"
]
},
"OfferCredentialAttributes": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
]
},
"OfferCredentialRequestDto": {
"type": "object",
"properties": {
"connectionId": {
"type": "string",
"example": "6464b521-005a-4379-91e0-a3692b31cafd"
},
"credentialDefinitionId": {
"type": "string"
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OfferCredentialAttributes"
}
}
},
"required": [
"credentialDefinitionId",
"attributes"
]
},
"CredentialRecordDto": {
"type": "object",
"properties": {
"state": {
"enum": [
"proposal-sent",
"proposal-received",
"offer-sent",
"offer-received",
"declined",
"request-sent",
"request-received",
"credential-issued",
"credential-received",
"done",
"abandoned"
],
"type": "string"
},
"credentialRecordType": {
"type": "string"
},
"connectionId": {
"type": "string"
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OfferCredentialAttributes"
}
},
"tags": {
"type": "object"
},
"id": {
"type": "string"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"type": "string"
}
},
"required": [
"state",
"credentialRecordType",
"tags",
"id",
"createdAt"
]
},
"CredentialOfferResponseDto": {
"type": "object",
"properties": {
"credentialUrl": {
"type": "string",
"nullable": true
},
"shortCredentialUrl": {
"type": "string",
"nullable": true
},
"credentialRecord": {
"$ref": "#/components/schemas/CredentialRecordDto"
}
},
"required": [
"credentialUrl",
"shortCredentialUrl",
"credentialRecord"
]
},
"CredentialFormatDataDto": {
"type": "object",
"properties": {
"proposalAttributes": {
"type": "array",
"items": {
"type": "object"
}
},
"offerAttributes": {
"type": "array",
"items": {
"type": "object"
}
},
"anoncredsProposal": {
"type": "object"
},
"anoncredsOffer": {
"type": "object"
},
"anoncredsRequest": {
"type": "object"
},
"anoncredsCredential": {
"type": "object"
}
}
},
"AcceptCredentialDto": {
"type": "object",
"properties": {
"credentialId": {
"type": "string"
},
"credentialUrl": {
"type": "string"
}
},
"required": [
"credentialId",
"credentialUrl"
]
},
"MakeBasicMessageRequestDto": {
"type": "object",
"properties": {
"connectionId": {
"type": "string",
"example": "6464b521-005a-4379-91e0-a3692b31cafd"
},
"content": {
"type": "string",
"example": "hello world"
}
},
"required": [
"connectionId",
"content"
]
},
"MessageRecordDto": {
"type": "object",
"properties": {
"connectionId": {
"type": "string",
"example": "6464b521-005a-4379-91e0-a3692b31cafd"
},
"role": {
"enum": [
"sender",
"receiver"
],
"type": "string"
},
"sentTime": {
"type": "string"
},
"from": {
"type": "string",
"example": "example-ocm-name"
},
"to": {
"type": "string",
"example": "example-ocm-name"
},
"content": {
"type": "string",
"example": "hello world"
},
"id": {
"type": "string"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"type": "string"
}
},
"required": [
"connectionId",
"role",
"sentTime",
"content",
"id",
"createdAt"
]
},
"ProofRecordDto": {
"type": "object",
"properties": {
"connectionId": {
"type": "string"
},
"state": {
"enum": [
"proposal-sent",
"proposal-received",
"request-sent",
"request-received",
"presentation-sent",
"presentation-received",
"declined",
"abandoned",
"done"
],
"type": "string"
},
"tags": {
"type": "object"
},
"id": {
"type": "string"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"updatedAt": {
"format": "date-time",
"type": "string"
}
},
"required": [
"state",
"tags",
"id",
"createdAt"
]
},
"ProofFormatDataDto": {
"type": "object",
"properties": {
"anoncredsProposal": {
"type": "object"
},
"anoncredsRequest": {
"type": "object"
},
"anoncredsPresentation": {
"type": "object"
}
}
},
"RequestProofAttribute": {
"type": "object",
"properties": {
"attributeName": {
"type": "string"
},
"credentialDefinitionId": {
"type": "string"
},
"schemaId": {
"type": "string"
}
},
"required": [
"attributeName",
"credentialDefinitionId",
"schemaId"
]
},
"RequestProofDto": {
"type": "object",
"properties": {
"connectionId": {
"type": "string",
"example": "6464b521-005a-4379-91e0-a3692b31cafd"
},
"attributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RequestProofAttribute"
}
}
},
"required": [
"attributes"
]
},
"RequestProofResponseDto": {
"type": "object",
"properties": {
"proofUrl": {
"type": "string",
"nullable": true
},
"shortProofUrl": {
"type": "string",
"nullable": true
},
"proofRecord": {
"$ref": "#/components/schemas/ProofRecordDto"
}
},
"required": [
"proofUrl",
"shortProofUrl",
"proofRecord"
]
},
"AcceptProofDto": {
"type": "object",
"properties": {
"proofId": {
"type": "string"
},
"proofUrl": {
"type": "string"
}
},
"required": [
"proofId",
"proofUrl"
]
}
}
}
}