> For the complete documentation index, see [llms.txt](https://dev.guardian.hedera.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dev.guardian.hedera.com/api-reference/models.md). # Models ## The PermissionGroupResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PermissionGroupResponseDTO":{"type":"object","properties":{"uuid":{"type":"string"},"roleId":{"type":"string"},"roleName":{"type":"string"},"owner":{"type":"string","nullable":true}},"required":["uuid","roleId","roleName"]}}}} ``` ## The AccountsSessionResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"AccountsSessionResponseDTO":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"},"did":{"type":"string"},"hederaAccountId":{"type":"string"},"role":{"type":"string"},"permissions":{"type":"array","items":{"type":"string"}},"permissionsGroup":{"type":"array","items":{"$ref":"#/components/schemas/PermissionGroupResponseDTO"}},"location":{"type":"string"}},"required":["id","username","role","permissions"]},"PermissionGroupResponseDTO":{"type":"object","properties":{"uuid":{"type":"string"},"roleId":{"type":"string"},"roleName":{"type":"string"},"owner":{"type":"string","nullable":true}},"required":["uuid","roleId","roleName"]}}}} ``` ## The InternalServerErrorDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}}} ``` ## The RegisterUserDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RegisterUserDTO":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"},"password_confirmation":{"type":"string"},"role":{"type":"string"}},"required":["username","password","password_confirmation","role"]}}}} ``` ## The AccountsResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"AccountsResponseDTO":{"type":"object","properties":{"id":{"type":"string"},"username":{"type":"string"},"role":{"type":"string"},"permissions":{"type":"array","items":{"type":"string"}},"permissionsGroup":{"type":"array","items":{"$ref":"#/components/schemas/PermissionGroupResponseDTO"}},"location":{"type":"string"}},"required":["id","username","role"]},"PermissionGroupResponseDTO":{"type":"object","properties":{"uuid":{"type":"string"},"roleId":{"type":"string"},"roleName":{"type":"string"},"owner":{"type":"string","nullable":true}},"required":["uuid","roleId","roleName"]}}}} ``` ## The ConflictErrorDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ConflictErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}}} ``` ## The UnprocessableEntityErrorDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]}}}} ``` ## The SubjectDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SubjectDTO":{"type":"object","properties":{"@context":{"nullable":true,"type":"array","items":{"type":"string"}},"id":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}},"required":["@context"]}}}} ``` ## The DidDocumentDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"DidDocumentDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"@context":{"nullable":true,"type":"array","items":{"type":"string"}},"alsoKnownAs":{"nullable":true,"type":"array","items":{"type":"string"}},"controller":{"nullable":true,"type":"array","items":{"type":"string"}},"verificationMethod":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"authentication":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"assertionMethod":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"keyAgreement":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"capabilityInvocation":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"capabilityDelegation":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"service":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}}},"required":["id","@context","alsoKnownAs","controller","verificationMethod","authentication","assertionMethod","keyAgreement","capabilityInvocation","capabilityDelegation","service"]}}}} ``` ## The DidKeyDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"DidKeyDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"key":{"type":"string","nullable":false}},"required":["id","key"]}}}} ``` ## The FireblocksConfigDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"FireblocksConfigDTO":{"type":"object","properties":{"fireBlocksVaultId":{"type":"string"},"fireBlocksAssetId":{"type":"string"},"fireBlocksApiKey":{"type":"string"},"fireBlocksPrivateiKey":{"type":"string","description":"API property name is `fireBlocksPrivateiKey` (typo preserved for compatibility)."}}}}}} ``` ## The OnboardingDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"OnboardingDTO":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"},"password_confirmation":{"type":"string"},"role":{"type":"string"},"hederaAccountId":{"type":"string","description":"Hedera account ID (e.g. 0.0.12345). Auto-generated from the operator account if omitted."},"hederaAccountKey":{"type":"string","description":"Hedera account private key. Required when hederaAccountId is provided; auto-generated if omitted."},"parent":{"type":"string","description":"Standard Registry username or DID. Required for USER role accounts to link them to their registry."},"vcDocument":{"description":"VC document to publish during profile setup.","allOf":[{"$ref":"#/components/schemas/SubjectDTO"}]},"didDocument":{"description":"Pre-created DID document. Auto-generated if omitted.","allOf":[{"$ref":"#/components/schemas/DidDocumentDTO"}]},"didKeys":{"description":"Private keys for the DID document methods.","type":"array","items":{"$ref":"#/components/schemas/DidKeyDTO"}},"useFireblocksSigning":{"type":"boolean","default":false,"description":"Use Fireblocks signing instead of local key."},"fireblocksConfig":{"description":"Fireblocks configuration (required when useFireblocksSigning is true).","allOf":[{"$ref":"#/components/schemas/FireblocksConfigDTO"}]}},"required":["username","password","password_confirmation","role"]},"SubjectDTO":{"type":"object","properties":{"@context":{"nullable":true,"type":"array","items":{"type":"string"}},"id":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}},"required":["@context"]},"DidDocumentDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"@context":{"nullable":true,"type":"array","items":{"type":"string"}},"alsoKnownAs":{"nullable":true,"type":"array","items":{"type":"string"}},"controller":{"nullable":true,"type":"array","items":{"type":"string"}},"verificationMethod":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"authentication":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"assertionMethod":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"keyAgreement":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"capabilityInvocation":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"capabilityDelegation":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"service":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}}},"required":["id","@context","alsoKnownAs","controller","verificationMethod","authentication","assertionMethod","keyAgreement","capabilityInvocation","capabilityDelegation","service"]},"DidKeyDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"key":{"type":"string","nullable":false}},"required":["id","key"]},"FireblocksConfigDTO":{"type":"object","properties":{"fireBlocksVaultId":{"type":"string"},"fireBlocksAssetId":{"type":"string"},"fireBlocksApiKey":{"type":"string"},"fireBlocksPrivateiKey":{"type":"string","description":"API property name is `fireBlocksPrivateiKey` (typo preserved for compatibility)."}}}}}} ``` ## The TaskDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"TaskDTO":{"type":"object","properties":{"taskId":{"type":"string","description":"Task Id"},"expectation":{"type":"number","description":"Expected count of task phases"},"action":{"type":"string","description":"Task action"},"userId":{"type":"string","description":"User Id"}},"required":["taskId","expectation","action","userId"]}}}} ``` ## The LoginUserDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"LoginUserDTO":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"},"otp":{"type":"string"}},"required":["username","password","otp"]}}}} ``` ## The AccountsLoginResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"AccountsLoginResponseDTO":{"type":"object","properties":{"username":{"type":"string"},"did":{"type":"string"},"role":{"type":"string"},"refreshToken":{"type":"string"},"weakPassword":{"type":"boolean"}},"required":["username","did","role","refreshToken"]}}}} ``` ## The UnauthorizedErrorDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}}} ``` ## The ChangePasswordDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ChangePasswordDTO":{"type":"object","properties":{"username":{"type":"string"},"oldPassword":{"type":"string"},"newPassword":{"type":"string"}},"required":["username","oldPassword","newPassword"]}}}} ``` ## The ForbiddenErrorDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]}}}} ``` ## The AccessTokenRequestDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"AccessTokenRequestDTO":{"type":"object","properties":{"refreshToken":{"type":"string","description":"Refresh token"}},"required":["refreshToken"]}}}} ``` ## The AccessTokenResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"AccessTokenResponseDTO":{"type":"object","properties":{"accessToken":{"type":"string","description":"Access token"}},"required":["accessToken"]}}}} ``` ## The UserAccountDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"UserAccountDTO":{"type":"object","properties":{"username":{"type":"string"},"parent":{"type":"string"},"did":{"type":"string"}},"required":["username"]}}}} ``` ## The StandardRegistryAccountDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"StandardRegistryAccountDTO":{"type":"object","properties":{"username":{"type":"string"},"did":{"type":"string"}},"required":["username"]}}}} ``` ## The ProofDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]}}}} ``` ## The VcDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"VcDTO":{"type":"object","properties":{"id":{"type":"string","nullable":true},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"credentialSubject":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"issuer":{"oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]},"issuanceDate":{"type":"string"},"proof":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ProofDTO"}]}},"required":["id","@context","type","credentialSubject","issuer","issuanceDate","proof"]},"ProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]}}}} ``` ## The VcDocumentDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"VcDocumentDTO":{"type":"object","properties":{"id":{"type":"string"},"policyId":{"type":"string"},"hash":{"type":"string"},"signature":{"type":"number"},"status":{"type":"string","enum":["NEW","ISSUE","REVOKE","SUSPEND","RESUME","FAILED"]},"tag":{"type":"string"},"type":{"type":"string"},"createDate":{"type":"string"},"updateDate":{"type":"string"},"owner":{"type":"string"},"hederaStatus":{"type":"string"},"option":{"type":"object","additionalProperties":true},"topicId":{"type":"string"},"messageId":{"type":"string"},"document":{"$ref":"#/components/schemas/VcDTO"}}},"VcDTO":{"type":"object","properties":{"id":{"type":"string","nullable":true},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"credentialSubject":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"issuer":{"oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]},"issuanceDate":{"type":"string"},"proof":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ProofDTO"}]}},"required":["id","@context","type","credentialSubject","issuer","issuanceDate","proof"]},"ProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]}}}} ``` ## The PolicyTestDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyTestDTO":{"type":"object","properties":{"id":{"type":"string","description":"Test ID"},"uuid":{"type":"string","description":"Test UUID"},"name":{"type":"string","description":"Test Name"},"policyId":{"type":"string","description":"Policy ID"},"owner":{"type":"string","description":"Test owner"},"status":{"type":"string","description":"Test status","enum":["New","Running","Stopped","Success","Failure"]},"date":{"type":"string","description":"Last start date"},"duration":{"type":"string","description":"Test duration"},"progress":{"type":"string","description":"Test progress"},"resultId":{"type":"string","description":"Test result"},"result":{"type":"string","description":"Test result"}},"required":["id","uuid","name","policyId","owner","status","date","duration","progress","resultId","result"]}}}} ``` ## The PolicyImportantParametersDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyImportantParametersDTO":{"type":"object","properties":{"atValidation":{"type":"string"},"monitored":{"type":"string"}}}}}} ``` ## The PolicyToolDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyToolDTO":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string","nullable":true},"topicId":{"type":"string"},"messageId":{"type":"string"}},"required":["name","topicId","messageId"]}}}} ``` ## The PolicyEditableFieldDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyEditableFieldDTO":{"type":"object","properties":{}}}}} ``` ## The IgnoreRuleDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"IgnoreRuleDTO":{"type":"object","properties":{"code":{"type":"string","description":"Stable message code, e.g. DEPRECATION_BLOCK"},"blockType":{"type":"string","description":"Limit by block type"},"property":{"type":"string","description":"Limit by property"},"contains":{"type":"string","description":"Substring filter applied to message text"},"severity":{"type":"string","description":"Type of message","enum":["warning","info"]}}}}}} ``` ## The PolicyDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"topicDescription":{"type":"string"},"applicabilityConditions":{"type":"string"},"detailsUrl":{"type":"string"},"typicalProjects":{"type":"string"},"importantParameters":{"$ref":"#/components/schemas/PolicyImportantParametersDTO"},"policyTag":{"type":"string"},"status":{"type":"string","enum":["DRY-RUN","DRAFT","PUBLISH_ERROR","PUBLISH","DISCONTINUED","DEMO","VIEW"]},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"instanceTopicId":{"type":"string"},"messageId":{"type":"string"},"availability":{"type":"string","enum":["private","public"]},"codeVersion":{"type":"string"},"tools":{"type":"array","items":{"$ref":"#/components/schemas/PolicyToolDTO"}},"createDate":{"type":"string"},"version":{"type":"string"},"originalChanged":{"type":"string"},"editableParametersSettings":{"type":"array","items":{"$ref":"#/components/schemas/PolicyEditableFieldDTO"}},"config":{"type":"object","additionalProperties":true},"userRole":{"type":"string"},"userRoles":{"type":"array","items":{"type":"string"}},"userGroup":{"type":"object","additionalProperties":true,"nullable":true,"description":"Last active group in iteration order (not a separate summary). Often shown via groupLabel or uuid."},"userGroups":{"additionalProperties":true,"description":"Full list of group rows for this user in the policy (getGroupsByUser), including inactive.","type":"array","items":{"type":"object"}},"policyRoles":{"type":"array","items":{"type":"string"}},"policyNavigation":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTopics":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTokens":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyGroups":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyDocumentation":{"additionalProperties":true,"description":"User-configured policy API documentation entries. The `alias` may be a single slug (`create-device`) or a path of slugs separated by `/` (`monitoring-reports/create`).","type":"array","items":{"type":"object"}},"categories":{"type":"array","items":{"type":"string"}},"projectSchema":{"type":"string"},"tests":{"type":"array","items":{"$ref":"#/components/schemas/PolicyTestDTO"}},"ignoreRules":{"description":"Validation-only rules to hide matching warnings/infos (not persisted)","type":"array","items":{"$ref":"#/components/schemas/IgnoreRuleDTO"}}},"required":["id","uuid","name","description","topicDescription","policyTag","status","creator","owner","topicId","instanceTopicId","messageId","codeVersion","tools","createDate","version","editableParametersSettings","config","userRole","userRoles","userGroup","userGroups","policyRoles","policyNavigation","policyTopics","policyTokens","policyGroups","policyDocumentation","categories","projectSchema","tests"]},"PolicyImportantParametersDTO":{"type":"object","properties":{"atValidation":{"type":"string"},"monitored":{"type":"string"}}},"PolicyToolDTO":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string","nullable":true},"topicId":{"type":"string"},"messageId":{"type":"string"}},"required":["name","topicId","messageId"]},"PolicyEditableFieldDTO":{"type":"object","properties":{}},"PolicyTestDTO":{"type":"object","properties":{"id":{"type":"string","description":"Test ID"},"uuid":{"type":"string","description":"Test UUID"},"name":{"type":"string","description":"Test Name"},"policyId":{"type":"string","description":"Policy ID"},"owner":{"type":"string","description":"Test owner"},"status":{"type":"string","description":"Test status","enum":["New","Running","Stopped","Success","Failure"]},"date":{"type":"string","description":"Last start date"},"duration":{"type":"string","description":"Test duration"},"progress":{"type":"string","description":"Test progress"},"resultId":{"type":"string","description":"Test result"},"result":{"type":"string","description":"Test result"}},"required":["id","uuid","name","policyId","owner","status","date","duration","progress","resultId","result"]},"IgnoreRuleDTO":{"type":"object","properties":{"code":{"type":"string","description":"Stable message code, e.g. DEPRECATION_BLOCK"},"blockType":{"type":"string","description":"Limit by block type"},"property":{"type":"string","description":"Limit by property"},"contains":{"type":"string","description":"Substring filter applied to message text"},"severity":{"type":"string","description":"Type of message","enum":["warning","info"]}}}}}} ``` ## The AggregatedDTOItem object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"AggregatedDTOItem":{"type":"object","properties":{"did":{"type":"string"},"vcDocument":{"$ref":"#/components/schemas/VcDocumentDTO"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/PolicyDTO"}},"username":{"type":"string"},"hederaAccountId":{"type":"string"}},"required":["did","vcDocument","policies","username","hederaAccountId"]},"VcDocumentDTO":{"type":"object","properties":{"id":{"type":"string"},"policyId":{"type":"string"},"hash":{"type":"string"},"signature":{"type":"number"},"status":{"type":"string","enum":["NEW","ISSUE","REVOKE","SUSPEND","RESUME","FAILED"]},"tag":{"type":"string"},"type":{"type":"string"},"createDate":{"type":"string"},"updateDate":{"type":"string"},"owner":{"type":"string"},"hederaStatus":{"type":"string"},"option":{"type":"object","additionalProperties":true},"topicId":{"type":"string"},"messageId":{"type":"string"},"document":{"$ref":"#/components/schemas/VcDTO"}}},"VcDTO":{"type":"object","properties":{"id":{"type":"string","nullable":true},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"credentialSubject":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"issuer":{"oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]},"issuanceDate":{"type":"string"},"proof":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ProofDTO"}]}},"required":["id","@context","type","credentialSubject","issuer","issuanceDate","proof"]},"ProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]},"PolicyDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"topicDescription":{"type":"string"},"applicabilityConditions":{"type":"string"},"detailsUrl":{"type":"string"},"typicalProjects":{"type":"string"},"importantParameters":{"$ref":"#/components/schemas/PolicyImportantParametersDTO"},"policyTag":{"type":"string"},"status":{"type":"string","enum":["DRY-RUN","DRAFT","PUBLISH_ERROR","PUBLISH","DISCONTINUED","DEMO","VIEW"]},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"instanceTopicId":{"type":"string"},"messageId":{"type":"string"},"availability":{"type":"string","enum":["private","public"]},"codeVersion":{"type":"string"},"tools":{"type":"array","items":{"$ref":"#/components/schemas/PolicyToolDTO"}},"createDate":{"type":"string"},"version":{"type":"string"},"originalChanged":{"type":"string"},"editableParametersSettings":{"type":"array","items":{"$ref":"#/components/schemas/PolicyEditableFieldDTO"}},"config":{"type":"object","additionalProperties":true},"userRole":{"type":"string"},"userRoles":{"type":"array","items":{"type":"string"}},"userGroup":{"type":"object","additionalProperties":true,"nullable":true,"description":"Last active group in iteration order (not a separate summary). Often shown via groupLabel or uuid."},"userGroups":{"additionalProperties":true,"description":"Full list of group rows for this user in the policy (getGroupsByUser), including inactive.","type":"array","items":{"type":"object"}},"policyRoles":{"type":"array","items":{"type":"string"}},"policyNavigation":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTopics":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTokens":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyGroups":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyDocumentation":{"additionalProperties":true,"description":"User-configured policy API documentation entries. The `alias` may be a single slug (`create-device`) or a path of slugs separated by `/` (`monitoring-reports/create`).","type":"array","items":{"type":"object"}},"categories":{"type":"array","items":{"type":"string"}},"projectSchema":{"type":"string"},"tests":{"type":"array","items":{"$ref":"#/components/schemas/PolicyTestDTO"}},"ignoreRules":{"description":"Validation-only rules to hide matching warnings/infos (not persisted)","type":"array","items":{"$ref":"#/components/schemas/IgnoreRuleDTO"}}},"required":["id","uuid","name","description","topicDescription","policyTag","status","creator","owner","topicId","instanceTopicId","messageId","codeVersion","tools","createDate","version","editableParametersSettings","config","userRole","userRoles","userGroup","userGroups","policyRoles","policyNavigation","policyTopics","policyTokens","policyGroups","policyDocumentation","categories","projectSchema","tests"]},"PolicyImportantParametersDTO":{"type":"object","properties":{"atValidation":{"type":"string"},"monitored":{"type":"string"}}},"PolicyToolDTO":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string","nullable":true},"topicId":{"type":"string"},"messageId":{"type":"string"}},"required":["name","topicId","messageId"]},"PolicyEditableFieldDTO":{"type":"object","properties":{}},"PolicyTestDTO":{"type":"object","properties":{"id":{"type":"string","description":"Test ID"},"uuid":{"type":"string","description":"Test UUID"},"name":{"type":"string","description":"Test Name"},"policyId":{"type":"string","description":"Policy ID"},"owner":{"type":"string","description":"Test owner"},"status":{"type":"string","description":"Test status","enum":["New","Running","Stopped","Success","Failure"]},"date":{"type":"string","description":"Last start date"},"duration":{"type":"string","description":"Test duration"},"progress":{"type":"string","description":"Test progress"},"resultId":{"type":"string","description":"Test result"},"result":{"type":"string","description":"Test result"}},"required":["id","uuid","name","policyId","owner","status","date","duration","progress","resultId","result"]},"IgnoreRuleDTO":{"type":"object","properties":{"code":{"type":"string","description":"Stable message code, e.g. DEPRECATION_BLOCK"},"blockType":{"type":"string","description":"Limit by block type"},"property":{"type":"string","description":"Limit by property"},"contains":{"type":"string","description":"Substring filter applied to message text"},"severity":{"type":"string","description":"Type of message","enum":["warning","info"]}}}}}} ``` ## The BalanceResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"BalanceResponseDTO":{"type":"object","properties":{"balance":{"type":"string"},"unit":{"type":"string"},"user":{"$ref":"#/components/schemas/StandardRegistryAccountDTO"}},"required":["balance","unit","user"]},"StandardRegistryAccountDTO":{"type":"object","properties":{"username":{"type":"string"},"did":{"type":"string"}},"required":["username"]}}}} ``` ## The OTPConfigDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"OTPConfigDTO":{"type":"object","properties":{"algo":{"type":"string"},"digits":{"type":"number"},"period":{"type":"number"},"secretSize":{"type":"number"}},"required":["algo","digits","period","secretSize"]}}}} ``` ## The GenerateOPTResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"GenerateOPTResponseDTO":{"type":"object","properties":{"issuer":{"type":"string"},"user":{"type":"string"},"secret":{"type":"string"},"url":{"type":"string"},"config":{"$ref":"#/components/schemas/OTPConfigDTO"}},"required":["issuer","user","secret","url","config"]},"OTPConfigDTO":{"type":"object","properties":{"algo":{"type":"string"},"digits":{"type":"number"},"period":{"type":"number"},"secretSize":{"type":"number"}},"required":["algo","digits","period","secretSize"]}}}} ``` ## The OTPConfirmDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"OTPConfirmDTO":{"type":"object","properties":{"token":{"type":"string"}},"required":["token"]}}}} ``` ## The OTPConfirmResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"OTPConfirmResponseDTO":{"type":"object","properties":{"success":{"type":"boolean"},"backupCodes":{"type":"array","items":{"type":"string"}}},"required":["success","backupCodes"]}}}} ``` ## The OTPStatusResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"OTPStatusResponseDTO":{"type":"object","properties":{"enabled":{"type":"boolean"}},"required":["enabled"]}}}} ``` ## The EmptyResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"EmptyResponseDTO":{"type":"object","properties":{}}}}} ``` ## The FilterSearchPoliciesDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"FilterSearchPoliciesDTO":{"type":"object","properties":{"policyId":{"type":"string"},"type":{"type":"string","enum":["Owned","Local","Global"]},"owner":{"type":"string"},"minVcCount":{"type":"number"},"minVpCount":{"type":"number"},"minTokensCount":{"type":"number"},"text":{"type":"string"},"threshold":{"type":"number","minimum":0,"maximum":100},"toolMessageIds":{"type":"array","items":{"type":"string"}},"toolName":{"type":"string"},"toolVersion":{"type":"string"}}}}}} ``` ## The SearchPolicyDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SearchPolicyDTO":{"type":"object","properties":{"type":{"type":"string","enum":["Local","Global"]},"id":{"type":"string"},"topicId":{"type":"string"},"messageId":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"string"},"status":{"type":"string","enum":["DRY-RUN","DRAFT","PUBLISH_ERROR","PUBLISH","DISCONTINUED","DEMO","VIEW"]},"owner":{"type":"string"},"tags":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"vcCount":{"type":"number"},"vpCount":{"type":"number"},"tokensCount":{"type":"number"},"rate":{"type":"number"}},"required":["tags"]}}}} ``` ## The SearchPoliciesDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SearchPoliciesDTO":{"type":"object","properties":{"target":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/SearchPolicyDTO"}]},"result":{"type":"array","items":{"$ref":"#/components/schemas/SearchPolicyDTO"}}},"required":["result"]},"SearchPolicyDTO":{"type":"object","properties":{"type":{"type":"string","enum":["Local","Global"]},"id":{"type":"string"},"topicId":{"type":"string"},"messageId":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"string"},"status":{"type":"string","enum":["DRY-RUN","DRAFT","PUBLISH_ERROR","PUBLISH","DISCONTINUED","DEMO","VIEW"]},"owner":{"type":"string"},"tags":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"vcCount":{"type":"number"},"vpCount":{"type":"number"},"tokensCount":{"type":"number"},"rate":{"type":"number"}},"required":["tags"]}}}} ``` ## The ComparePoliciesItemDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ComparePoliciesItemDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"instanceTopicId":{"type":"string","nullable":true},"version":{"type":"string"},"type":{"type":"string"}},"required":["id","name","description","type"]}}}} ``` ## The ComparePoliciesColumnDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ComparePoliciesColumnDTO":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"display":{"type":"string"}},"required":["name","label","type"]}}}} ``` ## The ComparePoliciesPropertyValueDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ComparePoliciesPropertyValueDTO":{"type":"object","properties":{"name":{"type":"string"},"lvl":{"type":"number"},"path":{"type":"string"},"type":{"type":"string"},"value":{"type":"object","description":"Arbitrary property value"}},"required":["name","lvl","path","type","value"]}}}} ``` ## The ComparePoliciesBlockSideDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ComparePoliciesBlockSideDTO":{"type":"object","properties":{"index":{"type":"number"},"blockType":{"type":"string"},"tag":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesPropertyValueDTO"}},"events":{"description":"Block events payloads","type":"array","items":{"type":"object"}}},"required":["index","blockType","tag","properties","events"]},"ComparePoliciesPropertyValueDTO":{"type":"object","properties":{"name":{"type":"string"},"lvl":{"type":"number"},"path":{"type":"string"},"type":{"type":"string"},"value":{"type":"object","description":"Arbitrary property value"}},"required":["name","lvl","path","type","value"]}}}} ``` ## The ComparePoliciesRateEntryDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ComparePoliciesRateEntryDTO":{"type":"object","properties":{"type":{"type":"string"},"totalRate":{"type":"number"},"items":{"description":"Pair of compared values, can include null","type":"array","items":{"type":"object"}},"name":{"type":"string"},"path":{"type":"string"},"lvl":{"type":"number"}},"required":["type","totalRate","items"]}}}} ``` ## The ComparePoliciesBlocksReportRowDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ComparePoliciesBlocksReportRowDTO":{"type":"object","properties":{"lvl":{"type":"number"},"type":{"type":"string"},"block_type":{"type":"string"},"left_index":{"type":"number"},"left_type":{"type":"string"},"left_tag":{"type":"string"},"right_index":{"type":"number"},"right_type":{"type":"string"},"right_tag":{"type":"string"},"index_rate":{"type":"string"},"permission_rate":{"type":"string"},"prop_rate":{"type":"string"},"event_rate":{"type":"string"},"artifacts_rate":{"type":"string"},"total_rate":{"type":"string"},"left":{"$ref":"#/components/schemas/ComparePoliciesBlockSideDTO"},"right":{"$ref":"#/components/schemas/ComparePoliciesBlockSideDTO"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"artifacts":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"size":{"type":"number","description":"Present in merged multi-compare report rows"}}},"ComparePoliciesBlockSideDTO":{"type":"object","properties":{"index":{"type":"number"},"blockType":{"type":"string"},"tag":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesPropertyValueDTO"}},"events":{"description":"Block events payloads","type":"array","items":{"type":"object"}}},"required":["index","blockType","tag","properties","events"]},"ComparePoliciesPropertyValueDTO":{"type":"object","properties":{"name":{"type":"string"},"lvl":{"type":"number"},"path":{"type":"string"},"type":{"type":"string"},"value":{"type":"object","description":"Arbitrary property value"}},"required":["name","lvl","path","type","value"]},"ComparePoliciesRateEntryDTO":{"type":"object","properties":{"type":{"type":"string"},"totalRate":{"type":"number"},"items":{"description":"Pair of compared values, can include null","type":"array","items":{"type":"object"}},"name":{"type":"string"},"path":{"type":"string"},"lvl":{"type":"number"}},"required":["type","totalRate","items"]}}}} ``` ## The ComparePoliciesBlocksSectionDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ComparePoliciesBlocksSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"description":"Rows may include additional dynamic fields in multi-compare mode","type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesBlocksReportRowDTO"}}},"required":["columns","report"]},"ComparePoliciesColumnDTO":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"display":{"type":"string"}},"required":["name","label","type"]},"ComparePoliciesBlocksReportRowDTO":{"type":"object","properties":{"lvl":{"type":"number"},"type":{"type":"string"},"block_type":{"type":"string"},"left_index":{"type":"number"},"left_type":{"type":"string"},"left_tag":{"type":"string"},"right_index":{"type":"number"},"right_type":{"type":"string"},"right_tag":{"type":"string"},"index_rate":{"type":"string"},"permission_rate":{"type":"string"},"prop_rate":{"type":"string"},"event_rate":{"type":"string"},"artifacts_rate":{"type":"string"},"total_rate":{"type":"string"},"left":{"$ref":"#/components/schemas/ComparePoliciesBlockSideDTO"},"right":{"$ref":"#/components/schemas/ComparePoliciesBlockSideDTO"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"artifacts":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"size":{"type":"number","description":"Present in merged multi-compare report rows"}}},"ComparePoliciesBlockSideDTO":{"type":"object","properties":{"index":{"type":"number"},"blockType":{"type":"string"},"tag":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesPropertyValueDTO"}},"events":{"description":"Block events payloads","type":"array","items":{"type":"object"}}},"required":["index","blockType","tag","properties","events"]},"ComparePoliciesPropertyValueDTO":{"type":"object","properties":{"name":{"type":"string"},"lvl":{"type":"number"},"path":{"type":"string"},"type":{"type":"string"},"value":{"type":"object","description":"Arbitrary property value"}},"required":["name","lvl","path","type","value"]},"ComparePoliciesRateEntryDTO":{"type":"object","properties":{"type":{"type":"string"},"totalRate":{"type":"number"},"items":{"description":"Pair of compared values, can include null","type":"array","items":{"type":"object"}},"name":{"type":"string"},"path":{"type":"string"},"lvl":{"type":"number"}},"required":["type","totalRate","items"]}}}} ``` ## The ComparePoliciesPropsReportRowDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ComparePoliciesPropsReportRowDTO":{"type":"object","properties":{"left_name":{"type":"string"},"right_name":{"type":"string"},"total_rate":{"type":"string"},"left":{"type":"object"},"right":{"type":"object"},"type":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"size":{"type":"number","description":"Present in merged multi-compare report rows"}}},"ComparePoliciesRateEntryDTO":{"type":"object","properties":{"type":{"type":"string"},"totalRate":{"type":"number"},"items":{"description":"Pair of compared values, can include null","type":"array","items":{"type":"object"}},"name":{"type":"string"},"path":{"type":"string"},"lvl":{"type":"number"}},"required":["type","totalRate","items"]}}}} ``` ## The ComparePoliciesPropsSectionDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ComparePoliciesPropsSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"description":"Rows may include additional dynamic fields in multi-compare mode","type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesPropsReportRowDTO"}}},"required":["columns","report"]},"ComparePoliciesColumnDTO":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"display":{"type":"string"}},"required":["name","label","type"]},"ComparePoliciesPropsReportRowDTO":{"type":"object","properties":{"left_name":{"type":"string"},"right_name":{"type":"string"},"total_rate":{"type":"string"},"left":{"type":"object"},"right":{"type":"object"},"type":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"size":{"type":"number","description":"Present in merged multi-compare report rows"}}},"ComparePoliciesRateEntryDTO":{"type":"object","properties":{"type":{"type":"string"},"totalRate":{"type":"number"},"items":{"description":"Pair of compared values, can include null","type":"array","items":{"type":"object"}},"name":{"type":"string"},"path":{"type":"string"},"lvl":{"type":"number"}},"required":["type","totalRate","items"]}}}} ``` ## The ComparePoliciesDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ComparePoliciesDTO":{"type":"object","properties":{"left":{"$ref":"#/components/schemas/ComparePoliciesItemDTO"},"right":{"$ref":"#/components/schemas/ComparePoliciesItemDTO"},"total":{"type":"number"},"blocks":{"$ref":"#/components/schemas/ComparePoliciesBlocksSectionDTO"},"roles":{"$ref":"#/components/schemas/ComparePoliciesPropsSectionDTO"},"groups":{"$ref":"#/components/schemas/ComparePoliciesPropsSectionDTO"},"topics":{"$ref":"#/components/schemas/ComparePoliciesPropsSectionDTO"},"tokens":{"$ref":"#/components/schemas/ComparePoliciesPropsSectionDTO"},"tools":{"$ref":"#/components/schemas/ComparePoliciesPropsSectionDTO"}},"required":["left","right","total","blocks","roles","groups","topics","tokens","tools"]},"ComparePoliciesItemDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"instanceTopicId":{"type":"string","nullable":true},"version":{"type":"string"},"type":{"type":"string"}},"required":["id","name","description","type"]},"ComparePoliciesBlocksSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"description":"Rows may include additional dynamic fields in multi-compare mode","type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesBlocksReportRowDTO"}}},"required":["columns","report"]},"ComparePoliciesColumnDTO":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"display":{"type":"string"}},"required":["name","label","type"]},"ComparePoliciesBlocksReportRowDTO":{"type":"object","properties":{"lvl":{"type":"number"},"type":{"type":"string"},"block_type":{"type":"string"},"left_index":{"type":"number"},"left_type":{"type":"string"},"left_tag":{"type":"string"},"right_index":{"type":"number"},"right_type":{"type":"string"},"right_tag":{"type":"string"},"index_rate":{"type":"string"},"permission_rate":{"type":"string"},"prop_rate":{"type":"string"},"event_rate":{"type":"string"},"artifacts_rate":{"type":"string"},"total_rate":{"type":"string"},"left":{"$ref":"#/components/schemas/ComparePoliciesBlockSideDTO"},"right":{"$ref":"#/components/schemas/ComparePoliciesBlockSideDTO"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"artifacts":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"size":{"type":"number","description":"Present in merged multi-compare report rows"}}},"ComparePoliciesBlockSideDTO":{"type":"object","properties":{"index":{"type":"number"},"blockType":{"type":"string"},"tag":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesPropertyValueDTO"}},"events":{"description":"Block events payloads","type":"array","items":{"type":"object"}}},"required":["index","blockType","tag","properties","events"]},"ComparePoliciesPropertyValueDTO":{"type":"object","properties":{"name":{"type":"string"},"lvl":{"type":"number"},"path":{"type":"string"},"type":{"type":"string"},"value":{"type":"object","description":"Arbitrary property value"}},"required":["name","lvl","path","type","value"]},"ComparePoliciesRateEntryDTO":{"type":"object","properties":{"type":{"type":"string"},"totalRate":{"type":"number"},"items":{"description":"Pair of compared values, can include null","type":"array","items":{"type":"object"}},"name":{"type":"string"},"path":{"type":"string"},"lvl":{"type":"number"}},"required":["type","totalRate","items"]},"ComparePoliciesPropsSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"description":"Rows may include additional dynamic fields in multi-compare mode","type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesPropsReportRowDTO"}}},"required":["columns","report"]},"ComparePoliciesPropsReportRowDTO":{"type":"object","properties":{"left_name":{"type":"string"},"right_name":{"type":"string"},"total_rate":{"type":"string"},"left":{"type":"object"},"right":{"type":"object"},"type":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"size":{"type":"number","description":"Present in merged multi-compare report rows"}}}}}} ``` ## The ComparePoliciesMultiDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ComparePoliciesMultiDTO":{"type":"object","properties":{"size":{"type":"number"},"left":{"$ref":"#/components/schemas/ComparePoliciesItemDTO"},"rights":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesItemDTO"}},"totals":{"type":"array","items":{"type":"object"}},"blocks":{"$ref":"#/components/schemas/ComparePoliciesBlocksSectionDTO"},"roles":{"$ref":"#/components/schemas/ComparePoliciesPropsSectionDTO"},"groups":{"$ref":"#/components/schemas/ComparePoliciesPropsSectionDTO"},"topics":{"$ref":"#/components/schemas/ComparePoliciesPropsSectionDTO"},"tokens":{"$ref":"#/components/schemas/ComparePoliciesPropsSectionDTO"},"tools":{"$ref":"#/components/schemas/ComparePoliciesPropsSectionDTO"}},"required":["size","left","rights","totals","blocks","roles","groups","topics","tokens","tools"]},"ComparePoliciesItemDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"instanceTopicId":{"type":"string","nullable":true},"version":{"type":"string"},"type":{"type":"string"}},"required":["id","name","description","type"]},"ComparePoliciesBlocksSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"description":"Rows may include additional dynamic fields in multi-compare mode","type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesBlocksReportRowDTO"}}},"required":["columns","report"]},"ComparePoliciesColumnDTO":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"display":{"type":"string"}},"required":["name","label","type"]},"ComparePoliciesBlocksReportRowDTO":{"type":"object","properties":{"lvl":{"type":"number"},"type":{"type":"string"},"block_type":{"type":"string"},"left_index":{"type":"number"},"left_type":{"type":"string"},"left_tag":{"type":"string"},"right_index":{"type":"number"},"right_type":{"type":"string"},"right_tag":{"type":"string"},"index_rate":{"type":"string"},"permission_rate":{"type":"string"},"prop_rate":{"type":"string"},"event_rate":{"type":"string"},"artifacts_rate":{"type":"string"},"total_rate":{"type":"string"},"left":{"$ref":"#/components/schemas/ComparePoliciesBlockSideDTO"},"right":{"$ref":"#/components/schemas/ComparePoliciesBlockSideDTO"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"artifacts":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"size":{"type":"number","description":"Present in merged multi-compare report rows"}}},"ComparePoliciesBlockSideDTO":{"type":"object","properties":{"index":{"type":"number"},"blockType":{"type":"string"},"tag":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesPropertyValueDTO"}},"events":{"description":"Block events payloads","type":"array","items":{"type":"object"}}},"required":["index","blockType","tag","properties","events"]},"ComparePoliciesPropertyValueDTO":{"type":"object","properties":{"name":{"type":"string"},"lvl":{"type":"number"},"path":{"type":"string"},"type":{"type":"string"},"value":{"type":"object","description":"Arbitrary property value"}},"required":["name","lvl","path","type","value"]},"ComparePoliciesRateEntryDTO":{"type":"object","properties":{"type":{"type":"string"},"totalRate":{"type":"number"},"items":{"description":"Pair of compared values, can include null","type":"array","items":{"type":"object"}},"name":{"type":"string"},"path":{"type":"string"},"lvl":{"type":"number"}},"required":["type","totalRate","items"]},"ComparePoliciesPropsSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"description":"Rows may include additional dynamic fields in multi-compare mode","type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesPropsReportRowDTO"}}},"required":["columns","report"]},"ComparePoliciesPropsReportRowDTO":{"type":"object","properties":{"left_name":{"type":"string"},"right_name":{"type":"string"},"total_rate":{"type":"string"},"left":{"type":"object"},"right":{"type":"object"},"type":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"size":{"type":"number","description":"Present in merged multi-compare report rows"}}}}}} ``` ## The CompareFileDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareFileDTO":{"type":"object","properties":{"id":{"type":"string","description":"File ID"},"name":{"type":"string","description":"File Name"},"value":{"type":"string","description":"Buffer"}},"required":["id","name","value"]}}}} ``` ## The FilterPolicyDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"FilterPolicyDTO":{"type":"object","properties":{"type":{"type":"string","description":"Identifier type","enum":["id","message","file"]},"value":{"oneOf":[{"type":"string","description":"Policy ID"},{"type":"string","description":"Policy Message ID"},{"$ref":"#/components/schemas/CompareFileDTO","description":"Policy File"}]}},"required":["type","value"]},"CompareFileDTO":{"type":"object","properties":{"id":{"type":"string","description":"File ID"},"name":{"type":"string","description":"File Name"},"value":{"type":"string","description":"Buffer"}},"required":["id","name","value"]}}}} ``` ## The FilterPoliciesDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"FilterPoliciesDTO":{"type":"object","properties":{"idLvl":{"oneOf":[{"type":"string","enum":["0","1"]},{"type":"number","enum":[0,1]}]},"eventsLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"propLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"childrenLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"policyId1":{"type":"string"},"policyId2":{"type":"string"},"policyIds":{"type":"array","items":{"type":"string"}},"policies":{"type":"array","items":{"$ref":"#/components/schemas/FilterPolicyDTO"}}}},"FilterPolicyDTO":{"type":"object","properties":{"type":{"type":"string","description":"Identifier type","enum":["id","message","file"]},"value":{"oneOf":[{"type":"string","description":"Policy ID"},{"type":"string","description":"Policy Message ID"},{"$ref":"#/components/schemas/CompareFileDTO","description":"Policy File"}]}},"required":["type","value"]},"CompareFileDTO":{"type":"object","properties":{"id":{"type":"string","description":"File ID"},"name":{"type":"string","description":"File Name"},"value":{"type":"string","description":"Buffer"}},"required":["id","name","value"]}}}} ``` ## The CompareOriginalPolicyFilterDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareOriginalPolicyFilterDTO":{"type":"object","properties":{"idLvl":{"oneOf":[{"type":"string","enum":["0","1"]},{"type":"number","enum":[0,1]}]},"eventsLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"propLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"childrenLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]}}}}}} ``` ## The FilterModulesDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"FilterModulesDTO":{"type":"object","properties":{"idLvl":{"oneOf":[{"type":"string","enum":["0","1"]},{"type":"number","enum":[0,1]}]},"eventsLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"propLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"childrenLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"moduleId1":{"type":"string"},"moduleId2":{"type":"string"}},"required":["moduleId1","moduleId2"]}}}} ``` ## The CompareModulesItemDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareModulesItemDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}},"required":["id","name","description"]}}}} ``` ## The CompareModulesSectionDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareModulesSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"type":"array","items":{"type":"object"}}},"required":["columns","report"]},"ComparePoliciesColumnDTO":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"display":{"type":"string"}},"required":["name","label","type"]}}}} ``` ## The CompareModulesDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareModulesDTO":{"type":"object","properties":{"left":{"$ref":"#/components/schemas/CompareModulesItemDTO"},"right":{"$ref":"#/components/schemas/CompareModulesItemDTO"},"total":{"type":"number"},"blocks":{"$ref":"#/components/schemas/CompareModulesSectionDTO"},"inputEvents":{"$ref":"#/components/schemas/CompareModulesSectionDTO"},"outputEvents":{"$ref":"#/components/schemas/CompareModulesSectionDTO"},"variables":{"$ref":"#/components/schemas/CompareModulesSectionDTO"}},"required":["left","right","total","blocks","inputEvents","outputEvents","variables"]},"CompareModulesItemDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"}},"required":["id","name","description"]},"CompareModulesSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"type":"array","items":{"type":"object"}}},"required":["columns","report"]},"ComparePoliciesColumnDTO":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"display":{"type":"string"}},"required":["name","label","type"]}}}} ``` ## The CompareSchemasByIdsRequestDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareSchemasByIdsRequestDTO":{"type":"object","properties":{"schemaId1":{"type":"string"},"schemaId2":{"type":"string"},"idLvl":{"oneOf":[{"type":"string","enum":["0","1"]},{"type":"number","enum":[0,1]}]}},"required":["schemaId1","schemaId2"]}}}} ``` ## The FilterSchemaDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"FilterSchemaDTO":{"type":"object","properties":{"type":{"type":"string","description":"Identifier type","enum":["id","policy-message","policy-file"]},"value":{"type":"string","description":"Schema ID"},"policy":{"oneOf":[{"description":"Policy Message ID","type":"string"},{"$ref":"#/components/schemas/CompareFileDTO","description":"Policy File"}]}},"required":["type","value"]},"CompareFileDTO":{"type":"object","properties":{"id":{"type":"string","description":"File ID"},"name":{"type":"string","description":"File Name"},"value":{"type":"string","description":"Buffer"}},"required":["id","name","value"]}}}} ``` ## The CompareSchemasByListRequestDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareSchemasByListRequestDTO":{"type":"object","properties":{"schemas":{"type":"array","items":{"$ref":"#/components/schemas/FilterSchemaDTO"}},"idLvl":{"oneOf":[{"type":"string","enum":["0","1"]},{"type":"number","enum":[0,1]}]}},"required":["schemas"]},"FilterSchemaDTO":{"type":"object","properties":{"type":{"type":"string","description":"Identifier type","enum":["id","policy-message","policy-file"]},"value":{"type":"string","description":"Schema ID"},"policy":{"oneOf":[{"description":"Policy Message ID","type":"string"},{"$ref":"#/components/schemas/CompareFileDTO","description":"Policy File"}]}},"required":["type","value"]},"CompareFileDTO":{"type":"object","properties":{"id":{"type":"string","description":"File ID"},"name":{"type":"string","description":"File Name"},"value":{"type":"string","description":"Buffer"}},"required":["id","name","value"]}}}} ``` ## The CompareSchemasItemDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareSchemasItemDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"uuid":{"type":"string"},"topicId":{"type":"string","nullable":true},"version":{"type":"string"},"iri":{"type":"string"},"policy":{"type":"object"}},"required":["id","name","description","uuid","version","iri"]}}}} ``` ## The CompareSchemasSectionDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareSchemasSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"type":"array","items":{"type":"object"}}},"required":["columns","report"]},"ComparePoliciesColumnDTO":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"display":{"type":"string"}},"required":["name","label","type"]}}}} ``` ## The CompareSchemasDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareSchemasDTO":{"type":"object","properties":{"left":{"$ref":"#/components/schemas/CompareSchemasItemDTO"},"right":{"$ref":"#/components/schemas/CompareSchemasItemDTO"},"total":{"type":"number"},"fields":{"$ref":"#/components/schemas/CompareSchemasSectionDTO"}},"required":["left","right","total","fields"]},"CompareSchemasItemDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"uuid":{"type":"string"},"topicId":{"type":"string","nullable":true},"version":{"type":"string"},"iri":{"type":"string"},"policy":{"type":"object"}},"required":["id","name","description","uuid","version","iri"]},"CompareSchemasSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"type":"array","items":{"type":"object"}}},"required":["columns","report"]},"ComparePoliciesColumnDTO":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"display":{"type":"string"}},"required":["name","label","type"]}}}} ``` ## The CompareDocumentsByIdsRequestDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareDocumentsByIdsRequestDTO":{"type":"object","properties":{"idLvl":{"oneOf":[{"type":"string","enum":["0","1"]},{"type":"number","enum":[0,1]}]},"eventsLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"propLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"childrenLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"documentId1":{"type":"string"},"documentId2":{"type":"string"}},"required":["documentId1","documentId2"]}}}} ``` ## The CompareDocumentsByListRequestDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareDocumentsByListRequestDTO":{"type":"object","properties":{"idLvl":{"oneOf":[{"type":"string","enum":["0","1"]},{"type":"number","enum":[0,1]}]},"eventsLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"propLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"childrenLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"documentIds":{"type":"array","items":{"type":"string"}}},"required":["documentIds"]}}}} ``` ## The CompareDocumentItemDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareDocumentItemDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"owner":{"type":"string"},"policy":{"type":"string","nullable":true}},"required":["id","type","owner"]}}}} ``` ## The CompareDocumentsSectionDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareDocumentsSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"type":"array","items":{"type":"object"}}},"required":["columns","report"]},"ComparePoliciesColumnDTO":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"display":{"type":"string"}},"required":["name","label","type"]}}}} ``` ## The CompareDocumentsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareDocumentsDTO":{"type":"object","properties":{"left":{"$ref":"#/components/schemas/CompareDocumentItemDTO"},"right":{"$ref":"#/components/schemas/CompareDocumentItemDTO"},"total":{"type":"number"},"documents":{"$ref":"#/components/schemas/CompareDocumentsSectionDTO"}},"required":["left","right","total","documents"]},"CompareDocumentItemDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"owner":{"type":"string"},"policy":{"type":"string","nullable":true}},"required":["id","type","owner"]},"CompareDocumentsSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"type":"array","items":{"type":"object"}}},"required":["columns","report"]},"ComparePoliciesColumnDTO":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"display":{"type":"string"}},"required":["name","label","type"]}}}} ``` ## The CompareDocumentsMultiDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareDocumentsMultiDTO":{"type":"object","properties":{"size":{"type":"number"},"left":{"$ref":"#/components/schemas/CompareDocumentItemDTO"},"rights":{"type":"array","items":{"$ref":"#/components/schemas/CompareDocumentItemDTO"}},"totals":{"type":"array","items":{"type":"number"}},"documents":{"$ref":"#/components/schemas/CompareDocumentsSectionDTO"}},"required":["size","left","rights","totals","documents"]},"CompareDocumentItemDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"owner":{"type":"string"},"policy":{"type":"string","nullable":true}},"required":["id","type","owner"]},"CompareDocumentsSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"type":"array","items":{"type":"object"}}},"required":["columns","report"]},"ComparePoliciesColumnDTO":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"display":{"type":"string"}},"required":["name","label","type"]}}}} ``` ## The CompareToolsByIdsRequestDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareToolsByIdsRequestDTO":{"type":"object","properties":{"idLvl":{"oneOf":[{"type":"string","enum":["0","1"]},{"type":"number","enum":[0,1]}]},"eventsLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"propLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"childrenLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"toolId1":{"type":"string"},"toolId2":{"type":"string"}},"required":["toolId1","toolId2"]}}}} ``` ## The CompareToolsByListRequestDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareToolsByListRequestDTO":{"type":"object","properties":{"idLvl":{"oneOf":[{"type":"string","enum":["0","1"]},{"type":"number","enum":[0,1]}]},"eventsLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"propLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"childrenLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"toolIds":{"type":"array","items":{"type":"string"}}},"required":["toolIds"]}}}} ``` ## The CompareToolItemDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareToolItemDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"hash":{"type":"string","nullable":true},"messageId":{"type":"string","nullable":true}},"required":["id","name"]}}}} ``` ## The CompareToolsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareToolsDTO":{"type":"object","properties":{"left":{"$ref":"#/components/schemas/CompareToolItemDTO"},"right":{"$ref":"#/components/schemas/CompareToolItemDTO"},"total":{"type":"number"},"blocks":{"$ref":"#/components/schemas/ComparePoliciesBlocksSectionDTO"},"inputEvents":{"$ref":"#/components/schemas/ComparePoliciesPropsSectionDTO"},"outputEvents":{"$ref":"#/components/schemas/ComparePoliciesPropsSectionDTO"},"variables":{"$ref":"#/components/schemas/ComparePoliciesPropsSectionDTO"}},"required":["left","right","total","blocks","inputEvents","outputEvents","variables"]},"CompareToolItemDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"hash":{"type":"string","nullable":true},"messageId":{"type":"string","nullable":true}},"required":["id","name"]},"ComparePoliciesBlocksSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"description":"Rows may include additional dynamic fields in multi-compare mode","type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesBlocksReportRowDTO"}}},"required":["columns","report"]},"ComparePoliciesColumnDTO":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"display":{"type":"string"}},"required":["name","label","type"]},"ComparePoliciesBlocksReportRowDTO":{"type":"object","properties":{"lvl":{"type":"number"},"type":{"type":"string"},"block_type":{"type":"string"},"left_index":{"type":"number"},"left_type":{"type":"string"},"left_tag":{"type":"string"},"right_index":{"type":"number"},"right_type":{"type":"string"},"right_tag":{"type":"string"},"index_rate":{"type":"string"},"permission_rate":{"type":"string"},"prop_rate":{"type":"string"},"event_rate":{"type":"string"},"artifacts_rate":{"type":"string"},"total_rate":{"type":"string"},"left":{"$ref":"#/components/schemas/ComparePoliciesBlockSideDTO"},"right":{"$ref":"#/components/schemas/ComparePoliciesBlockSideDTO"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"artifacts":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"size":{"type":"number","description":"Present in merged multi-compare report rows"}}},"ComparePoliciesBlockSideDTO":{"type":"object","properties":{"index":{"type":"number"},"blockType":{"type":"string"},"tag":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesPropertyValueDTO"}},"events":{"description":"Block events payloads","type":"array","items":{"type":"object"}}},"required":["index","blockType","tag","properties","events"]},"ComparePoliciesPropertyValueDTO":{"type":"object","properties":{"name":{"type":"string"},"lvl":{"type":"number"},"path":{"type":"string"},"type":{"type":"string"},"value":{"type":"object","description":"Arbitrary property value"}},"required":["name","lvl","path","type","value"]},"ComparePoliciesRateEntryDTO":{"type":"object","properties":{"type":{"type":"string"},"totalRate":{"type":"number"},"items":{"description":"Pair of compared values, can include null","type":"array","items":{"type":"object"}},"name":{"type":"string"},"path":{"type":"string"},"lvl":{"type":"number"}},"required":["type","totalRate","items"]},"ComparePoliciesPropsSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"description":"Rows may include additional dynamic fields in multi-compare mode","type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesPropsReportRowDTO"}}},"required":["columns","report"]},"ComparePoliciesPropsReportRowDTO":{"type":"object","properties":{"left_name":{"type":"string"},"right_name":{"type":"string"},"total_rate":{"type":"string"},"left":{"type":"object"},"right":{"type":"object"},"type":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"size":{"type":"number","description":"Present in merged multi-compare report rows"}}}}}} ``` ## The CompareToolsMultiDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareToolsMultiDTO":{"type":"object","properties":{"size":{"type":"number"},"left":{"$ref":"#/components/schemas/CompareToolItemDTO"},"rights":{"type":"array","items":{"$ref":"#/components/schemas/CompareToolItemDTO"}},"totals":{"type":"array","items":{"type":"number"}},"blocks":{"$ref":"#/components/schemas/ComparePoliciesBlocksSectionDTO"},"inputEvents":{"$ref":"#/components/schemas/ComparePoliciesPropsSectionDTO"},"outputEvents":{"$ref":"#/components/schemas/ComparePoliciesPropsSectionDTO"},"variables":{"$ref":"#/components/schemas/ComparePoliciesPropsSectionDTO"}},"required":["size","left","rights","totals","blocks","inputEvents","outputEvents","variables"]},"CompareToolItemDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"hash":{"type":"string","nullable":true},"messageId":{"type":"string","nullable":true}},"required":["id","name"]},"ComparePoliciesBlocksSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"description":"Rows may include additional dynamic fields in multi-compare mode","type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesBlocksReportRowDTO"}}},"required":["columns","report"]},"ComparePoliciesColumnDTO":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"display":{"type":"string"}},"required":["name","label","type"]},"ComparePoliciesBlocksReportRowDTO":{"type":"object","properties":{"lvl":{"type":"number"},"type":{"type":"string"},"block_type":{"type":"string"},"left_index":{"type":"number"},"left_type":{"type":"string"},"left_tag":{"type":"string"},"right_index":{"type":"number"},"right_type":{"type":"string"},"right_tag":{"type":"string"},"index_rate":{"type":"string"},"permission_rate":{"type":"string"},"prop_rate":{"type":"string"},"event_rate":{"type":"string"},"artifacts_rate":{"type":"string"},"total_rate":{"type":"string"},"left":{"$ref":"#/components/schemas/ComparePoliciesBlockSideDTO"},"right":{"$ref":"#/components/schemas/ComparePoliciesBlockSideDTO"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"permissions":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"artifacts":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"size":{"type":"number","description":"Present in merged multi-compare report rows"}}},"ComparePoliciesBlockSideDTO":{"type":"object","properties":{"index":{"type":"number"},"blockType":{"type":"string"},"tag":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesPropertyValueDTO"}},"events":{"description":"Block events payloads","type":"array","items":{"type":"object"}}},"required":["index","blockType","tag","properties","events"]},"ComparePoliciesPropertyValueDTO":{"type":"object","properties":{"name":{"type":"string"},"lvl":{"type":"number"},"path":{"type":"string"},"type":{"type":"string"},"value":{"type":"object","description":"Arbitrary property value"}},"required":["name","lvl","path","type","value"]},"ComparePoliciesRateEntryDTO":{"type":"object","properties":{"type":{"type":"string"},"totalRate":{"type":"number"},"items":{"description":"Pair of compared values, can include null","type":"array","items":{"type":"object"}},"name":{"type":"string"},"path":{"type":"string"},"lvl":{"type":"number"}},"required":["type","totalRate","items"]},"ComparePoliciesPropsSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"description":"Rows may include additional dynamic fields in multi-compare mode","type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesPropsReportRowDTO"}}},"required":["columns","report"]},"ComparePoliciesPropsReportRowDTO":{"type":"object","properties":{"left_name":{"type":"string"},"right_name":{"type":"string"},"total_rate":{"type":"string"},"left":{"type":"object"},"right":{"type":"object"},"type":{"type":"string"},"properties":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesRateEntryDTO"}},"size":{"type":"number","description":"Present in merged multi-compare report rows"}}}}}} ``` ## The FilterSearchBlocksDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"FilterSearchBlocksDTO":{"type":"object","properties":{"id":{"type":"string"},"config":{"type":"object","description":"Root block config to search for similar blocks in published policies.","additionalProperties":true,"properties":{"id":{"type":"string"},"blockType":{"type":"string"},"uiMetaData":{"type":"object","additionalProperties":true},"permissions":{"type":"array","items":{"type":"string"}},"defaultActive":{"type":"boolean"},"onErrorAction":{"type":"string"},"tag":{"type":"string"},"children":{"type":"array","items":{"type":"object","additionalProperties":true}},"events":{"type":"array","items":{"type":"object","additionalProperties":true}},"artifacts":{"type":"array","items":{"type":"object","additionalProperties":true}}}}},"required":["id","config"]}}}} ``` ## The SearchBlocksNodeDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SearchBlocksNodeDTO":{"type":"object","properties":{"id":{"type":"string"},"tag":{"type":"string"},"blockType":{"type":"string"},"config":{"type":"object","description":"Original block config (free-form object)","additionalProperties":true},"path":{"type":"array","items":{"type":"number"}}},"required":["id","tag","blockType","config","path"]}}}} ``` ## The SearchBlocksPairDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SearchBlocksPairDTO":{"type":"object","properties":{"hash":{"type":"number"},"source":{"$ref":"#/components/schemas/SearchBlocksNodeDTO"},"filter":{"$ref":"#/components/schemas/SearchBlocksNodeDTO"}},"required":["hash","source","filter"]},"SearchBlocksNodeDTO":{"type":"object","properties":{"id":{"type":"string"},"tag":{"type":"string"},"blockType":{"type":"string"},"config":{"type":"object","description":"Original block config (free-form object)","additionalProperties":true},"path":{"type":"array","items":{"type":"number"}}},"required":["id","tag","blockType","config","path"]}}}} ``` ## The SearchBlocksChainDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SearchBlocksChainDTO":{"type":"object","properties":{"hash":{"type":"number"},"target":{"$ref":"#/components/schemas/SearchBlocksNodeDTO"},"pairs":{"type":"array","items":{"$ref":"#/components/schemas/SearchBlocksPairDTO"}}},"required":["hash","target","pairs"]},"SearchBlocksNodeDTO":{"type":"object","properties":{"id":{"type":"string"},"tag":{"type":"string"},"blockType":{"type":"string"},"config":{"type":"object","description":"Original block config (free-form object)","additionalProperties":true},"path":{"type":"array","items":{"type":"number"}}},"required":["id","tag","blockType","config","path"]},"SearchBlocksPairDTO":{"type":"object","properties":{"hash":{"type":"number"},"source":{"$ref":"#/components/schemas/SearchBlocksNodeDTO"},"filter":{"$ref":"#/components/schemas/SearchBlocksNodeDTO"}},"required":["hash","source","filter"]}}}} ``` ## The SearchBlocksDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SearchBlocksDTO":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"messageId":{"type":"string"},"hash":{"type":"number"},"chains":{"type":"array","items":{"$ref":"#/components/schemas/SearchBlocksChainDTO"}}},"required":["name","description","version","owner","topicId","messageId","hash","chains"]},"SearchBlocksChainDTO":{"type":"object","properties":{"hash":{"type":"number"},"target":{"$ref":"#/components/schemas/SearchBlocksNodeDTO"},"pairs":{"type":"array","items":{"$ref":"#/components/schemas/SearchBlocksPairDTO"}}},"required":["hash","target","pairs"]},"SearchBlocksNodeDTO":{"type":"object","properties":{"id":{"type":"string"},"tag":{"type":"string"},"blockType":{"type":"string"},"config":{"type":"object","description":"Original block config (free-form object)","additionalProperties":true},"path":{"type":"array","items":{"type":"number"}}},"required":["id","tag","blockType","config","path"]},"SearchBlocksPairDTO":{"type":"object","properties":{"hash":{"type":"number"},"source":{"$ref":"#/components/schemas/SearchBlocksNodeDTO"},"filter":{"$ref":"#/components/schemas/SearchBlocksNodeDTO"}},"required":["hash","source","filter"]}}}} ``` ## The ArtifactDTOItem object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ArtifactDTOItem":{"type":"object","properties":{"createDate":{"type":"string"},"updateDate":{"type":"string"},"uuid":{"type":"string"},"policyId":{"type":"string"},"name":{"type":"string"},"type":{"type":"string","enum":["JSON","Executable Code"]},"owner":{"type":"string"},"extention":{"type":"string"},"category":{"type":"string","enum":["policy","tool"]},"creator":{"type":"string"},"id":{"type":"string"}},"required":["createDate","updateDate","uuid","policyId","name","type","owner","extention","id"]}}}} ``` ## The UploadArtifactsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"UploadArtifactsDTO":{"type":"object","properties":{"artifacts":{"description":"Artifact files","type":"array","items":{"type":"string","format":"binary"}}},"required":["artifacts"]}}}} ``` ## The BadRequestErrorDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"BadRequestErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]}}}} ``` ## The UpsertFileResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"UpsertFileResponseDTO":{"type":"object","properties":{"fileId":{"type":"string","description":"File identifier"},"filename":{"type":"string","description":"Saved file name"},"contentType":{"type":"string","description":"Saved file content type"}},"required":["fileId","filename","contentType"]}}}} ``` ## The ContractDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ContractDTO":{"type":"object","properties":{"createDate":{"type":"string","format":"date-time","description":"Record creation time (from persistence layer)."},"updateDate":{"type":"string","format":"date-time","description":"Record last update time (from persistence layer)."},"id":{"type":"string"},"contractId":{"type":"string"},"description":{"type":"string"},"owner":{"type":"string"},"permissions":{"type":"number","description":"Bitmask of caller roles (values are additive): 1 = Owner, 2 = Admin, 4 = Manager (WIPE only), 8 = Wiper (WIPE v1.0.0 only). E.g. 3 = Owner+Admin (RETIRE), 7 = Owner+Admin+Manager (WIPE)."},"topicId":{"type":"string"},"type":{"type":"string","enum":["WIPE","RETIRE"]},"syncPoolsDate":{"format":"date-time","type":"string","description":"Last sync of retire pools (may be absent)."},"lastSyncEventTimeStamp":{"type":"string","description":"Hedera consensus timestamp string from last processed contract event."},"syncDisabled":{"type":"boolean","description":"When true, automatic sync is disabled for this contract."},"version":{"type":"string","description":"Deployed contract ABI / behavior version."},"wipeContractIds":{"description":"Legacy: linked WIPE contract Hedera ids (contract-level wiper). Often empty for `version` 1.0.1+; see `wipeTokenIds` instead.","type":"array","items":{"type":"string"}},"wipeTokenIds":{"description":"Token-level wiper allowlist (Hedera token ids). Typical for RETIRE contracts with `version` 1.0.1+; usually empty for WIPE contracts.","type":"array","items":{"type":"string"}}},"required":["createDate","updateDate","id","contractId","owner","permissions","topicId","type"]}}}} ``` ## The ContractConfigDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ContractConfigDTO":{"type":"object","properties":{"type":{"type":"string","enum":["WIPE","RETIRE"]},"description":{"type":"string"}},"required":["type","description"]}}}} ``` ## The ImportContractDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ImportContractDTO":{"type":"object","properties":{"contractId":{"type":"string","description":"Hedera contract identifier"},"description":{"type":"string","description":"Contract description"}},"required":["contractId"]}}}} ``` ## The WiperRequestDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"WiperRequestDTO":{"type":"object","properties":{"createDate":{"type":"string","format":"date-time","description":"Record creation time."},"updateDate":{"type":"string","format":"date-time","description":"Record last update time."},"contractId":{"type":"string"},"user":{"type":"string","description":"Hedera account id of the requester."},"token":{"type":"string","description":"Hedera token id."},"id":{"type":"string"}},"required":["createDate","updateDate","contractId","user","id"]}}}} ``` ## The RetireRequestDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RetireRequestDTO":{"type":"object","properties":{"id":{"type":"string"},"contractId":{"type":"string"},"tokens":{"type":"object","required":["token","count","serials","decimals","type","tokenSymbol"],"properties":{"token":{"type":"string"},"count":{"type":"number"},"serials":{"type":"array","items":{"type":"number"}},"decimals":{"type":"number"},"type":{"enum":["non-fungible","fungible"]},"tokenSymbol":{"type":"string"}}},"tokenIds":{"type":"array","items":{"type":"string"}},"user":{"type":"string"}},"required":["id","contractId","tokenIds","user"]}}}} ``` ## The RetirePoolDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RetirePoolDTO":{"type":"object","properties":{"createDate":{"type":"string","format":"date-time","description":"Record creation time."},"updateDate":{"type":"string","format":"date-time","description":"Record last update time."},"id":{"type":"string"},"contractId":{"type":"string"},"tokens":{"type":"object","required":["token","contract","count","decimals","type","tokenSymbol"],"properties":{"token":{"type":"string","description":"Hedera token id."},"contract":{"type":"string","description":"Wipe contract id."},"count":{"type":"number","description":"Token count in pool."},"decimals":{"type":"number","description":"Token decimals."},"type":{"type":"string","enum":["non-fungible","fungible"]},"tokenSymbol":{"type":"string","description":"Token symbol."}}},"tokenIds":{"description":"Token ids in pool.","type":"array","items":{"type":"string"}},"immediately":{"type":"boolean","description":"Retire immediately without approval."},"enabled":{"type":"boolean","description":"Pool is enabled."}},"required":["id","contractId","tokenIds","immediately","enabled"]}}}} ``` ## The RetirePoolTokenDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RetirePoolTokenDTO":{"type":"object","properties":{"token":{"type":"string"},"count":{"type":"number"}},"required":["token","count"]}}}} ``` ## The RetireRequestTokenFTDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RetireRequestTokenFTDTO":{"type":"object","properties":{"token":{"type":"string"},"count":{"type":"number"},"serials":{"description":"Use empty array for FT retire request.","type":"array","items":{"type":"number"}}},"required":["token","count","serials"]}}}} ``` ## The RetireRequestTokenNFTDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RetireRequestTokenNFTDTO":{"type":"object","properties":{"token":{"type":"string"},"count":{"type":"number","description":"Required; use `0` for NFT retire request."},"serials":{"description":"NFT serial numbers to retire.","type":"array","items":{"type":"number"}}},"required":["token","count","serials"]}}}} ``` ## The RetireVcTokenDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RetireVcTokenDTO":{"type":"object","properties":{"tokenId":{"type":"string","description":"Hedera token id"},"count":{"type":"number","description":"For FT: amount. For NFT: 0"},"serials":{"description":"For NFT: serial numbers. For FT: empty","type":"array","items":{"type":"number"}}},"required":["tokenId","count","serials"]}}}} ``` ## The RetireCredentialSubjectDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RetireCredentialSubjectDTO":{"type":"object","properties":{"id":{"type":"string","description":"Subject DID"},"user":{"type":"string","description":"User Hedera account id"},"contractId":{"type":"string","description":"Retire contract id"},"tokens":{"description":"Retired tokens","type":"array","items":{"$ref":"#/components/schemas/RetireVcTokenDTO"}},"type":{"type":"string"}},"required":["id","user","contractId","tokens","type"]},"RetireVcTokenDTO":{"type":"object","properties":{"tokenId":{"type":"string","description":"Hedera token id"},"count":{"type":"number","description":"For FT: amount. For NFT: 0"},"serials":{"description":"For NFT: serial numbers. For FT: empty","type":"array","items":{"type":"number"}}},"required":["tokenId","count","serials"]}}}} ``` ## The RetireVcProofDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RetireVcProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]}}}} ``` ## The RetireVcDocumentBodyDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RetireVcDocumentBodyDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"array","items":{"type":"string"}},"issuer":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"description":"Credential subjects","type":"array","items":{"$ref":"#/components/schemas/RetireCredentialSubjectDTO"}},"proof":{"$ref":"#/components/schemas/RetireVcProofDTO"}},"required":["id","type","issuer","issuanceDate","credentialSubject","proof"]},"RetireCredentialSubjectDTO":{"type":"object","properties":{"id":{"type":"string","description":"Subject DID"},"user":{"type":"string","description":"User Hedera account id"},"contractId":{"type":"string","description":"Retire contract id"},"tokens":{"description":"Retired tokens","type":"array","items":{"$ref":"#/components/schemas/RetireVcTokenDTO"}},"type":{"type":"string"}},"required":["id","user","contractId","tokens","type"]},"RetireVcTokenDTO":{"type":"object","properties":{"tokenId":{"type":"string","description":"Hedera token id"},"count":{"type":"number","description":"For FT: amount. For NFT: 0"},"serials":{"description":"For NFT: serial numbers. For FT: empty","type":"array","items":{"type":"number"}}},"required":["tokenId","count","serials"]},"RetireVcProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]}}}} ``` ## The RetireVcDocumentDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RetireVcDocumentDTO":{"type":"object","properties":{"createDate":{"type":"string","format":"date-time"},"updateDate":{"type":"string","format":"date-time"},"hash":{"type":"string"},"hederaStatus":{"type":"string","description":"Hedera document status"},"signature":{"type":"number"},"type":{"type":"string"},"option":{"type":"object"},"owner":{"type":"string"},"document":{"description":"VerifiableCredential with credentialSubject (user, contractId, tokens)","allOf":[{"$ref":"#/components/schemas/RetireVcDocumentBodyDTO"}]},"documentFileId":{"type":"string"},"documentFields":{"type":"array","items":{"type":"string"}},"tableFileIds":{"type":"array","items":{"type":"string"}},"id":{"type":"string"}},"required":["createDate","updateDate","hash","hederaStatus","signature","type","option","owner","document","documentFileId","documentFields","tableFileIds","id"]},"RetireVcDocumentBodyDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"array","items":{"type":"string"}},"issuer":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"description":"Credential subjects","type":"array","items":{"$ref":"#/components/schemas/RetireCredentialSubjectDTO"}},"proof":{"$ref":"#/components/schemas/RetireVcProofDTO"}},"required":["id","type","issuer","issuanceDate","credentialSubject","proof"]},"RetireCredentialSubjectDTO":{"type":"object","properties":{"id":{"type":"string","description":"Subject DID"},"user":{"type":"string","description":"User Hedera account id"},"contractId":{"type":"string","description":"Retire contract id"},"tokens":{"description":"Retired tokens","type":"array","items":{"$ref":"#/components/schemas/RetireVcTokenDTO"}},"type":{"type":"string"}},"required":["id","user","contractId","tokens","type"]},"RetireVcTokenDTO":{"type":"object","properties":{"tokenId":{"type":"string","description":"Hedera token id"},"count":{"type":"number","description":"For FT: amount. For NFT: 0"},"serials":{"description":"For NFT: serial numbers. For FT: empty","type":"array","items":{"type":"number"}}},"required":["tokenId","count","serials"]},"RetireVcProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]}}}} ``` ## The RetireVcIndexerDocumentDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RetireVcIndexerDocumentDTO":{"type":"object","properties":{"id":{"type":"string"},"lastUpdate":{"type":"number"},"topicId":{"type":"string","description":"Contract topic id"},"consensusTimestamp":{"type":"string"},"owner":{"type":"string"},"uuid":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"action":{"type":"string"},"lang":{"type":"string"},"responseType":{"type":"string"},"options":{"type":"object"},"analytics":{"type":"object"},"analyticsUpdate":{"type":"number"},"coordUpdate":{"type":"number"},"files":{"type":"array","items":{"type":"string"}},"documents":{"description":"Retire VC documents with credentialSubject (user, contractId, tokens)","type":"array","items":{"$ref":"#/components/schemas/RetireVcDocumentBodyDTO"}},"topics":{"type":"array","items":{"type":"string"}},"tokens":{"type":"array","items":{"type":"string"}},"sequenceNumber":{"type":"number"},"loaded":{"type":"boolean"}},"required":["id","lastUpdate","topicId","consensusTimestamp","owner","uuid","status","type","action","lang","responseType","options","analytics","analyticsUpdate","coordUpdate","files","documents","topics","tokens","sequenceNumber","loaded"]},"RetireVcDocumentBodyDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"array","items":{"type":"string"}},"issuer":{"type":"string"},"issuanceDate":{"type":"string"},"credentialSubject":{"description":"Credential subjects","type":"array","items":{"$ref":"#/components/schemas/RetireCredentialSubjectDTO"}},"proof":{"$ref":"#/components/schemas/RetireVcProofDTO"}},"required":["id","type","issuer","issuanceDate","credentialSubject","proof"]},"RetireCredentialSubjectDTO":{"type":"object","properties":{"id":{"type":"string","description":"Subject DID"},"user":{"type":"string","description":"User Hedera account id"},"contractId":{"type":"string","description":"Retire contract id"},"tokens":{"description":"Retired tokens","type":"array","items":{"$ref":"#/components/schemas/RetireVcTokenDTO"}},"type":{"type":"string"}},"required":["id","user","contractId","tokens","type"]},"RetireVcTokenDTO":{"type":"object","properties":{"tokenId":{"type":"string","description":"Hedera token id"},"count":{"type":"number","description":"For FT: amount. For NFT: 0"},"serials":{"description":"For NFT: serial numbers. For FT: empty","type":"array","items":{"type":"number"}}},"required":["tokenId","count","serials"]},"RetireVcProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]}}}} ``` ## The PolicyRoleDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyRoleDTO":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"role":{"type":"string"}},"required":["name","version","role"]}}}} ``` ## The RegisteredUserDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RegisteredUserDTO":{"type":"object","properties":{"did":{"type":"string"},"username":{"type":"string"},"role":{"type":"string"},"policyRoles":{"default":[],"type":"array","items":{"$ref":"#/components/schemas/PolicyRoleDTO"}},"parent":{"type":"string","description":"Parent DID for child users"}},"required":["did","username","role","policyRoles"]},"PolicyRoleDTO":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"role":{"type":"string"}},"required":["name","version","role"]}}}} ``` ## The DemoKeyResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"DemoKeyResponseDTO":{"type":"object","properties":{"id":{"type":"string","description":"Demo account ID"},"key":{"type":"string","description":"Demo account private key"}},"required":["id","key"]}}}} ``` ## The DemoTaskResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"DemoTaskResponseDTO":{"type":"object","properties":{"taskId":{"type":"string","description":"Task ID"},"expectation":{"type":"number","description":"Expected count of task phases"},"action":{"type":"string","description":"Task action"},"userId":{"type":"string","description":"User ID"}},"required":["taskId","expectation","action","userId"]}}}} ``` ## The ExternalDocumentDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ExternalDocumentDTO":{"type":"object","properties":{"owner":{"type":"string"},"policyTag":{"type":"string"},"document":{"nullable":false,"allOf":[{"$ref":"#/components/schemas/VcDTO"}]}},"required":["owner","policyTag","document"]},"VcDTO":{"type":"object","properties":{"id":{"type":"string","nullable":true},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"credentialSubject":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"issuer":{"oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]},"issuanceDate":{"type":"string"},"proof":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ProofDTO"}]}},"required":["id","@context","type","credentialSubject","issuer","issuanceDate","proof"]},"ProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]}}}} ``` ## The BlockDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"BlockDTO":{"type":"object","properties":{"id":{"type":"string"},"blockType":{"type":"string"},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/BlockDTO"}}},"required":["id","blockType","blocks"]}}}} ``` ## The ResponseDTOWithSyncEvents object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ResponseDTOWithSyncEvents":{"type":"object","properties":{"response":{"type":"object","nullable":true,"additionalProperties":true},"result":{"type":"object","nullable":true,"additionalProperties":true},"steps":{"additionalProperties":true,"type":"array","items":{"type":"object"}}},"required":["response","result","steps"]}}}} ``` ## The NotFoundErrorDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"NotFoundErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}}} ``` ## The LogItemDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"LogItemDTO":{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string","enum":["INFO","WARN","ERROR"]},"datetime":{"type":"string","format":"date-time"},"attributes":{"type":"array","items":{"type":"string"}},"userId":{"type":"string","nullable":true},"id":{"type":"string"}},"required":["message","type","datetime","attributes","userId","id"]}}}} ``` ## The LogFilterDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"LogFilterDTO":{"type":"object","properties":{"type":{"type":"string","enum":["INFO","WARN","ERROR"],"nullable":true,"description":"Log severity filter. When empty, all logs are returned."},"startDate":{"type":"string","format":"date-time","nullable":true},"endDate":{"type":"string","format":"date-time","nullable":true},"attributes":{"nullable":true,"type":"array","items":{"type":"string"}},"message":{"type":"string","nullable":true},"pageSize":{"type":"number","nullable":true},"pageIndex":{"type":"number","nullable":true},"sortDirection":{"type":"string","enum":["asc","desc"],"nullable":true,"description":"Sort order"}},"required":["type","startDate","endDate","attributes","message","pageSize","pageIndex","sortDirection"]}}}} ``` ## The LogResultDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"LogResultDTO":{"type":"object","properties":{"totalCount":{"type":"number"},"logs":{"type":"array","items":{"$ref":"#/components/schemas/LogItemDTO"}}},"required":["totalCount","logs"]},"LogItemDTO":{"type":"object","properties":{"message":{"type":"string"},"type":{"type":"string","enum":["INFO","WARN","ERROR"]},"datetime":{"type":"string","format":"date-time"},"attributes":{"type":"array","items":{"type":"string"}},"userId":{"type":"string","nullable":true},"id":{"type":"string"}},"required":["message","type","datetime","attributes","userId","id"]}}}} ``` ## The SeqUrlResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SeqUrlResponseDTO":{"type":"object","properties":{"seq_url":{"type":"string","nullable":true,"description":"SEQ UI URL"}},"required":["seq_url"]}}}} ``` ## The ModuleDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ModuleDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"uuid":{"type":"string","nullable":false},"type":{"type":"string","nullable":true},"name":{"type":"string","nullable":false},"description":{"type":"string","nullable":false},"status":{"type":"string","nullable":false},"creator":{"type":"string","nullable":false},"owner":{"type":"string","nullable":false},"topicId":{"type":"string","nullable":true},"messageId":{"type":"string","nullable":true},"codeVersion":{"type":"string","nullable":false},"createDate":{"type":"string","nullable":false},"updateDate":{"type":"string","nullable":true},"configFileId":{"type":"string","nullable":true},"contentFileId":{"type":"string","nullable":true},"menu":{"type":"string","nullable":true},"config":{"type":"object","additionalProperties":true,"nullable":true}},"required":["id","uuid","name","description","status","creator","owner","codeVersion","createDate","config"]}}}} ``` ## The SchemaDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SchemaDTO":{"type":"object","properties":{"createDate":{"type":"string","nullable":true},"updateDate":{"type":"string","nullable":true},"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"entity":{"type":"string","enum":["NONE","VC","EVC","STANDARD_REGISTRY","USER","POLICY","MINT_TOKEN","INTEGRATION_DATA_V2","RETIRE","WIPE_TOKEN","MINT_NFTOKEN","ISSUER","USER_ROLE","CHUNK","ACTIVITY_IMPACT","TOKEN_DATA_SOURCE","ROLE","USER_PERMISSIONS","POLICY_DISCUSSION_V2","POLICY_COMMENT","POLICY_EXPORT_PROOF","EVIDENCE_ATTACHMENTS"]},"iri":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","UNPUBLISHED","ERROR","DEMO","VIEW"]},"topicId":{"type":"string"},"version":{"type":"string"},"creator":{"type":"string","nullable":true},"owner":{"type":"string"},"messageId":{"type":"string","nullable":true},"category":{"type":"string","enum":["POLICY","MODULE","SYSTEM","TAG","TOOL","STATISTIC","LABEL"]},"documentURL":{"type":"string"},"contextURL":{"type":"string"},"document":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"context":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"readonly":{"type":"boolean","nullable":true},"system":{"type":"boolean","nullable":true},"active":{"type":"boolean","nullable":true},"codeVersion":{"type":"string","nullable":true},"topicCount":{"type":"number","nullable":true}},"required":["id","uuid","name","description","entity","iri","status","topicId","version","owner","category","documentURL","contextURL","document","context"]}}}} ``` ## The ExportMessageDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ExportMessageDTO":{"type":"object","properties":{"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"messageId":{"type":"string"},"owner":{"type":"string"}},"required":["uuid","name","description","messageId","owner"]}}}} ``` ## The ImportMessageDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ImportMessageDTO":{"type":"object","properties":{"messageId":{"type":"string","description":"Hedera topic message id"},"metadata":{"type":"object","additionalProperties":true,"nullable":true}},"required":["messageId","metadata"]}}}} ``` ## The ModulePreviewDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ModulePreviewDTO":{"type":"object","properties":{"module":{"nullable":false,"allOf":[{"$ref":"#/components/schemas/ModuleDTO"}]},"messageId":{"type":"string"},"schemas":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"tags":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"moduleTopicId":{"type":"string","nullable":true}},"required":["module","messageId","schemas","tags","moduleTopicId"]},"ModuleDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"uuid":{"type":"string","nullable":false},"type":{"type":"string","nullable":true},"name":{"type":"string","nullable":false},"description":{"type":"string","nullable":false},"status":{"type":"string","nullable":false},"creator":{"type":"string","nullable":false},"owner":{"type":"string","nullable":false},"topicId":{"type":"string","nullable":true},"messageId":{"type":"string","nullable":true},"codeVersion":{"type":"string","nullable":false},"createDate":{"type":"string","nullable":false},"updateDate":{"type":"string","nullable":true},"configFileId":{"type":"string","nullable":true},"contentFileId":{"type":"string","nullable":true},"menu":{"type":"string","nullable":true},"config":{"type":"object","additionalProperties":true,"nullable":true}},"required":["id","uuid","name","description","status","creator","owner","codeVersion","createDate","config"]}}}} ``` ## The ModuleImportFileResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ModuleImportFileResponseDTO":{"type":"object","properties":{"module":{"nullable":false,"allOf":[{"$ref":"#/components/schemas/ModuleDTO"}]},"schemas":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"tags":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}}},"required":["module","schemas","tags"]},"ModuleDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"uuid":{"type":"string","nullable":false},"type":{"type":"string","nullable":true},"name":{"type":"string","nullable":false},"description":{"type":"string","nullable":false},"status":{"type":"string","nullable":false},"creator":{"type":"string","nullable":false},"owner":{"type":"string","nullable":false},"topicId":{"type":"string","nullable":true},"messageId":{"type":"string","nullable":true},"codeVersion":{"type":"string","nullable":false},"createDate":{"type":"string","nullable":false},"updateDate":{"type":"string","nullable":true},"configFileId":{"type":"string","nullable":true},"contentFileId":{"type":"string","nullable":true},"menu":{"type":"string","nullable":true},"config":{"type":"object","additionalProperties":true,"nullable":true}},"required":["id","uuid","name","description","status","creator","owner","codeVersion","createDate","config"]}}}} ``` ## The BlockErrorsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"BlockErrorsDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"isValid":{"type":"boolean"}},"required":["id","name","errors","isValid"]}}}} ``` ## The ValidationErrorsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ValidationErrorsDTO":{"type":"object","properties":{"blocks":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/BlockErrorsDTO"}},"errors":{"nullable":true,"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"Config block ID (for tool validation)"},"tools":{"type":"array","items":{"type":"object"},"description":"Tool-level errors (for tool validation)"},"isValid":{"type":"boolean","description":"Overall validation result (for tool validation)"}},"required":["blocks","errors","tools","isValid"]},"BlockErrorsDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"isValid":{"type":"boolean"}},"required":["id","name","errors","isValid"]}}}} ``` ## The ModulePublishResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ModulePublishResponseDTO":{"type":"object","properties":{"module":{"nullable":false,"allOf":[{"$ref":"#/components/schemas/ModuleDTO"}]},"isValid":{"type":"boolean","description":"Whether validation passed and the module was published"},"errors":{"nullable":false,"description":"Validation details used during publish","allOf":[{"$ref":"#/components/schemas/ValidationErrorsDTO"}]}},"required":["module","isValid","errors"]},"ModuleDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"uuid":{"type":"string","nullable":false},"type":{"type":"string","nullable":true},"name":{"type":"string","nullable":false},"description":{"type":"string","nullable":false},"status":{"type":"string","nullable":false},"creator":{"type":"string","nullable":false},"owner":{"type":"string","nullable":false},"topicId":{"type":"string","nullable":true},"messageId":{"type":"string","nullable":true},"codeVersion":{"type":"string","nullable":false},"createDate":{"type":"string","nullable":false},"updateDate":{"type":"string","nullable":true},"configFileId":{"type":"string","nullable":true},"contentFileId":{"type":"string","nullable":true},"menu":{"type":"string","nullable":true},"config":{"type":"object","additionalProperties":true,"nullable":true}},"required":["id","uuid","name","description","status","creator","owner","codeVersion","createDate","config"]},"ValidationErrorsDTO":{"type":"object","properties":{"blocks":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/BlockErrorsDTO"}},"errors":{"nullable":true,"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"Config block ID (for tool validation)"},"tools":{"type":"array","items":{"type":"object"},"description":"Tool-level errors (for tool validation)"},"isValid":{"type":"boolean","description":"Overall validation result (for tool validation)"}},"required":["blocks","errors","tools","isValid"]},"BlockErrorsDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"isValid":{"type":"boolean"}},"required":["id","name","errors","isValid"]}}}} ``` ## The ModuleValidationDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ModuleValidationDTO":{"type":"object","properties":{"module":{"nullable":false,"allOf":[{"$ref":"#/components/schemas/ModuleDTO"}]},"results":{"nullable":false,"allOf":[{"$ref":"#/components/schemas/ValidationErrorsDTO"}]}},"required":["module","results"]},"ModuleDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"uuid":{"type":"string","nullable":false},"type":{"type":"string","nullable":true},"name":{"type":"string","nullable":false},"description":{"type":"string","nullable":false},"status":{"type":"string","nullable":false},"creator":{"type":"string","nullable":false},"owner":{"type":"string","nullable":false},"topicId":{"type":"string","nullable":true},"messageId":{"type":"string","nullable":true},"codeVersion":{"type":"string","nullable":false},"createDate":{"type":"string","nullable":false},"updateDate":{"type":"string","nullable":true},"configFileId":{"type":"string","nullable":true},"contentFileId":{"type":"string","nullable":true},"menu":{"type":"string","nullable":true},"config":{"type":"object","additionalProperties":true,"nullable":true}},"required":["id","uuid","name","description","status","creator","owner","codeVersion","createDate","config"]},"ValidationErrorsDTO":{"type":"object","properties":{"blocks":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/BlockErrorsDTO"}},"errors":{"nullable":true,"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"Config block ID (for tool validation)"},"tools":{"type":"array","items":{"type":"object"},"description":"Tool-level errors (for tool validation)"},"isValid":{"type":"boolean","description":"Overall validation result (for tool validation)"}},"required":["blocks","errors","tools","isValid"]},"BlockErrorsDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"isValid":{"type":"boolean"}},"required":["id","name","errors","isValid"]}}}} ``` ## The CreateToolConfigDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CreateToolConfigDTO":{"type":"object","properties":{"id":{"type":"string","description":"Config block ID (UUID)"},"blockType":{"type":"string","enum":["tool"],"description":"Must be \"tool\""}},"required":["blockType"]}}}} ``` ## The CreateToolDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CreateToolDTO":{"type":"object","properties":{"name":{"type":"string","description":"Tool display name"},"description":{"type":"string","description":"Tool description"},"config":{"description":"Tool config. Must have blockType: \"tool\". May include id (UUID).","allOf":[{"$ref":"#/components/schemas/CreateToolConfigDTO"}]}},"required":["config"]},"CreateToolConfigDTO":{"type":"object","properties":{"id":{"type":"string","description":"Config block ID (UUID)"},"blockType":{"type":"string","enum":["tool"],"description":"Must be \"tool\""}},"required":["blockType"]}}}} ``` ## The ToolConfigResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ToolConfigResponseDTO":{"type":"object","properties":{"id":{"type":"string"},"blockType":{"type":"string","enum":["tool"]},"permissions":{"type":"array","items":{"type":"object"}},"children":{"type":"array","items":{"type":"object"}},"events":{"type":"array","items":{"type":"object"}},"artifacts":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"inputEvents":{"type":"array","items":{"type":"object"}},"outputEvents":{"type":"array","items":{"type":"object"}},"innerEvents":{"type":"array","items":{"type":"object"}},"tag":{"type":"string"}},"required":["id","blockType"]}}}} ``` ## The ToolDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ToolDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","PUBLISH_ERROR"]},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"messageId":{"type":"string","nullable":true,"description":"Message ID (for PUBLISHED tools only; omitted or null for DRAFT)"},"codeVersion":{"type":"string"},"createDate":{"type":"string"},"updateDate":{"type":"string","description":"Last update date"},"configFileId":{"type":"string","description":"Config file ID (internal)"},"tagsTopicId":{"type":"string","description":"Tags topic ID (for PUBLISHED tools only)"},"contentFileId":{"type":"string","description":"File id of the original tool zip (imported from IPFS or publish flow). Present for PUBLISHED tools."},"hash":{"type":"string","description":"Hash (for PUBLISHED tools only)"},"tools":{"type":"array","items":{"type":"object"},"description":"Referenced sub-tools: { name, version?, topicId, messageId }"},"config":{"$ref":"#/components/schemas/ToolConfigResponseDTO"},"version":{"type":"string","nullable":true,"description":"Published tool version (e.g. 1.0.0); null or omitted when not published"}},"required":["id","uuid","name","description","status","creator","owner","topicId","codeVersion","createDate","updateDate","configFileId","tools","config"]},"ToolConfigResponseDTO":{"type":"object","properties":{"id":{"type":"string"},"blockType":{"type":"string","enum":["tool"]},"permissions":{"type":"array","items":{"type":"object"}},"children":{"type":"array","items":{"type":"object"}},"events":{"type":"array","items":{"type":"object"}},"artifacts":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"inputEvents":{"type":"array","items":{"type":"object"}},"outputEvents":{"type":"array","items":{"type":"object"}},"innerEvents":{"type":"array","items":{"type":"object"}},"tag":{"type":"string"}},"required":["id","blockType"]}}}} ``` ## The ToolListV2ItemDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ToolListV2ItemDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"status":{"type":"string","enum":["DRAFT","PUBLISHED","PUBLISH_ERROR"]},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"messageId":{"type":"string","nullable":true,"description":"Message ID (for PUBLISHED tools only)"}},"required":["id","name","description","status","creator","owner","topicId","messageId"]}}}} ``` ## The ToolVersionDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ToolVersionDTO":{"type":"object","properties":{"toolVersion":{"type":"string"}},"required":["toolVersion"]}}}} ``` ## The ToolPublishResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ToolPublishResponseDTO":{"type":"object","properties":{"tool":{"$ref":"#/components/schemas/ToolDTO"},"isValid":{"type":"boolean","description":"Whether validation passed (true = tool published successfully)"},"errors":{"description":"Validation errors and block-level results","allOf":[{"$ref":"#/components/schemas/ValidationErrorsDTO"}]}},"required":["tool","isValid","errors"]},"ToolDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","PUBLISH_ERROR"]},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"messageId":{"type":"string","nullable":true,"description":"Message ID (for PUBLISHED tools only; omitted or null for DRAFT)"},"codeVersion":{"type":"string"},"createDate":{"type":"string"},"updateDate":{"type":"string","description":"Last update date"},"configFileId":{"type":"string","description":"Config file ID (internal)"},"tagsTopicId":{"type":"string","description":"Tags topic ID (for PUBLISHED tools only)"},"contentFileId":{"type":"string","description":"File id of the original tool zip (imported from IPFS or publish flow). Present for PUBLISHED tools."},"hash":{"type":"string","description":"Hash (for PUBLISHED tools only)"},"tools":{"type":"array","items":{"type":"object"},"description":"Referenced sub-tools: { name, version?, topicId, messageId }"},"config":{"$ref":"#/components/schemas/ToolConfigResponseDTO"},"version":{"type":"string","nullable":true,"description":"Published tool version (e.g. 1.0.0); null or omitted when not published"}},"required":["id","uuid","name","description","status","creator","owner","topicId","codeVersion","createDate","updateDate","configFileId","tools","config"]},"ToolConfigResponseDTO":{"type":"object","properties":{"id":{"type":"string"},"blockType":{"type":"string","enum":["tool"]},"permissions":{"type":"array","items":{"type":"object"}},"children":{"type":"array","items":{"type":"object"}},"events":{"type":"array","items":{"type":"object"}},"artifacts":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"inputEvents":{"type":"array","items":{"type":"object"}},"outputEvents":{"type":"array","items":{"type":"object"}},"innerEvents":{"type":"array","items":{"type":"object"}},"tag":{"type":"string"}},"required":["id","blockType"]},"ValidationErrorsDTO":{"type":"object","properties":{"blocks":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/BlockErrorsDTO"}},"errors":{"nullable":true,"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"Config block ID (for tool validation)"},"tools":{"type":"array","items":{"type":"object"},"description":"Tool-level errors (for tool validation)"},"isValid":{"type":"boolean","description":"Overall validation result (for tool validation)"}},"required":["blocks","errors","tools","isValid"]},"BlockErrorsDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"isValid":{"type":"boolean"}},"required":["id","name","errors","isValid"]}}}} ``` ## The ToolDryRunResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ToolDryRunResponseDTO":{"type":"object","properties":{"isValid":{"type":"boolean","description":"Whether the tool config passed validation (true = dry run started; false = dry run not started)"},"errors":{"description":"Validation details (blocks, tools, common errors)","allOf":[{"$ref":"#/components/schemas/ValidationErrorsDTO"}]}},"required":["isValid","errors"]},"ValidationErrorsDTO":{"type":"object","properties":{"blocks":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/BlockErrorsDTO"}},"errors":{"nullable":true,"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"Config block ID (for tool validation)"},"tools":{"type":"array","items":{"type":"object"},"description":"Tool-level errors (for tool validation)"},"isValid":{"type":"boolean","description":"Overall validation result (for tool validation)"}},"required":["blocks","errors","tools","isValid"]},"BlockErrorsDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"isValid":{"type":"boolean"}},"required":["id","name","errors","isValid"]}}}} ``` ## The ToolValidationDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ToolValidationDTO":{"type":"object","properties":{"tool":{"$ref":"#/components/schemas/ToolDTO"},"results":{"$ref":"#/components/schemas/ValidationErrorsDTO"}},"required":["tool","results"]},"ToolDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","PUBLISH_ERROR"]},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"messageId":{"type":"string","nullable":true,"description":"Message ID (for PUBLISHED tools only; omitted or null for DRAFT)"},"codeVersion":{"type":"string"},"createDate":{"type":"string"},"updateDate":{"type":"string","description":"Last update date"},"configFileId":{"type":"string","description":"Config file ID (internal)"},"tagsTopicId":{"type":"string","description":"Tags topic ID (for PUBLISHED tools only)"},"contentFileId":{"type":"string","description":"File id of the original tool zip (imported from IPFS or publish flow). Present for PUBLISHED tools."},"hash":{"type":"string","description":"Hash (for PUBLISHED tools only)"},"tools":{"type":"array","items":{"type":"object"},"description":"Referenced sub-tools: { name, version?, topicId, messageId }"},"config":{"$ref":"#/components/schemas/ToolConfigResponseDTO"},"version":{"type":"string","nullable":true,"description":"Published tool version (e.g. 1.0.0); null or omitted when not published"}},"required":["id","uuid","name","description","status","creator","owner","topicId","codeVersion","createDate","updateDate","configFileId","tools","config"]},"ToolConfigResponseDTO":{"type":"object","properties":{"id":{"type":"string"},"blockType":{"type":"string","enum":["tool"]},"permissions":{"type":"array","items":{"type":"object"}},"children":{"type":"array","items":{"type":"object"}},"events":{"type":"array","items":{"type":"object"}},"artifacts":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"inputEvents":{"type":"array","items":{"type":"object"}},"outputEvents":{"type":"array","items":{"type":"object"}},"innerEvents":{"type":"array","items":{"type":"object"}},"tag":{"type":"string"}},"required":["id","blockType"]},"ValidationErrorsDTO":{"type":"object","properties":{"blocks":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/BlockErrorsDTO"}},"errors":{"nullable":true,"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"Config block ID (for tool validation)"},"tools":{"type":"array","items":{"type":"object"},"description":"Tool-level errors (for tool validation)"},"isValid":{"type":"boolean","description":"Overall validation result (for tool validation)"}},"required":["blocks","errors","tools","isValid"]},"BlockErrorsDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"isValid":{"type":"boolean"}},"required":["id","name","errors","isValid"]}}}} ``` ## The ToolExportMessageDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ToolExportMessageDTO":{"type":"object","properties":{"id":{"type":"string","description":"Tool ID (internal)"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"messageId":{"type":"string","nullable":true,"description":"Hedera topic message id when published; null for DRAFT / not yet published"},"owner":{"type":"string"}},"required":["id","uuid","name","description","messageId","owner"]}}}} ``` ## The ToolPreviewDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ToolPreviewDTO":{"type":"object","properties":{"tool":{"description":"Main tool object from `tool.json` in the IPFS archive. Shape is close to ToolDTO but may omit DB-only fields (id, uuid, status, topicId, messageId, etc.).","allOf":[{"$ref":"#/components/schemas/ToolDTO"}]},"schemas":{"additionalProperties":true,"description":"Schema entities parsed from `schemas/*` in the archive (full Schema objects with document, context, …)","type":"array","items":{"type":"object"}},"tags":{"additionalProperties":true,"description":"Tag entities parsed from `tags/*` in the archive","type":"array","items":{"type":"object"}},"tools":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Additional tool JSON files from `tools/*` in the archive (not the same as top-level `tool`)"},"messageId":{"type":"string","description":"Present only for `POST /tools/import/message/preview` — same as request `messageId`. Omitted for file-based preview."},"toolTopicId":{"type":"string","description":"Present only for message-based preview — topic id from the Hedera tool message. Omitted for file-based preview."}},"required":["tool","schemas","tags","tools"]},"ToolDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","PUBLISH_ERROR"]},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"messageId":{"type":"string","nullable":true,"description":"Message ID (for PUBLISHED tools only; omitted or null for DRAFT)"},"codeVersion":{"type":"string"},"createDate":{"type":"string"},"updateDate":{"type":"string","description":"Last update date"},"configFileId":{"type":"string","description":"Config file ID (internal)"},"tagsTopicId":{"type":"string","description":"Tags topic ID (for PUBLISHED tools only)"},"contentFileId":{"type":"string","description":"File id of the original tool zip (imported from IPFS or publish flow). Present for PUBLISHED tools."},"hash":{"type":"string","description":"Hash (for PUBLISHED tools only)"},"tools":{"type":"array","items":{"type":"object"},"description":"Referenced sub-tools: { name, version?, topicId, messageId }"},"config":{"$ref":"#/components/schemas/ToolConfigResponseDTO"},"version":{"type":"string","nullable":true,"description":"Published tool version (e.g. 1.0.0); null or omitted when not published"}},"required":["id","uuid","name","description","status","creator","owner","topicId","codeVersion","createDate","updateDate","configFileId","tools","config"]},"ToolConfigResponseDTO":{"type":"object","properties":{"id":{"type":"string"},"blockType":{"type":"string","enum":["tool"]},"permissions":{"type":"array","items":{"type":"object"}},"children":{"type":"array","items":{"type":"object"}},"events":{"type":"array","items":{"type":"object"}},"artifacts":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"inputEvents":{"type":"array","items":{"type":"object"}},"outputEvents":{"type":"array","items":{"type":"object"}},"innerEvents":{"type":"array","items":{"type":"object"}},"tag":{"type":"string"}},"required":["id","blockType"]}}}} ``` ## The ToolImportResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ToolImportResponseDTO":{"type":"object","properties":{"tool":{"description":"Imported tool entity.","allOf":[{"$ref":"#/components/schemas/ToolDTO"}]},"errors":{"type":"array","items":{"type":"object","additionalProperties":true},"description":"Import errors. Empty array means the import completed without reported errors."}},"required":["tool","errors"]},"ToolDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","PUBLISH_ERROR"]},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"messageId":{"type":"string","nullable":true,"description":"Message ID (for PUBLISHED tools only; omitted or null for DRAFT)"},"codeVersion":{"type":"string"},"createDate":{"type":"string"},"updateDate":{"type":"string","description":"Last update date"},"configFileId":{"type":"string","description":"Config file ID (internal)"},"tagsTopicId":{"type":"string","description":"Tags topic ID (for PUBLISHED tools only)"},"contentFileId":{"type":"string","description":"File id of the original tool zip (imported from IPFS or publish flow). Present for PUBLISHED tools."},"hash":{"type":"string","description":"Hash (for PUBLISHED tools only)"},"tools":{"type":"array","items":{"type":"object"},"description":"Referenced sub-tools: { name, version?, topicId, messageId }"},"config":{"$ref":"#/components/schemas/ToolConfigResponseDTO"},"version":{"type":"string","nullable":true,"description":"Published tool version (e.g. 1.0.0); null or omitted when not published"}},"required":["id","uuid","name","description","status","creator","owner","topicId","codeVersion","createDate","updateDate","configFileId","tools","config"]},"ToolConfigResponseDTO":{"type":"object","properties":{"id":{"type":"string"},"blockType":{"type":"string","enum":["tool"]},"permissions":{"type":"array","items":{"type":"object"}},"children":{"type":"array","items":{"type":"object"}},"events":{"type":"array","items":{"type":"object"}},"artifacts":{"type":"array","items":{"type":"object"}},"variables":{"type":"array","items":{"type":"object"}},"inputEvents":{"type":"array","items":{"type":"object"}},"outputEvents":{"type":"array","items":{"type":"object"}},"innerEvents":{"type":"array","items":{"type":"object"}},"tag":{"type":"string"}},"required":["id","blockType"]}}}} ``` ## The ToolMenuConfigItemDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ToolMenuConfigItemDTO":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"required":["name","description"]}}}} ``` ## The ToolMenuVariableDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ToolMenuVariableDTO":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"}},"required":["name","description","type"]}}}} ``` ## The ToolMenuConfigDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ToolMenuConfigDTO":{"type":"object","properties":{"inputEvents":{"description":"Tool input events exposed in the menu.","type":"array","items":{"$ref":"#/components/schemas/ToolMenuConfigItemDTO"}},"outputEvents":{"description":"Tool output events exposed in the menu.","type":"array","items":{"$ref":"#/components/schemas/ToolMenuConfigItemDTO"}},"variables":{"description":"Tool variables exposed in the menu.","type":"array","items":{"$ref":"#/components/schemas/ToolMenuVariableDTO"}}}},"ToolMenuConfigItemDTO":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"required":["name","description"]},"ToolMenuVariableDTO":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"}},"required":["name","description","type"]}}}} ``` ## The ToolMenuSchemaDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ToolMenuSchemaDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"topicId":{"type":"string"},"iri":{"type":"string"},"category":{"type":"string","description":"Schema category when present in the source response."}},"required":["id","name","description","topicId","iri"]}}}} ``` ## The ToolMenuSubToolDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ToolMenuSubToolDTO":{"type":"object","properties":{"name":{"type":"string","description":"Referenced sub-tool name."},"version":{"type":"string","nullable":true,"description":"Referenced sub-tool version when available."},"topicId":{"type":"string","description":"Referenced sub-tool topic id."},"messageId":{"type":"string","description":"Referenced sub-tool message id."}}}}}} ``` ## The ToolMenuItemDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ToolMenuItemDTO":{"type":"object","properties":{"id":{"type":"string"},"hash":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"messageId":{"type":"string"},"tools":{"description":"Referenced sub-tools from the tool config.","type":"array","items":{"$ref":"#/components/schemas/ToolMenuSubToolDTO"}},"config":{"description":"Reduced tool config returned by the menu endpoint.","allOf":[{"$ref":"#/components/schemas/ToolMenuConfigDTO"}]},"schemas":{"description":"Schemas linked to the tool topic.","type":"array","items":{"$ref":"#/components/schemas/ToolMenuSchemaDTO"}}},"required":["id","hash","name","description","owner","topicId","messageId","tools","config","schemas"]},"ToolMenuSubToolDTO":{"type":"object","properties":{"name":{"type":"string","description":"Referenced sub-tool name."},"version":{"type":"string","nullable":true,"description":"Referenced sub-tool version when available."},"topicId":{"type":"string","description":"Referenced sub-tool topic id."},"messageId":{"type":"string","description":"Referenced sub-tool message id."}}},"ToolMenuConfigDTO":{"type":"object","properties":{"inputEvents":{"description":"Tool input events exposed in the menu.","type":"array","items":{"$ref":"#/components/schemas/ToolMenuConfigItemDTO"}},"outputEvents":{"description":"Tool output events exposed in the menu.","type":"array","items":{"$ref":"#/components/schemas/ToolMenuConfigItemDTO"}},"variables":{"description":"Tool variables exposed in the menu.","type":"array","items":{"$ref":"#/components/schemas/ToolMenuVariableDTO"}}}},"ToolMenuConfigItemDTO":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"}},"required":["name","description"]},"ToolMenuVariableDTO":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"}},"required":["name","description","type"]},"ToolMenuSchemaDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"topicId":{"type":"string"},"iri":{"type":"string"},"category":{"type":"string","description":"Schema category when present in the source response."}},"required":["id","name","description","topicId","iri"]}}}} ``` ## The ProfileDidDocumentRecordDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ProfileDidDocumentRecordDTO":{"type":"object","properties":{"createDate":{"type":"string"},"updateDate":{"type":"string"},"did":{"type":"string"},"document":{"$ref":"#/components/schemas/DidDocumentDTO"},"status":{"type":"string"},"messageId":{"type":"string"},"topicId":{"type":"string"},"verificationMethods":{"type":"object","additionalProperties":{"type":"string"}},"id":{"type":"string"}},"required":["createDate","updateDate","did","document","status","messageId","topicId","verificationMethods","id"]},"DidDocumentDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"@context":{"nullable":true,"type":"array","items":{"type":"string"}},"alsoKnownAs":{"nullable":true,"type":"array","items":{"type":"string"}},"controller":{"nullable":true,"type":"array","items":{"type":"string"}},"verificationMethod":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"authentication":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"assertionMethod":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"keyAgreement":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"capabilityInvocation":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"capabilityDelegation":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"service":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}}},"required":["id","@context","alsoKnownAs","controller","verificationMethod","authentication","assertionMethod","keyAgreement","capabilityInvocation","capabilityDelegation","service"]}}}} ``` ## The ProfileVcDocumentDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ProfileVcDocumentDTO":{"type":"object","properties":{"id":{"type":"string"},"policyId":{"type":"string"},"hash":{"type":"string"},"signature":{"type":"number"},"status":{"type":"string","enum":["NEW","ISSUE","REVOKE","SUSPEND","RESUME","FAILED"]},"tag":{"type":"string"},"type":{"type":"string"},"createDate":{"type":"string"},"updateDate":{"type":"string"},"owner":{"type":"string"},"hederaStatus":{"type":"string"},"option":{"type":"object","additionalProperties":true},"topicId":{"type":"string"},"messageId":{"type":"string"},"document":{"$ref":"#/components/schemas/VcDTO"},"documentFileId":{"type":"string"},"tableFileIds":{"type":"array","items":{"type":"string"}}}},"VcDTO":{"type":"object","properties":{"id":{"type":"string","nullable":true},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"credentialSubject":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"issuer":{"oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]},"issuanceDate":{"type":"string"},"proof":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ProofDTO"}]}},"required":["id","@context","type","credentialSubject","issuer","issuanceDate","proof"]},"ProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]}}}} ``` ## The ProfileDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ProfileDTO":{"type":"object","properties":{"username":{"type":"string"},"role":{"type":"string","enum":["STANDARD_REGISTRY","USER","AUDITOR"]},"permissionsGroup":{"type":"array","items":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"did":{"type":"string"},"parent":{"type":"string"},"hederaAccountId":{"type":"string"},"confirmed":{"type":"boolean"},"failed":{"type":"boolean"},"topicId":{"type":"string"},"parentTopicId":{"type":"string"},"location":{"type":"string","enum":["local","remote","custom"],"description":"Whether the user account is local, remote, or custom."},"didDocument":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ProfileDidDocumentRecordDTO"}]},"vcDocument":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ProfileVcDocumentDTO"}]}},"required":["username","role","permissions","didDocument","vcDocument"]},"ProfileDidDocumentRecordDTO":{"type":"object","properties":{"createDate":{"type":"string"},"updateDate":{"type":"string"},"did":{"type":"string"},"document":{"$ref":"#/components/schemas/DidDocumentDTO"},"status":{"type":"string"},"messageId":{"type":"string"},"topicId":{"type":"string"},"verificationMethods":{"type":"object","additionalProperties":{"type":"string"}},"id":{"type":"string"}},"required":["createDate","updateDate","did","document","status","messageId","topicId","verificationMethods","id"]},"DidDocumentDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"@context":{"nullable":true,"type":"array","items":{"type":"string"}},"alsoKnownAs":{"nullable":true,"type":"array","items":{"type":"string"}},"controller":{"nullable":true,"type":"array","items":{"type":"string"}},"verificationMethod":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"authentication":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"assertionMethod":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"keyAgreement":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"capabilityInvocation":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"capabilityDelegation":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"service":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}}},"required":["id","@context","alsoKnownAs","controller","verificationMethod","authentication","assertionMethod","keyAgreement","capabilityInvocation","capabilityDelegation","service"]},"ProfileVcDocumentDTO":{"type":"object","properties":{"id":{"type":"string"},"policyId":{"type":"string"},"hash":{"type":"string"},"signature":{"type":"number"},"status":{"type":"string","enum":["NEW","ISSUE","REVOKE","SUSPEND","RESUME","FAILED"]},"tag":{"type":"string"},"type":{"type":"string"},"createDate":{"type":"string"},"updateDate":{"type":"string"},"owner":{"type":"string"},"hederaStatus":{"type":"string"},"option":{"type":"object","additionalProperties":true},"topicId":{"type":"string"},"messageId":{"type":"string"},"document":{"$ref":"#/components/schemas/VcDTO"},"documentFileId":{"type":"string"},"tableFileIds":{"type":"array","items":{"type":"string"}}}},"VcDTO":{"type":"object","properties":{"id":{"type":"string","nullable":true},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"credentialSubject":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"issuer":{"oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]},"issuanceDate":{"type":"string"},"proof":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ProofDTO"}]}},"required":["id","@context","type","credentialSubject","issuer","issuanceDate","proof"]},"ProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]}}}} ``` ## The CredentialsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CredentialsDTO":{"type":"object","properties":{"entity":{"type":"string","description":"Schema entity label; often inferred from the user role when omitted."},"topicId":{"type":"string","description":"Hedera topic id (e.g. restore / profile flows)."},"hederaAccountId":{"type":"string","nullable":false},"hederaAccountKey":{"type":"string","nullable":true,"description":"Hedera private key (local signing). May be omitted for some remote flows."},"parent":{"type":"string","nullable":true},"vcDocument":{"nullable":true,"description":"VC credential subject fields (e.g. OrganizationName, Website, Tags) for Standard Registry.","type":"object","allOf":[{"$ref":"#/components/schemas/SubjectDTO"}]},"didDocument":{"nullable":true,"description":"DID document to publish, or null to skip in this request.","type":"object","allOf":[{"$ref":"#/components/schemas/DidDocumentDTO"}]},"didKeys":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/DidKeyDTO"}},"useFireblocksSigning":{"type":"boolean"},"fireblocksConfig":{"$ref":"#/components/schemas/FireblocksConfigDTO"}},"required":["hederaAccountId"]},"SubjectDTO":{"type":"object","properties":{"@context":{"nullable":true,"type":"array","items":{"type":"string"}},"id":{"type":"string","nullable":true},"type":{"type":"string","nullable":true}},"required":["@context"]},"DidDocumentDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"@context":{"nullable":true,"type":"array","items":{"type":"string"}},"alsoKnownAs":{"nullable":true,"type":"array","items":{"type":"string"}},"controller":{"nullable":true,"type":"array","items":{"type":"string"}},"verificationMethod":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"authentication":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"assertionMethod":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"keyAgreement":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"capabilityInvocation":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"capabilityDelegation":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"service":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}}},"required":["id","@context","alsoKnownAs","controller","verificationMethod","authentication","assertionMethod","keyAgreement","capabilityInvocation","capabilityDelegation","service"]},"DidKeyDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"key":{"type":"string","nullable":false}},"required":["id","key"]},"FireblocksConfigDTO":{"type":"object","properties":{"fireBlocksVaultId":{"type":"string"},"fireBlocksAssetId":{"type":"string"},"fireBlocksApiKey":{"type":"string"},"fireBlocksPrivateiKey":{"type":"string","description":"API property name is `fireBlocksPrivateiKey` (typo preserved for compatibility)."}}}}}} ``` ## The DidVerificationMethodEntryDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"DidVerificationMethodEntryDTO":{"type":"object","properties":{"name":{"type":"string","description":"Fragment/name reference (e.g. `#did-root-key`)."},"id":{"type":"string","description":"Full verification method id URI."}},"required":["name","id"]}}}} ``` ## The DidDocumentStatusDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"DidDocumentStatusDTO":{"type":"object","properties":{"valid":{"type":"boolean","nullable":false},"error":{"type":"string","nullable":true,"description":"Error message when `valid` is false; empty string when valid."},"keys":{"type":"object","nullable":false,"description":"Verification methods grouped by key type (e.g. Ed25519VerificationKey2018, Bls12381G2Key2020). Matches runtime `keys` in the guardian response.","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/DidVerificationMethodEntryDTO"}}}},"required":["valid","error","keys"]},"DidVerificationMethodEntryDTO":{"type":"object","properties":{"name":{"type":"string","description":"Fragment/name reference (e.g. `#did-root-key`)."},"id":{"type":"string","description":"Full verification method id URI."}},"required":["name","id"]}}}} ``` ## The DidDocumentWithKeyDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"DidDocumentWithKeyDTO":{"type":"object","properties":{"document":{"nullable":false,"allOf":[{"$ref":"#/components/schemas/DidDocumentDTO"}]},"keys":{"nullable":false,"type":"array","items":{"$ref":"#/components/schemas/DidKeyDTO"}}},"required":["document","keys"]},"DidDocumentDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"@context":{"nullable":true,"type":"array","items":{"type":"string"}},"alsoKnownAs":{"nullable":true,"type":"array","items":{"type":"string"}},"controller":{"nullable":true,"type":"array","items":{"type":"string"}},"verificationMethod":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"authentication":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"assertionMethod":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"keyAgreement":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"capabilityInvocation":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"capabilityDelegation":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"service":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}}},"required":["id","@context","alsoKnownAs","controller","verificationMethod","authentication","assertionMethod","keyAgreement","capabilityInvocation","capabilityDelegation","service"]},"DidKeyDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"key":{"type":"string","nullable":false}},"required":["id","key"]}}}} ``` ## The DidKeyStatusDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"DidKeyStatusDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"key":{"type":"string","nullable":false},"valid":{"type":"boolean","nullable":false}},"required":["id","key","valid"]}}}} ``` ## The PolicyKeyDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyKeyDTO":{"type":"object","properties":{"id":{"type":"string","description":"Key ID"},"createDate":{"type":"string"},"updateDate":{"type":"string"},"messageId":{"type":"string","description":"Policy Message ID"},"owner":{"type":"string","description":"Key owner"},"policyName":{"type":"string"},"key":{"type":"string","description":"New key"}},"required":["id","createDate","updateDate","messageId","owner","policyName","key"]}}}} ``` ## The PolicyKeyConfigDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyKeyConfigDTO":{"type":"object","properties":{"messageId":{"type":"string","description":"Policy Message ID"},"key":{"type":"string","description":"DER-encoded private key when **importing** on the remote user account. Omit when **generating** for user flow (only `messageId`)."}},"required":["messageId","key"]}}}} ``` ## The BasePolicyDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"BasePolicyDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"]}}}} ``` ## The MigrationConfigPoliciesDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MigrationConfigPoliciesDTO":{"type":"object","properties":{"src":{"type":"string"},"dst":{"type":"string"}},"required":["src","dst"]}}}} ``` ## The MigrationConfigDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MigrationConfigDTO":{"type":"object","properties":{"policies":{"$ref":"#/components/schemas/MigrationConfigPoliciesDTO"},"vcs":{"type":"array","items":{"type":"string"}},"vps":{"type":"array","items":{"type":"string"}},"schemas":{"type":"object","additionalProperties":{"type":"string"}},"groups":{"type":"object","additionalProperties":{"type":"string"}},"roles":{"type":"object","additionalProperties":{"type":"string"}},"blocks":{"type":"object","additionalProperties":{"type":"string"}},"tokens":{"type":"object","additionalProperties":{"type":"string"}},"tokensMap":{"type":"object","additionalProperties":{"type":"string"}},"migrateState":{"type":"boolean"},"migrateRetirePools":{"type":"boolean"},"editedVCs":{"type":"object","additionalProperties":{"type":"string"}},"retireContractId":{"type":"string"},"mode":{"type":"string","enum":["start_new","resume","retry_failed"],"default":"start_new"},"runId":{"type":"string"}},"required":["policies","vcs","vps","schemas","groups","roles","blocks","tokens","tokensMap","migrateState","migrateRetirePools","editedVCs","retireContractId"]},"MigrationConfigPoliciesDTO":{"type":"object","properties":{"src":{"type":"string"},"dst":{"type":"string"}},"required":["src","dst"]}}}} ``` ## The MigrationFailedItemDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MigrationFailedItemDTO":{"type":"object","properties":{"srcPolicyId":{"type":"string"},"dstPolicyId":{"type":"string"},"entityType":{"type":"string"},"srcEntityId":{"type":"string"},"runId":{"type":"string"},"attemptCount":{"type":"number"},"errorCode":{"type":"string","nullable":true},"errorMessage":{"type":"string","nullable":true},"firstFailedAt":{"type":"string","format":"date-time"},"lastFailedAt":{"type":"string","format":"date-time"}},"required":["srcPolicyId","dstPolicyId","entityType","srcEntityId","runId","attemptCount","errorCode","errorMessage","firstFailedAt","lastFailedAt"]}}}} ``` ## The MigrationRunStatusDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MigrationRunStatusDTO":{"type":"object","properties":{"runId":{"type":"string"},"srcPolicyId":{"type":"string"},"dstPolicyId":{"type":"string"},"status":{"type":"string","enum":["running","completed","failed","stopped"]},"isDryRun":{"type":"boolean"},"startedAt":{"type":"string","format":"date-time","nullable":true},"finishedAt":{"type":"string","format":"date-time","nullable":true},"summary":{"type":"object","additionalProperties":true},"failedItems":{"type":"array","items":{"$ref":"#/components/schemas/MigrationFailedItemDTO"}}},"required":["runId","srcPolicyId","dstPolicyId","status","startedAt","finishedAt","summary"]},"MigrationFailedItemDTO":{"type":"object","properties":{"srcPolicyId":{"type":"string"},"dstPolicyId":{"type":"string"},"entityType":{"type":"string"},"srcEntityId":{"type":"string"},"runId":{"type":"string"},"attemptCount":{"type":"number"},"errorCode":{"type":"string","nullable":true},"errorMessage":{"type":"string","nullable":true},"firstFailedAt":{"type":"string","format":"date-time"},"lastFailedAt":{"type":"string","format":"date-time"}},"required":["srcPolicyId","dstPolicyId","entityType","srcEntityId","runId","attemptCount","errorCode","errorMessage","firstFailedAt","lastFailedAt"]}}}} ``` ## The MigrationStatusResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MigrationStatusResponseDTO":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MigrationRunStatusDTO"}}},"required":["items"]},"MigrationRunStatusDTO":{"type":"object","properties":{"runId":{"type":"string"},"srcPolicyId":{"type":"string"},"dstPolicyId":{"type":"string"},"status":{"type":"string","enum":["running","completed","failed","stopped"]},"isDryRun":{"type":"boolean"},"startedAt":{"type":"string","format":"date-time","nullable":true},"finishedAt":{"type":"string","format":"date-time","nullable":true},"summary":{"type":"object","additionalProperties":true},"failedItems":{"type":"array","items":{"$ref":"#/components/schemas/MigrationFailedItemDTO"}}},"required":["runId","srcPolicyId","dstPolicyId","status","startedAt","finishedAt","summary"]},"MigrationFailedItemDTO":{"type":"object","properties":{"srcPolicyId":{"type":"string"},"dstPolicyId":{"type":"string"},"entityType":{"type":"string"},"srcEntityId":{"type":"string"},"runId":{"type":"string"},"attemptCount":{"type":"number"},"errorCode":{"type":"string","nullable":true},"errorMessage":{"type":"string","nullable":true},"firstFailedAt":{"type":"string","format":"date-time"},"lastFailedAt":{"type":"string","format":"date-time"}},"required":["srcPolicyId","dstPolicyId","entityType","srcEntityId","runId","attemptCount","errorCode","errorMessage","firstFailedAt","lastFailedAt"]}}}} ``` ## The MigrationRunsResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MigrationRunsResponseDTO":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/MigrationRunStatusDTO"}},"count":{"type":"number"},"pageIndex":{"type":"number"},"pageSize":{"type":"number"}},"required":["items","count","pageIndex","pageSize"]},"MigrationRunStatusDTO":{"type":"object","properties":{"runId":{"type":"string"},"srcPolicyId":{"type":"string"},"dstPolicyId":{"type":"string"},"status":{"type":"string","enum":["running","completed","failed","stopped"]},"isDryRun":{"type":"boolean"},"startedAt":{"type":"string","format":"date-time","nullable":true},"finishedAt":{"type":"string","format":"date-time","nullable":true},"summary":{"type":"object","additionalProperties":true},"failedItems":{"type":"array","items":{"$ref":"#/components/schemas/MigrationFailedItemDTO"}}},"required":["runId","srcPolicyId","dstPolicyId","status","startedAt","finishedAt","summary"]},"MigrationFailedItemDTO":{"type":"object","properties":{"srcPolicyId":{"type":"string"},"dstPolicyId":{"type":"string"},"entityType":{"type":"string"},"srcEntityId":{"type":"string"},"runId":{"type":"string"},"attemptCount":{"type":"number"},"errorCode":{"type":"string","nullable":true},"errorMessage":{"type":"string","nullable":true},"firstFailedAt":{"type":"string","format":"date-time"},"lastFailedAt":{"type":"string","format":"date-time"}},"required":["srcPolicyId","dstPolicyId","entityType","srcEntityId","runId","attemptCount","errorCode","errorMessage","firstFailedAt","lastFailedAt"]}}}} ``` ## The PoliciesValidationDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PoliciesValidationDTO":{"type":"object","properties":{"policies":{"type":"array","items":{"$ref":"#/components/schemas/PolicyDTO"}},"isValid":{"type":"string"},"errors":{"$ref":"#/components/schemas/ValidationErrorsDTO"}},"required":["policies","isValid","errors"]},"PolicyDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"topicDescription":{"type":"string"},"applicabilityConditions":{"type":"string"},"detailsUrl":{"type":"string"},"typicalProjects":{"type":"string"},"importantParameters":{"$ref":"#/components/schemas/PolicyImportantParametersDTO"},"policyTag":{"type":"string"},"status":{"type":"string","enum":["DRY-RUN","DRAFT","PUBLISH_ERROR","PUBLISH","DISCONTINUED","DEMO","VIEW"]},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"instanceTopicId":{"type":"string"},"messageId":{"type":"string"},"availability":{"type":"string","enum":["private","public"]},"codeVersion":{"type":"string"},"tools":{"type":"array","items":{"$ref":"#/components/schemas/PolicyToolDTO"}},"createDate":{"type":"string"},"version":{"type":"string"},"originalChanged":{"type":"string"},"editableParametersSettings":{"type":"array","items":{"$ref":"#/components/schemas/PolicyEditableFieldDTO"}},"config":{"type":"object","additionalProperties":true},"userRole":{"type":"string"},"userRoles":{"type":"array","items":{"type":"string"}},"userGroup":{"type":"object","additionalProperties":true,"nullable":true,"description":"Last active group in iteration order (not a separate summary). Often shown via groupLabel or uuid."},"userGroups":{"additionalProperties":true,"description":"Full list of group rows for this user in the policy (getGroupsByUser), including inactive.","type":"array","items":{"type":"object"}},"policyRoles":{"type":"array","items":{"type":"string"}},"policyNavigation":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTopics":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTokens":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyGroups":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyDocumentation":{"additionalProperties":true,"description":"User-configured policy API documentation entries. The `alias` may be a single slug (`create-device`) or a path of slugs separated by `/` (`monitoring-reports/create`).","type":"array","items":{"type":"object"}},"categories":{"type":"array","items":{"type":"string"}},"projectSchema":{"type":"string"},"tests":{"type":"array","items":{"$ref":"#/components/schemas/PolicyTestDTO"}},"ignoreRules":{"description":"Validation-only rules to hide matching warnings/infos (not persisted)","type":"array","items":{"$ref":"#/components/schemas/IgnoreRuleDTO"}}},"required":["id","uuid","name","description","topicDescription","policyTag","status","creator","owner","topicId","instanceTopicId","messageId","codeVersion","tools","createDate","version","editableParametersSettings","config","userRole","userRoles","userGroup","userGroups","policyRoles","policyNavigation","policyTopics","policyTokens","policyGroups","policyDocumentation","categories","projectSchema","tests"]},"PolicyImportantParametersDTO":{"type":"object","properties":{"atValidation":{"type":"string"},"monitored":{"type":"string"}}},"PolicyToolDTO":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string","nullable":true},"topicId":{"type":"string"},"messageId":{"type":"string"}},"required":["name","topicId","messageId"]},"PolicyEditableFieldDTO":{"type":"object","properties":{}},"PolicyTestDTO":{"type":"object","properties":{"id":{"type":"string","description":"Test ID"},"uuid":{"type":"string","description":"Test UUID"},"name":{"type":"string","description":"Test Name"},"policyId":{"type":"string","description":"Policy ID"},"owner":{"type":"string","description":"Test owner"},"status":{"type":"string","description":"Test status","enum":["New","Running","Stopped","Success","Failure"]},"date":{"type":"string","description":"Last start date"},"duration":{"type":"string","description":"Test duration"},"progress":{"type":"string","description":"Test progress"},"resultId":{"type":"string","description":"Test result"},"result":{"type":"string","description":"Test result"}},"required":["id","uuid","name","policyId","owner","status","date","duration","progress","resultId","result"]},"IgnoreRuleDTO":{"type":"object","properties":{"code":{"type":"string","description":"Stable message code, e.g. DEPRECATION_BLOCK"},"blockType":{"type":"string","description":"Limit by block type"},"property":{"type":"string","description":"Limit by property"},"contains":{"type":"string","description":"Substring filter applied to message text"},"severity":{"type":"string","description":"Type of message","enum":["warning","info"]}}},"ValidationErrorsDTO":{"type":"object","properties":{"blocks":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/BlockErrorsDTO"}},"errors":{"nullable":true,"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"Config block ID (for tool validation)"},"tools":{"type":"array","items":{"type":"object"},"description":"Tool-level errors (for tool validation)"},"isValid":{"type":"boolean","description":"Overall validation result (for tool validation)"}},"required":["blocks","errors","tools","isValid"]},"BlockErrorsDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"isValid":{"type":"boolean"}},"required":["id","name","errors","isValid"]}}}} ``` ## The PolicyVersionDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyVersionDTO":{"type":"object","properties":{"policyVersion":{"type":"string"},"policyAvailability":{"type":"string","enum":["private","public"]},"recordingEnabled":{"type":"boolean","description":"Record policy actions"}},"required":["policyVersion"]}}}} ``` ## The Object object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"Object":{"type":"object","properties":{}}}}} ``` ## The PolicyValidationDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyValidationDTO":{"type":"object","properties":{"policy":{"$ref":"#/components/schemas/PolicyDTO"},"results":{"$ref":"#/components/schemas/ValidationErrorsDTO"}},"required":["policy","results"]},"PolicyDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"topicDescription":{"type":"string"},"applicabilityConditions":{"type":"string"},"detailsUrl":{"type":"string"},"typicalProjects":{"type":"string"},"importantParameters":{"$ref":"#/components/schemas/PolicyImportantParametersDTO"},"policyTag":{"type":"string"},"status":{"type":"string","enum":["DRY-RUN","DRAFT","PUBLISH_ERROR","PUBLISH","DISCONTINUED","DEMO","VIEW"]},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"instanceTopicId":{"type":"string"},"messageId":{"type":"string"},"availability":{"type":"string","enum":["private","public"]},"codeVersion":{"type":"string"},"tools":{"type":"array","items":{"$ref":"#/components/schemas/PolicyToolDTO"}},"createDate":{"type":"string"},"version":{"type":"string"},"originalChanged":{"type":"string"},"editableParametersSettings":{"type":"array","items":{"$ref":"#/components/schemas/PolicyEditableFieldDTO"}},"config":{"type":"object","additionalProperties":true},"userRole":{"type":"string"},"userRoles":{"type":"array","items":{"type":"string"}},"userGroup":{"type":"object","additionalProperties":true,"nullable":true,"description":"Last active group in iteration order (not a separate summary). Often shown via groupLabel or uuid."},"userGroups":{"additionalProperties":true,"description":"Full list of group rows for this user in the policy (getGroupsByUser), including inactive.","type":"array","items":{"type":"object"}},"policyRoles":{"type":"array","items":{"type":"string"}},"policyNavigation":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTopics":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTokens":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyGroups":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyDocumentation":{"additionalProperties":true,"description":"User-configured policy API documentation entries. The `alias` may be a single slug (`create-device`) or a path of slugs separated by `/` (`monitoring-reports/create`).","type":"array","items":{"type":"object"}},"categories":{"type":"array","items":{"type":"string"}},"projectSchema":{"type":"string"},"tests":{"type":"array","items":{"$ref":"#/components/schemas/PolicyTestDTO"}},"ignoreRules":{"description":"Validation-only rules to hide matching warnings/infos (not persisted)","type":"array","items":{"$ref":"#/components/schemas/IgnoreRuleDTO"}}},"required":["id","uuid","name","description","topicDescription","policyTag","status","creator","owner","topicId","instanceTopicId","messageId","codeVersion","tools","createDate","version","editableParametersSettings","config","userRole","userRoles","userGroup","userGroups","policyRoles","policyNavigation","policyTopics","policyTokens","policyGroups","policyDocumentation","categories","projectSchema","tests"]},"PolicyImportantParametersDTO":{"type":"object","properties":{"atValidation":{"type":"string"},"monitored":{"type":"string"}}},"PolicyToolDTO":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string","nullable":true},"topicId":{"type":"string"},"messageId":{"type":"string"}},"required":["name","topicId","messageId"]},"PolicyEditableFieldDTO":{"type":"object","properties":{}},"PolicyTestDTO":{"type":"object","properties":{"id":{"type":"string","description":"Test ID"},"uuid":{"type":"string","description":"Test UUID"},"name":{"type":"string","description":"Test Name"},"policyId":{"type":"string","description":"Policy ID"},"owner":{"type":"string","description":"Test owner"},"status":{"type":"string","description":"Test status","enum":["New","Running","Stopped","Success","Failure"]},"date":{"type":"string","description":"Last start date"},"duration":{"type":"string","description":"Test duration"},"progress":{"type":"string","description":"Test progress"},"resultId":{"type":"string","description":"Test result"},"result":{"type":"string","description":"Test result"}},"required":["id","uuid","name","policyId","owner","status","date","duration","progress","resultId","result"]},"IgnoreRuleDTO":{"type":"object","properties":{"code":{"type":"string","description":"Stable message code, e.g. DEPRECATION_BLOCK"},"blockType":{"type":"string","description":"Limit by block type"},"property":{"type":"string","description":"Limit by property"},"contains":{"type":"string","description":"Substring filter applied to message text"},"severity":{"type":"string","description":"Type of message","enum":["warning","info"]}}},"ValidationErrorsDTO":{"type":"object","properties":{"blocks":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/BlockErrorsDTO"}},"errors":{"nullable":true,"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"id":{"type":"string","description":"Config block ID (for tool validation)"},"tools":{"type":"array","items":{"type":"object"},"description":"Tool-level errors (for tool validation)"},"isValid":{"type":"boolean","description":"Overall validation result (for tool validation)"}},"required":["blocks","errors","tools","isValid"]},"BlockErrorsDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"errors":{"type":"array","items":{"type":"string"}},"warnings":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"isValid":{"type":"boolean"}},"required":["id","name","errors","isValid"]}}}} ``` ## The ServiceUnavailableErrorDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ServiceUnavailableErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}}} ``` ## The PolicyPreviewDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyPreviewDTO":{"type":"object","properties":{"module":{"$ref":"#/components/schemas/PolicyDTO"},"messageId":{"type":"string"},"schemas":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"tags":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"moduleTopicId":{"type":"string"}},"required":["module","messageId","schemas","tags","moduleTopicId"]},"PolicyDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"topicDescription":{"type":"string"},"applicabilityConditions":{"type":"string"},"detailsUrl":{"type":"string"},"typicalProjects":{"type":"string"},"importantParameters":{"$ref":"#/components/schemas/PolicyImportantParametersDTO"},"policyTag":{"type":"string"},"status":{"type":"string","enum":["DRY-RUN","DRAFT","PUBLISH_ERROR","PUBLISH","DISCONTINUED","DEMO","VIEW"]},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"instanceTopicId":{"type":"string"},"messageId":{"type":"string"},"availability":{"type":"string","enum":["private","public"]},"codeVersion":{"type":"string"},"tools":{"type":"array","items":{"$ref":"#/components/schemas/PolicyToolDTO"}},"createDate":{"type":"string"},"version":{"type":"string"},"originalChanged":{"type":"string"},"editableParametersSettings":{"type":"array","items":{"$ref":"#/components/schemas/PolicyEditableFieldDTO"}},"config":{"type":"object","additionalProperties":true},"userRole":{"type":"string"},"userRoles":{"type":"array","items":{"type":"string"}},"userGroup":{"type":"object","additionalProperties":true,"nullable":true,"description":"Last active group in iteration order (not a separate summary). Often shown via groupLabel or uuid."},"userGroups":{"additionalProperties":true,"description":"Full list of group rows for this user in the policy (getGroupsByUser), including inactive.","type":"array","items":{"type":"object"}},"policyRoles":{"type":"array","items":{"type":"string"}},"policyNavigation":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTopics":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTokens":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyGroups":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyDocumentation":{"additionalProperties":true,"description":"User-configured policy API documentation entries. The `alias` may be a single slug (`create-device`) or a path of slugs separated by `/` (`monitoring-reports/create`).","type":"array","items":{"type":"object"}},"categories":{"type":"array","items":{"type":"string"}},"projectSchema":{"type":"string"},"tests":{"type":"array","items":{"$ref":"#/components/schemas/PolicyTestDTO"}},"ignoreRules":{"description":"Validation-only rules to hide matching warnings/infos (not persisted)","type":"array","items":{"$ref":"#/components/schemas/IgnoreRuleDTO"}}},"required":["id","uuid","name","description","topicDescription","policyTag","status","creator","owner","topicId","instanceTopicId","messageId","codeVersion","tools","createDate","version","editableParametersSettings","config","userRole","userRoles","userGroup","userGroups","policyRoles","policyNavigation","policyTopics","policyTokens","policyGroups","policyDocumentation","categories","projectSchema","tests"]},"PolicyImportantParametersDTO":{"type":"object","properties":{"atValidation":{"type":"string"},"monitored":{"type":"string"}}},"PolicyToolDTO":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string","nullable":true},"topicId":{"type":"string"},"messageId":{"type":"string"}},"required":["name","topicId","messageId"]},"PolicyEditableFieldDTO":{"type":"object","properties":{}},"PolicyTestDTO":{"type":"object","properties":{"id":{"type":"string","description":"Test ID"},"uuid":{"type":"string","description":"Test UUID"},"name":{"type":"string","description":"Test Name"},"policyId":{"type":"string","description":"Policy ID"},"owner":{"type":"string","description":"Test owner"},"status":{"type":"string","description":"Test status","enum":["New","Running","Stopped","Success","Failure"]},"date":{"type":"string","description":"Last start date"},"duration":{"type":"string","description":"Test duration"},"progress":{"type":"string","description":"Test progress"},"resultId":{"type":"string","description":"Test result"},"result":{"type":"string","description":"Test result"}},"required":["id","uuid","name","policyId","owner","status","date","duration","progress","resultId","result"]},"IgnoreRuleDTO":{"type":"object","properties":{"code":{"type":"string","description":"Stable message code, e.g. DEPRECATION_BLOCK"},"blockType":{"type":"string","description":"Limit by block type"},"property":{"type":"string","description":"Limit by property"},"contains":{"type":"string","description":"Substring filter applied to message text"},"severity":{"type":"string","description":"Type of message","enum":["warning","info"]}}}}}} ``` ## The DebugBlockDataDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"DebugBlockDataDTO":{"type":"object","properties":{"input":{"type":"string","description":"Input event"},"output":{"type":"string","description":"Output event"},"type":{"type":"string","description":"Document type","enum":["schema","json","file","history"]},"document":{"description":"Document","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}},"required":["input","output","type","document"]}}}} ``` ## The DebugBlockConfigDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"DebugBlockConfigDTO":{"type":"object","properties":{"block":{"type":"object","description":"Block config","additionalProperties":true},"data":{"description":"Input data","allOf":[{"$ref":"#/components/schemas/DebugBlockDataDTO"}]}},"required":["block","data"]},"DebugBlockDataDTO":{"type":"object","properties":{"input":{"type":"string","description":"Input event"},"output":{"type":"string","description":"Output event"},"type":{"type":"string","description":"Document type","enum":["schema","json","file","history"]},"document":{"description":"Document","oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]}},"required":["input","output","type","document"]}}}} ``` ## The DebugBlockResultDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"DebugBlockResultDTO":{"type":"object","properties":{"logs":{"description":"Logs","type":"array","items":{"type":"string"}},"errors":{"description":"Errors","type":"array","items":{"type":"string"}},"input":{"description":"Input documents","additionalProperties":true,"type":"array","items":{"type":"object"}},"output":{"description":"Output documents","additionalProperties":true,"type":"array","items":{"type":"object"}}},"required":["logs","errors","input","output"]}}}} ``` ## The DeleteSavepointsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"DeleteSavepointsDTO":{"type":"object","properties":{"savepointIds":{"type":"array","items":{"type":"string"}},"skipCurrentSavepointGuard":{"type":"boolean","description":"If `false`, and the policy has more than one savepoint, the current savepoint cannot be deleted. If `true`, that guard is bypassed (used by the UI for deleting all savepoints)."}},"required":["savepointIds"]}}}} ``` ## The DeleteSavepointsResultDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"DeleteSavepointsResultDTO":{"type":"object","properties":{"hardDeletedIds":{"type":"array","items":{"type":"string"}}},"required":["hardDeletedIds"]}}}} ``` ## The MockBlockConfigDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MockBlockConfigDTO":{"type":"object","properties":{"uuid":{"type":"string"},"enabled":{"type":"boolean"}}}}}} ``` ## The MockConfigDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MockConfigDTO":{"type":"object","properties":{"enabled":{"type":"boolean"},"blocks":{"type":"array","items":{"$ref":"#/components/schemas/MockBlockConfigDTO"}}}},"MockBlockConfigDTO":{"type":"object","properties":{"uuid":{"type":"string"},"enabled":{"type":"boolean"}}}}}} ``` ## The MockIpfsDataDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MockIpfsDataDTO":{"type":"object","properties":{"cid":{"type":"string"},"content":{"type":"string"}}}}}} ``` ## The MockTopicTransactionDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MockTopicTransactionDTO":{"type":"object","properties":{"id":{"type":"string"},"memo":{"type":"string"},"payer_account_id":{"type":"string"},"topic_id":{"type":"string"}}}}}} ``` ## The MockMessageTransactionDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MockMessageTransactionDTO":{"type":"object","properties":{"consensus_timestamp":{"type":"string"},"id":{"type":"string"},"message":{"type":"string"},"payer_account_id":{"type":"string"},"sequence_number":{"type":"number"},"topicId":{"type":"string"},"topic_id":{"type":"string"}}}}}} ``` ## The MockTopicDataDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MockTopicDataDTO":{"type":"object","properties":{"topicId":{"type":"string"},"topic":{"$ref":"#/components/schemas/MockTopicTransactionDTO"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MockMessageTransactionDTO"}}}},"MockTopicTransactionDTO":{"type":"object","properties":{"id":{"type":"string"},"memo":{"type":"string"},"payer_account_id":{"type":"string"},"topic_id":{"type":"string"}}},"MockMessageTransactionDTO":{"type":"object","properties":{"consensus_timestamp":{"type":"string"},"id":{"type":"string"},"message":{"type":"string"},"payer_account_id":{"type":"string"},"sequence_number":{"type":"number"},"topicId":{"type":"string"},"topic_id":{"type":"string"}}}}}} ``` ## The MockTokenDataDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MockTokenDataDTO":{"type":"object","properties":{"id":{"type":"string"},"token_id":{"type":"string"},"treasury_account_id":{"type":"string"},"name":{"type":"string"},"symbol":{"type":"string"},"decimals":{"type":"number"},"type":{"type":"string"},"admin_key":{"type":"boolean"},"freeze_key":{"type":"boolean"},"kyc_key":{"type":"boolean"},"supply_key":{"type":"boolean"},"wipe_key":{"type":"boolean"}}}}}} ``` ## The MockRequestConfigDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MockRequestConfigDTO":{"type":"object","properties":{"method":{"type":"string"},"responseType":{"type":"string"},"url":{"type":"string"}}}}}} ``` ## The MockApiDataDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MockApiDataDTO":{"type":"object","properties":{"request":{"$ref":"#/components/schemas/MockRequestConfigDTO"},"response":{"type":"string"}}},"MockRequestConfigDTO":{"type":"object","properties":{"method":{"type":"string"},"responseType":{"type":"string"},"url":{"type":"string"}}}}}} ``` ## The MockUserDataDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MockUserDataDTO":{"type":"object","properties":{"username":{"type":"string"},"did":{"type":"string"},"hederaAccountId":{"type":"string"},"hederaAccountKey":{"type":"string"},"document":{"$ref":"#/components/schemas/DidDocumentDTO"}}},"DidDocumentDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"@context":{"nullable":true,"type":"array","items":{"type":"string"}},"alsoKnownAs":{"nullable":true,"type":"array","items":{"type":"string"}},"controller":{"nullable":true,"type":"array","items":{"type":"string"}},"verificationMethod":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"authentication":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"assertionMethod":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"keyAgreement":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"capabilityInvocation":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"capabilityDelegation":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"service":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}}},"required":["id","@context","alsoKnownAs","controller","verificationMethod","authentication","assertionMethod","keyAgreement","capabilityInvocation","capabilityDelegation","service"]}}}} ``` ## The MockDataDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MockDataDTO":{"type":"object","properties":{"ipfs":{"type":"array","items":{"$ref":"#/components/schemas/MockIpfsDataDTO"}},"topics":{"type":"array","items":{"$ref":"#/components/schemas/MockTopicDataDTO"}},"tokens":{"type":"array","items":{"$ref":"#/components/schemas/MockTokenDataDTO"}},"api":{"type":"array","items":{"$ref":"#/components/schemas/MockApiDataDTO"}},"users":{"type":"array","items":{"$ref":"#/components/schemas/MockUserDataDTO"}}}},"MockIpfsDataDTO":{"type":"object","properties":{"cid":{"type":"string"},"content":{"type":"string"}}},"MockTopicDataDTO":{"type":"object","properties":{"topicId":{"type":"string"},"topic":{"$ref":"#/components/schemas/MockTopicTransactionDTO"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MockMessageTransactionDTO"}}}},"MockTopicTransactionDTO":{"type":"object","properties":{"id":{"type":"string"},"memo":{"type":"string"},"payer_account_id":{"type":"string"},"topic_id":{"type":"string"}}},"MockMessageTransactionDTO":{"type":"object","properties":{"consensus_timestamp":{"type":"string"},"id":{"type":"string"},"message":{"type":"string"},"payer_account_id":{"type":"string"},"sequence_number":{"type":"number"},"topicId":{"type":"string"},"topic_id":{"type":"string"}}},"MockTokenDataDTO":{"type":"object","properties":{"id":{"type":"string"},"token_id":{"type":"string"},"treasury_account_id":{"type":"string"},"name":{"type":"string"},"symbol":{"type":"string"},"decimals":{"type":"number"},"type":{"type":"string"},"admin_key":{"type":"boolean"},"freeze_key":{"type":"boolean"},"kyc_key":{"type":"boolean"},"supply_key":{"type":"boolean"},"wipe_key":{"type":"boolean"}}},"MockApiDataDTO":{"type":"object","properties":{"request":{"$ref":"#/components/schemas/MockRequestConfigDTO"},"response":{"type":"string"}}},"MockRequestConfigDTO":{"type":"object","properties":{"method":{"type":"string"},"responseType":{"type":"string"},"url":{"type":"string"}}},"MockUserDataDTO":{"type":"object","properties":{"username":{"type":"string"},"did":{"type":"string"},"hederaAccountId":{"type":"string"},"hederaAccountKey":{"type":"string"},"document":{"$ref":"#/components/schemas/DidDocumentDTO"}}},"DidDocumentDTO":{"type":"object","properties":{"id":{"type":"string","nullable":false},"@context":{"nullable":true,"type":"array","items":{"type":"string"}},"alsoKnownAs":{"nullable":true,"type":"array","items":{"type":"string"}},"controller":{"nullable":true,"type":"array","items":{"type":"string"}},"verificationMethod":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"authentication":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"assertionMethod":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"keyAgreement":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"capabilityInvocation":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"capabilityDelegation":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}},"service":{"additionalProperties":true,"nullable":true,"type":"array","items":{"type":"object"}}},"required":["id","@context","alsoKnownAs","controller","verificationMethod","authentication","assertionMethod","keyAgreement","capabilityInvocation","capabilityDelegation","service"]}}}} ``` ## The MockApiRequestDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MockApiRequestDTO":{"type":"object","properties":{"type":{"type":"string"},"url":{"type":"string"},"body":{"type":"object"},"headers":{"type":"object"}}}}}} ``` ## The MockIpfsRequestDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MockIpfsRequestDTO":{"type":"object","properties":{"cid":{"type":"string"}}}}}} ``` ## The RunningDetailsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RunningDetailsDTO":{"type":"object","properties":{"left":{"type":"object","description":"Left side (recorded) document","additionalProperties":true},"right":{"type":"object","description":"Right side (replayed) document","additionalProperties":true},"total":{"type":"number","description":"Total number of fields compared"},"documents":{"type":"object","description":"Detailed field-by-field comparison","additionalProperties":true}},"required":["left","right","total","documents"]}}}} ``` ## The PolicyCategoryDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyCategoryDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"}},"required":["id","name","type"]}}}} ``` ## The PolicyParametersDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyParametersDTO":{"type":"object","properties":{"policyId":{"type":"string"},"config":{"type":"array","items":{"$ref":"#/components/schemas/PolicyEditableFieldDTO"}},"updated":{"type":"boolean"}},"required":["policyId"]},"PolicyEditableFieldDTO":{"type":"object","properties":{}}}}} ``` ## The SchemaParentDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SchemaParentDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","UNPUBLISHED","ERROR","DEMO","VIEW"]},"version":{"type":"string"},"sourceVersion":{"type":"string","nullable":true},"category":{"type":"string","enum":["POLICY","MODULE","SYSTEM","TAG","TOOL","STATISTIC","LABEL"]}},"required":["id","name","status","version","category"]}}}} ``` ## The SchemaListAllItemDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SchemaListAllItemDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","UNPUBLISHED","ERROR","DEMO","VIEW"]},"version":{"type":"string"},"sourceVersion":{"type":"string","nullable":true},"topicId":{"type":"string"},"category":{"type":"string","enum":["POLICY","MODULE","SYSTEM","TAG","TOOL","STATISTIC","LABEL"]}},"required":["id","name","description","status","version","topicId","category"]}}}} ``` ## The SchemaWithSubSchemasDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SchemaWithSubSchemasDTO":{"type":"object","properties":{"schema":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/SchemaDTO"}]},"subSchemas":{"type":"array","items":{"$ref":"#/components/schemas/SchemaDTO"}}}},"SchemaDTO":{"type":"object","properties":{"createDate":{"type":"string","nullable":true},"updateDate":{"type":"string","nullable":true},"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"entity":{"type":"string","enum":["NONE","VC","EVC","STANDARD_REGISTRY","USER","POLICY","MINT_TOKEN","INTEGRATION_DATA_V2","RETIRE","WIPE_TOKEN","MINT_NFTOKEN","ISSUER","USER_ROLE","CHUNK","ACTIVITY_IMPACT","TOKEN_DATA_SOURCE","ROLE","USER_PERMISSIONS","POLICY_DISCUSSION_V2","POLICY_COMMENT","POLICY_EXPORT_PROOF","EVIDENCE_ATTACHMENTS"]},"iri":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","UNPUBLISHED","ERROR","DEMO","VIEW"]},"topicId":{"type":"string"},"version":{"type":"string"},"creator":{"type":"string","nullable":true},"owner":{"type":"string"},"messageId":{"type":"string","nullable":true},"category":{"type":"string","enum":["POLICY","MODULE","SYSTEM","TAG","TOOL","STATISTIC","LABEL"]},"documentURL":{"type":"string"},"contextURL":{"type":"string"},"document":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"context":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"readonly":{"type":"boolean","nullable":true},"system":{"type":"boolean","nullable":true},"active":{"type":"boolean","nullable":true},"codeVersion":{"type":"string","nullable":true},"topicCount":{"type":"number","nullable":true}},"required":["id","uuid","name","description","entity","iri","status","topicId","version","owner","category","documentURL","contextURL","document","context"]}}}} ``` ## The SchemaPushCopyRequestDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SchemaPushCopyRequestDTO":{"type":"object","properties":{"topicId":{"type":"string","description":"Target Hedera topic id for the copied schema."},"name":{"type":"string","description":"Display name for the copied schema."},"iri":{"type":"string","description":"Source schema IRI (with `#` prefix, typically `uuid&version`)."},"copyNested":{"type":"boolean","description":"When true, nested schemas are copied together with the source."}},"required":["topicId","name","iri","copyNested"]}}}} ``` ## The VersionSchemaDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"VersionSchemaDTO":{"type":"object","properties":{"version":{"type":"string"}},"required":["version"]}}}} ``` ## The MessageSchemaDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"MessageSchemaDTO":{"type":"object","properties":{"messageId":{"type":"string"}},"required":["messageId"]}}}} ``` ## The SchemaImportDuplicatesRequestDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SchemaImportDuplicatesRequestDTO":{"type":"object","properties":{"policyId":{"type":"string","description":"Target policy topic id used to search for existing draft schemas that can be replaced."},"schemaNames":{"type":"array","items":{"type":"string"},"description":"Schema names from the imported package to check for duplicates in the target policy topic."}},"required":["policyId","schemaNames"]}}}} ``` ## The ExportSchemaDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ExportSchemaDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"version":{"type":"string"},"owner":{"type":"string"},"messageId":{"type":"string"}},"required":["id","name","description","version","owner","messageId"]}}}} ``` ## The SystemSchemaDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SystemSchemaDTO":{"type":"object","properties":{"name":{"type":"string"},"entity":{"type":"string","enum":["STANDARD_REGISTRY","USER"]}},"required":["name","entity"]}}}} ``` ## The ChildSchemaDeletionBlockDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ChildSchemaDeletionBlockDTO":{"type":"object","properties":{"schema":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/SchemaDTO"}]},"blockingSchemas":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/SchemaDTO"}]}},"required":["schema","blockingSchemas"]},"SchemaDTO":{"type":"object","properties":{"createDate":{"type":"string","nullable":true},"updateDate":{"type":"string","nullable":true},"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"entity":{"type":"string","enum":["NONE","VC","EVC","STANDARD_REGISTRY","USER","POLICY","MINT_TOKEN","INTEGRATION_DATA_V2","RETIRE","WIPE_TOKEN","MINT_NFTOKEN","ISSUER","USER_ROLE","CHUNK","ACTIVITY_IMPACT","TOKEN_DATA_SOURCE","ROLE","USER_PERMISSIONS","POLICY_DISCUSSION_V2","POLICY_COMMENT","POLICY_EXPORT_PROOF","EVIDENCE_ATTACHMENTS"]},"iri":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","UNPUBLISHED","ERROR","DEMO","VIEW"]},"topicId":{"type":"string"},"version":{"type":"string"},"creator":{"type":"string","nullable":true},"owner":{"type":"string"},"messageId":{"type":"string","nullable":true},"category":{"type":"string","enum":["POLICY","MODULE","SYSTEM","TAG","TOOL","STATISTIC","LABEL"]},"documentURL":{"type":"string"},"contextURL":{"type":"string"},"document":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"context":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"readonly":{"type":"boolean","nullable":true},"system":{"type":"boolean","nullable":true},"active":{"type":"boolean","nullable":true},"codeVersion":{"type":"string","nullable":true},"topicCount":{"type":"number","nullable":true}},"required":["id","uuid","name","description","entity","iri","status","topicId","version","owner","category","documentURL","contextURL","document","context"]}}}} ``` ## The SchemaDeletionPreviewDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SchemaDeletionPreviewDTO":{"type":"object","properties":{"deletableChildren":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/SchemaDTO"}},"blockedChildren":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/ChildSchemaDeletionBlockDTO"}}},"required":["deletableChildren","blockedChildren"]},"SchemaDTO":{"type":"object","properties":{"createDate":{"type":"string","nullable":true},"updateDate":{"type":"string","nullable":true},"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"entity":{"type":"string","enum":["NONE","VC","EVC","STANDARD_REGISTRY","USER","POLICY","MINT_TOKEN","INTEGRATION_DATA_V2","RETIRE","WIPE_TOKEN","MINT_NFTOKEN","ISSUER","USER_ROLE","CHUNK","ACTIVITY_IMPACT","TOKEN_DATA_SOURCE","ROLE","USER_PERMISSIONS","POLICY_DISCUSSION_V2","POLICY_COMMENT","POLICY_EXPORT_PROOF","EVIDENCE_ATTACHMENTS"]},"iri":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","UNPUBLISHED","ERROR","DEMO","VIEW"]},"topicId":{"type":"string"},"version":{"type":"string"},"creator":{"type":"string","nullable":true},"owner":{"type":"string"},"messageId":{"type":"string","nullable":true},"category":{"type":"string","enum":["POLICY","MODULE","SYSTEM","TAG","TOOL","STATISTIC","LABEL"]},"documentURL":{"type":"string"},"contextURL":{"type":"string"},"document":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"context":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"readonly":{"type":"boolean","nullable":true},"system":{"type":"boolean","nullable":true},"active":{"type":"boolean","nullable":true},"codeVersion":{"type":"string","nullable":true},"topicCount":{"type":"number","nullable":true}},"required":["id","uuid","name","description","entity","iri","status","topicId","version","owner","category","documentURL","contextURL","document","context"]},"ChildSchemaDeletionBlockDTO":{"type":"object","properties":{"schema":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/SchemaDTO"}]},"blockingSchemas":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/SchemaDTO"}]}},"required":["schema","blockingSchemas"]}}}} ``` ## The SettingsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SettingsDTO":{"type":"object","properties":{"ipfsStorageApiKey":{"type":"string"},"operatorId":{"type":"string"},"operatorKey":{"type":"string"}},"required":["ipfsStorageApiKey","operatorId","operatorKey"]}}}} ``` ## The AboutResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"AboutResponseDTO":{"type":"object","properties":{"version":{"type":"string","description":"Application version"}},"required":["version"]}}}} ``` ## The TagDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"TagDTO":{"type":"object","properties":{"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"owner":{"type":"string"},"date":{"type":"string"},"entity":{"type":"string","enum":["Schema","Policy","Token","Module","Contract","PolicyDocument"]},"status":{"type":"string","enum":["Draft","Published","History"]},"operation":{"type":"string","enum":["Create","Delete"]},"topicId":{"type":"string"},"messageId":{"type":"string"},"policyId":{"type":"string"},"uri":{"type":"string"},"target":{"type":"string"},"localTarget":{"type":"string"},"document":{"type":"object","additionalProperties":true},"tagSchemaId":{"type":"string","description":"Tag schema database ID (for tags created with a tag schema)"},"inheritTags":{"type":"boolean","description":"Inherit tags"}},"required":["uuid","name","description","owner","date","entity","status","operation","topicId","messageId","policyId","uri","target","localTarget","document"]}}}} ``` ## The TagFilterDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"TagFilterDTO":{"type":"object","properties":{"entity":{"type":"string","enum":["Schema","Policy","Token","Module","Contract","PolicyDocument","PolicyBlock"]},"target":{"type":"string"},"targets":{"type":"array","items":{"type":"string"}},"linkedItems":{"type":"array","items":{"type":"string"}}},"required":["entity","target","targets","linkedItems"]}}}} ``` ## The TagMapDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"TagMapDTO":{"type":"object","properties":{"entity":{"type":"string","enum":["Schema","Policy","Token","Module","Contract","PolicyDocument"]},"target":{"type":"string"},"refreshDate":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagDTO"}}},"required":["entity","target","refreshDate","tags"]},"TagDTO":{"type":"object","properties":{"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"owner":{"type":"string"},"date":{"type":"string"},"entity":{"type":"string","enum":["Schema","Policy","Token","Module","Contract","PolicyDocument"]},"status":{"type":"string","enum":["Draft","Published","History"]},"operation":{"type":"string","enum":["Create","Delete"]},"topicId":{"type":"string"},"messageId":{"type":"string"},"policyId":{"type":"string"},"uri":{"type":"string"},"target":{"type":"string"},"localTarget":{"type":"string"},"document":{"type":"object","additionalProperties":true},"tagSchemaId":{"type":"string","description":"Tag schema database ID (for tags created with a tag schema)"},"inheritTags":{"type":"boolean","description":"Inherit tags"}},"required":["uuid","name","description","owner","date","entity","status","operation","topicId","messageId","policyId","uri","target","localTarget","document"]}}}} ``` ## The StatusDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"StatusDTO":{"type":"object","properties":{"message":{"type":"string","description":"Text"},"type":{"type":"string","description":"Type","enum":["Processing","Completed","Info"]}},"required":["message","type"]}}}} ``` ## The TaskStatusDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"TaskStatusDTO":{"type":"object","properties":{"action":{"type":"string","description":"Task type"},"userId":{"type":"string","description":"User Id"},"expectation":{"type":"number","description":"Expected count of task phases"},"taskId":{"type":"string","description":"Task Id"},"date":{"type":"string","description":"Date"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/StatusDTO"}},"result":{"type":"object","additionalProperties":true},"error":{"type":"object","additionalProperties":true}},"required":["action","userId","expectation","taskId","date","statuses","result","error"]},"StatusDTO":{"type":"object","properties":{"message":{"type":"string","description":"Text"},"type":{"type":"string","description":"Type","enum":["Processing","Completed","Info"]}},"required":["message","type"]}}}} ``` ## The TokenInfoDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"TokenInfoDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"tokenId":{"type":"string","description":"Hedera token ID"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"decimals":{"type":"string","description":"Number of decimal places"},"associated":{"type":"boolean","description":"Whether the current user is associated with this token"},"frozen":{"type":"boolean","description":"Whether the current user's account is frozen for this token"},"kyc":{"type":"boolean","description":"Whether the current user has passed KYC for this token"},"balance":{"type":"string","description":"Current token balance for the user"},"enableAdmin":{"type":"boolean","description":"Whether the token has an Admin key"},"enableFreeze":{"type":"boolean","description":"Whether the token has a Freeze key"},"enableKYC":{"type":"boolean","description":"Whether the token has a KYC key"},"enableWipe":{"type":"boolean","description":"Whether the token has a Wipe key"}},"required":["id","tokenId","tokenName","tokenSymbol","tokenType","decimals","associated","frozen","kyc","balance","enableAdmin","enableFreeze","enableKYC","enableWipe"]}}}} ``` ## The TokenDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"TokenDTO":{"type":"object","properties":{"tokenId":{"type":"string","description":"Hedera token ID (assigned after token creation on Hedera)"},"tokenName":{"type":"string","description":"Human-readable name of the token"},"tokenSymbol":{"type":"string","description":"Short ticker symbol for the token"},"tokenType":{"type":"string","description":"Token type on Hedera","enum":["fungible","non-fungible"]},"initialSupply":{"type":"string","description":"Initial supply of the token (set to 0 for mintable tokens)"},"decimals":{"type":"string","description":"Number of decimal places (0 for NFTs, typically 2 for fungible tokens)"},"changeSupply":{"type":"boolean","description":"Enable Supply key — allows minting and burning tokens"},"enableAdmin":{"type":"boolean","description":"Enable Admin key — allows managing token properties"},"enableFreeze":{"type":"boolean","description":"Enable Freeze key — allows freezing token transfers for specific accounts"},"enableKYC":{"type":"boolean","description":"Enable KYC key — allows granting/revoking KYC status for accounts"},"enableWipe":{"type":"boolean","description":"Enable Wipe key — allows wiping token balance from specific accounts"}},"required":["tokenId","tokenName","tokenSymbol","tokenType","initialSupply","decimals","changeSupply","enableAdmin","enableFreeze","enableKYC","enableWipe"]}}}} ``` ## The TransferTokenDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"TransferTokenDTO":{"type":"object","properties":{"targetAccount":{"type":"string","description":"Target Hedera account ID"},"amount":{"type":"number","description":"Amount (FT) or serial count to pick (NFT); must be > 0"},"serialNumbers":{"description":"Specific NFT serial numbers to transfer; positive integers","type":"array","items":{"type":"number"}},"memo":{"type":"string","description":"Optional transaction memo"}},"required":["targetAccount"]}}}} ``` ## The ThemeRoleDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ThemeRoleDTO":{"type":"object","properties":{"description":{"type":"string"},"text":{"type":"string","description":"Text color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"background":{"type":"string","description":"Background color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"border":{"type":"string","description":"Border color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"shape":{"type":"string","description":"Object shape","enum":["0","1","2","3","4","5"]},"borderWidth":{"type":"string","description":"Border width","enum":["0px","1px","2px","3px","4px","5px","6px","7px"]},"filterType":{"type":"string","description":"Filter by type","enum":["type","api","role"]},"filterValue":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["description","text","background","border","shape","borderWidth","filterType","filterValue"]}}}} ``` ## The ThemeDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ThemeDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"createDate":{"type":"string","description":"Creation date in ISO 8601 format"},"updateDate":{"type":"string","description":"Last update date in ISO 8601 format"},"uuid":{"type":"string","description":"Unique universal identifier"},"owner":{"type":"string","description":"DID of the theme owner"},"name":{"type":"string","description":"Theme name"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/ThemeRoleDTO"}}},"required":["id","createDate","updateDate","uuid","owner","name","rules"]},"ThemeRoleDTO":{"type":"object","properties":{"description":{"type":"string"},"text":{"type":"string","description":"Text color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"background":{"type":"string","description":"Background color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"border":{"type":"string","description":"Border color","pattern":"(^#[0-9a-f]{3}$)|(^#[0-9a-f]{6}$)|(^#[0-9a-f]{8}$)"},"shape":{"type":"string","description":"Object shape","enum":["0","1","2","3","4","5"]},"borderWidth":{"type":"string","description":"Border width","enum":["0px","1px","2px","3px","4px","5px","6px","7px"]},"filterType":{"type":"string","description":"Filter by type","enum":["type","api","role"]},"filterValue":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"required":["description","text","background","border","shape","borderWidth","filterType","filterValue"]}}}} ``` ## The VpDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"VpDTO":{"type":"object","properties":{"@context":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"type":{"type":"array","items":{"type":"string"}},"verifiableCredential":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"proof":{"$ref":"#/components/schemas/ProofDTO"}},"required":["@context","id","type","verifiableCredential","proof"]},"ProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]}}}} ``` ## The VpDocumentDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"VpDocumentDTO":{"type":"object","properties":{"id":{"type":"string"},"policyId":{"type":"string"},"hash":{"type":"string"},"signature":{"type":"number"},"status":{"type":"string","enum":["NEW","ISSUE","REVOKE","SUSPEND","RESUME","FAILED"]},"tag":{"type":"string"},"type":{"type":"string"},"createDate":{"type":"string"},"updateDate":{"type":"string"},"owner":{"type":"string"},"document":{"$ref":"#/components/schemas/VpDTO"}},"required":["id","policyId","hash","signature","status","tag","type","createDate","updateDate","owner","document"]},"VpDTO":{"type":"object","properties":{"@context":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"type":{"type":"array","items":{"type":"string"}},"verifiableCredential":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"proof":{"$ref":"#/components/schemas/ProofDTO"}},"required":["@context","id","type","verifiableCredential","proof"]},"ProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]}}}} ``` ## The WizardConfigDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"WizardConfigDTO":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string"}},"policy":{"type":"object","additionalProperties":false,"required":["name","description","topicDescription","policyTag"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"topicDescription":{"type":"string"},"policyTag":{"type":"string"}}},"schemas":{"additionalProperties":false,"properties":{"name":{"type":"string"},"iri":{"type":"string"},"isApproveEnable":{"type":"boolean"},"isMintSchema":{"type":"boolean"},"mintOptions":{"type":"object","properties":{"tokenId":{"type":"string"},"rule":{"type":"string"}}},"dependencySchemaIri":{"type":"string"},"relationshipsSchemaIri":{"type":"string"},"initialRolesFor":{"type":"array","items":{"type":"string"}},"rolesConfig":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string"},"isApprover":{"type":"boolean"},"isCreator":{"type":"boolean"},"gridColumns":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"title":{"type":"string"}}}}}}}},"type":"array","items":{"type":"object"}},"trustChain":{"additionalProperties":false,"properties":{"role":{"type":"string"},"mintSchemaIri":{"type":"string"},"viewOnlyOwnDocuments":{"type":"boolean"}},"type":"array","items":{"type":"object"}}},"required":["roles","schemas","trustChain"]}}}} ``` ## The WizardResultDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"WizardResultDTO":{"type":"object","properties":{"policyId":{"type":"string"},"wizardConfig":{"$ref":"#/components/schemas/WizardConfigDTO"}},"required":["policyId","wizardConfig"]},"WizardConfigDTO":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string"}},"policy":{"type":"object","additionalProperties":false,"required":["name","description","topicDescription","policyTag"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"topicDescription":{"type":"string"},"policyTag":{"type":"string"}}},"schemas":{"additionalProperties":false,"properties":{"name":{"type":"string"},"iri":{"type":"string"},"isApproveEnable":{"type":"boolean"},"isMintSchema":{"type":"boolean"},"mintOptions":{"type":"object","properties":{"tokenId":{"type":"string"},"rule":{"type":"string"}}},"dependencySchemaIri":{"type":"string"},"relationshipsSchemaIri":{"type":"string"},"initialRolesFor":{"type":"array","items":{"type":"string"}},"rolesConfig":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string"},"isApprover":{"type":"boolean"},"isCreator":{"type":"boolean"},"gridColumns":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"title":{"type":"string"}}}}}}}},"type":"array","items":{"type":"object"}},"trustChain":{"additionalProperties":false,"properties":{"role":{"type":"string"},"mintSchemaIri":{"type":"string"},"viewOnlyOwnDocuments":{"type":"boolean"}},"type":"array","items":{"type":"object"}}},"required":["roles","schemas","trustChain"]}}}} ``` ## The WizardConfigAsyncDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"WizardConfigAsyncDTO":{"type":"object","properties":{"saveState":{"type":"boolean"},"wizardConfig":{"$ref":"#/components/schemas/WizardConfigDTO"}},"required":["saveState","wizardConfig"]},"WizardConfigDTO":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string"}},"policy":{"type":"object","additionalProperties":false,"required":["name","description","topicDescription","policyTag"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"topicDescription":{"type":"string"},"policyTag":{"type":"string"}}},"schemas":{"additionalProperties":false,"properties":{"name":{"type":"string"},"iri":{"type":"string"},"isApproveEnable":{"type":"boolean"},"isMintSchema":{"type":"boolean"},"mintOptions":{"type":"object","properties":{"tokenId":{"type":"string"},"rule":{"type":"string"}}},"dependencySchemaIri":{"type":"string"},"relationshipsSchemaIri":{"type":"string"},"initialRolesFor":{"type":"array","items":{"type":"string"}},"rolesConfig":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string"},"isApprover":{"type":"boolean"},"isCreator":{"type":"boolean"},"gridColumns":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"title":{"type":"string"}}}}}}}},"type":"array","items":{"type":"object"}},"trustChain":{"additionalProperties":false,"properties":{"role":{"type":"string"},"mintSchemaIri":{"type":"string"},"viewOnlyOwnDocuments":{"type":"boolean"}},"type":"array","items":{"type":"object"}}},"required":["roles","schemas","trustChain"]}}}} ``` ## The WizardPreviewDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"WizardPreviewDTO":{"type":"object","properties":{"policyConfig":{"$ref":"#/components/schemas/PolicyDTO"},"wizardConfig":{"$ref":"#/components/schemas/WizardConfigDTO"}},"required":["policyConfig","wizardConfig"]},"PolicyDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"topicDescription":{"type":"string"},"applicabilityConditions":{"type":"string"},"detailsUrl":{"type":"string"},"typicalProjects":{"type":"string"},"importantParameters":{"$ref":"#/components/schemas/PolicyImportantParametersDTO"},"policyTag":{"type":"string"},"status":{"type":"string","enum":["DRY-RUN","DRAFT","PUBLISH_ERROR","PUBLISH","DISCONTINUED","DEMO","VIEW"]},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"instanceTopicId":{"type":"string"},"messageId":{"type":"string"},"availability":{"type":"string","enum":["private","public"]},"codeVersion":{"type":"string"},"tools":{"type":"array","items":{"$ref":"#/components/schemas/PolicyToolDTO"}},"createDate":{"type":"string"},"version":{"type":"string"},"originalChanged":{"type":"string"},"editableParametersSettings":{"type":"array","items":{"$ref":"#/components/schemas/PolicyEditableFieldDTO"}},"config":{"type":"object","additionalProperties":true},"userRole":{"type":"string"},"userRoles":{"type":"array","items":{"type":"string"}},"userGroup":{"type":"object","additionalProperties":true,"nullable":true,"description":"Last active group in iteration order (not a separate summary). Often shown via groupLabel or uuid."},"userGroups":{"additionalProperties":true,"description":"Full list of group rows for this user in the policy (getGroupsByUser), including inactive.","type":"array","items":{"type":"object"}},"policyRoles":{"type":"array","items":{"type":"string"}},"policyNavigation":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTopics":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTokens":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyGroups":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyDocumentation":{"additionalProperties":true,"description":"User-configured policy API documentation entries. The `alias` may be a single slug (`create-device`) or a path of slugs separated by `/` (`monitoring-reports/create`).","type":"array","items":{"type":"object"}},"categories":{"type":"array","items":{"type":"string"}},"projectSchema":{"type":"string"},"tests":{"type":"array","items":{"$ref":"#/components/schemas/PolicyTestDTO"}},"ignoreRules":{"description":"Validation-only rules to hide matching warnings/infos (not persisted)","type":"array","items":{"$ref":"#/components/schemas/IgnoreRuleDTO"}}},"required":["id","uuid","name","description","topicDescription","policyTag","status","creator","owner","topicId","instanceTopicId","messageId","codeVersion","tools","createDate","version","editableParametersSettings","config","userRole","userRoles","userGroup","userGroups","policyRoles","policyNavigation","policyTopics","policyTokens","policyGroups","policyDocumentation","categories","projectSchema","tests"]},"PolicyImportantParametersDTO":{"type":"object","properties":{"atValidation":{"type":"string"},"monitored":{"type":"string"}}},"PolicyToolDTO":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string","nullable":true},"topicId":{"type":"string"},"messageId":{"type":"string"}},"required":["name","topicId","messageId"]},"PolicyEditableFieldDTO":{"type":"object","properties":{}},"PolicyTestDTO":{"type":"object","properties":{"id":{"type":"string","description":"Test ID"},"uuid":{"type":"string","description":"Test UUID"},"name":{"type":"string","description":"Test Name"},"policyId":{"type":"string","description":"Policy ID"},"owner":{"type":"string","description":"Test owner"},"status":{"type":"string","description":"Test status","enum":["New","Running","Stopped","Success","Failure"]},"date":{"type":"string","description":"Last start date"},"duration":{"type":"string","description":"Test duration"},"progress":{"type":"string","description":"Test progress"},"resultId":{"type":"string","description":"Test result"},"result":{"type":"string","description":"Test result"}},"required":["id","uuid","name","policyId","owner","status","date","duration","progress","resultId","result"]},"IgnoreRuleDTO":{"type":"object","properties":{"code":{"type":"string","description":"Stable message code, e.g. DEPRECATION_BLOCK"},"blockType":{"type":"string","description":"Limit by block type"},"property":{"type":"string","description":"Limit by property"},"contains":{"type":"string","description":"Substring filter applied to message text"},"severity":{"type":"string","description":"Type of message","enum":["warning","info"]}}},"WizardConfigDTO":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string"}},"policy":{"type":"object","additionalProperties":false,"required":["name","description","topicDescription","policyTag"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"topicDescription":{"type":"string"},"policyTag":{"type":"string"}}},"schemas":{"additionalProperties":false,"properties":{"name":{"type":"string"},"iri":{"type":"string"},"isApproveEnable":{"type":"boolean"},"isMintSchema":{"type":"boolean"},"mintOptions":{"type":"object","properties":{"tokenId":{"type":"string"},"rule":{"type":"string"}}},"dependencySchemaIri":{"type":"string"},"relationshipsSchemaIri":{"type":"string"},"initialRolesFor":{"type":"array","items":{"type":"string"}},"rolesConfig":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string"},"isApprover":{"type":"boolean"},"isCreator":{"type":"boolean"},"gridColumns":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"title":{"type":"string"}}}}}}}},"type":"array","items":{"type":"object"}},"trustChain":{"additionalProperties":false,"properties":{"role":{"type":"string"},"mintSchemaIri":{"type":"string"},"viewOnlyOwnDocuments":{"type":"boolean"}},"type":"array","items":{"type":"object"}}},"required":["roles","schemas","trustChain"]}}}} ``` ## The BrandingDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"BrandingDTO":{"type":"object","properties":{"headerColor":{"type":"string"},"primaryColor":{"type":"string"},"companyName":{"type":"string"},"companyLogoUrl":{"type":"string"},"loginBannerUrl":{"type":"string"},"faviconUrl":{"type":"string"},"headerColor1":{"type":"string"},"termsAndConditions":{"type":"string"}},"required":["headerColor","primaryColor","companyName","companyLogoUrl","loginBannerUrl","faviconUrl","headerColor1","termsAndConditions"]}}}} ``` ## The SuggestionsInputDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SuggestionsInputDTO":{"type":"object","properties":{"blockType":{"type":"string"},"children":{"nullable":true,"type":"array","items":{"$ref":"#/components/schemas/SuggestionsInputDTO"}}},"required":["blockType","children"]}}}} ``` ## The SuggestionsOutputDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SuggestionsOutputDTO":{"type":"object","properties":{"next":{"type":"string"},"nested":{"type":"string"}},"required":["next","nested"]}}}} ``` ## The SuggestionsConfigItemDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SuggestionsConfigItemDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["Policy","Module"]},"index":{"type":"number"}},"required":["id","type","index"]}}}} ``` ## The SuggestionsConfigDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SuggestionsConfigDTO":{"type":"object","properties":{"items":{"$ref":"#/components/schemas/SuggestionsConfigItemDTO"}},"required":["items"]},"SuggestionsConfigItemDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["Policy","Module"]},"index":{"type":"number"}},"required":["id","type","index"]}}}} ``` ## The NotificationDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"NotificationDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"createDate":{"type":"string","description":"Creation date in ISO 8601 format"},"updateDate":{"type":"string","description":"Last update date in ISO 8601 format"},"userId":{"type":"string","description":"User ID who owns this notification"},"title":{"type":"string","description":"Notification title (e.g. \"Policy published\", \"Schema created\")"},"message":{"type":"string","description":"Detailed notification message"},"type":{"type":"string","description":"Notification type","enum":["INFO","ERROR","WARN","SUCCESS"]},"action":{"type":"string","description":"Action that triggered the notification (used for navigation in UI)","enum":["POLICY_CONFIGURATION","POLICY_VIEW","POLICIES_PAGE","SCHEMAS_PAGE","TOKENS_PAGE","PROFILE_PAGE","POLICY_LABEL_PAGE"]},"result":{"type":"object","description":"Result ID (e.g. policy ID, schema ID) for navigation"},"read":{"type":"boolean","description":"Whether the notification has been read"},"old":{"type":"boolean","description":"Whether the notification is old (already shown to user)"}},"required":["id","createDate","updateDate","userId","title","message","type","action","result","read","old"]}}}} ``` ## The ProgressDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ProgressDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"createDate":{"type":"string","description":"Creation date in ISO 8601 format"},"updateDate":{"type":"string","description":"Last update date in ISO 8601 format"},"userId":{"type":"string","description":"User ID who initiated the action"},"action":{"type":"string","description":"Action being tracked (e.g. \"Publish policy\")"},"message":{"type":"string","description":"Current progress message"},"progress":{"type":"number","description":"Progress percentage (0-100)"},"type":{"type":"string","description":"Progress type","enum":["INFO","ERROR","WARN","SUCCESS"]},"taskId":{"type":"string","description":"Associated task ID"}},"required":["id","createDate","updateDate","userId","action","message","progress","type","taskId"]}}}} ``` ## The ProjectDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ProjectDTO":{"type":"object","properties":{"id":{"type":"string"},"policyId":{"type":"string"},"policyName":{"type":"string"},"registered":{"type":"string"},"title":{"type":"string"},"companyName":{"type":"string"},"sectoralScope":{"type":"string"}},"required":["id","policyId","policyName","registered","title","companyName","sectoralScope"]}}}} ``` ## The FilterDocumentsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"FilterDocumentsDTO":{"type":"object","properties":{"idLvl":{"oneOf":[{"type":"string","enum":["0","1"]},{"type":"number","enum":[0,1]}]},"eventsLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"propLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"childrenLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"documentId1":{"type":"string"},"documentId2":{"type":"string"},"documentIds":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The CompareDocumentsV2DTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CompareDocumentsV2DTO":{"type":"object","properties":{"projects":{"$ref":"#/components/schemas/CompareDocumentsDTO"},"presentations":{"$ref":"#/components/schemas/CompareDocumentsDTO"}},"required":["projects","presentations"]},"CompareDocumentsDTO":{"type":"object","properties":{"left":{"$ref":"#/components/schemas/CompareDocumentItemDTO"},"right":{"$ref":"#/components/schemas/CompareDocumentItemDTO"},"total":{"type":"number"},"documents":{"$ref":"#/components/schemas/CompareDocumentsSectionDTO"}},"required":["left","right","total","documents"]},"CompareDocumentItemDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"owner":{"type":"string"},"policy":{"type":"string","nullable":true}},"required":["id","type","owner"]},"CompareDocumentsSectionDTO":{"type":"object","properties":{"columns":{"type":"array","items":{"$ref":"#/components/schemas/ComparePoliciesColumnDTO"}},"report":{"type":"array","items":{"type":"object"}}},"required":["columns","report"]},"ComparePoliciesColumnDTO":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"type":{"type":"string"},"display":{"type":"string"}},"required":["name","label","type"]}}}} ``` ## The PropertiesDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PropertiesDTO":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"value":{"type":"string"}},"required":["id","title","value"]}}}} ``` ## The RecordStatusDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RecordStatusDTO":{"type":"object","properties":{"type":{"type":"string","description":"Record type (Recording or Running)"},"policyId":{"type":"string","description":"Policy ID being recorded/run"},"uuid":{"type":"string","description":"Unique identifier of the recording session"},"status":{"type":"string","description":"Current status of the recording/running session"}},"required":["type","policyId","uuid","status"]}}}} ``` ## The RecordActionDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RecordActionDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"Unique identifier of the action"},"policyId":{"type":"string","description":"Policy ID"},"method":{"type":"string","description":"HTTP method (GET, POST, PUT, etc.)"},"action":{"type":"string","description":"Action type"},"time":{"type":"string","description":"Timestamp when the action occurred"},"user":{"type":"string","description":"User DID who performed the action"},"target":{"type":"string","description":"Target block or entity of the action"}},"required":["uuid","policyId","method","action","time","user","target"]}}}} ``` ## The ResultInfoDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ResultInfoDTO":{"type":"object","properties":{"tokens":{"type":"number","description":"Number of tokens involved in the run"},"documents":{"type":"number","description":"Number of documents created during the run"}},"required":["tokens","documents"]}}}} ``` ## The ResultDocumentDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ResultDocumentDTO":{"type":"object","properties":{"type":{"type":"string","description":"Document type (VC, VP, etc.)"},"schema":{"type":"string","description":"Schema identifier"},"rate":{"type":"string","description":"Match rate between recorded and replayed document"},"documents":{"type":"object","description":"Document comparison details","additionalProperties":true}},"required":["type","schema","rate","documents"]}}}} ``` ## The RunningResultDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RunningResultDTO":{"type":"object","properties":{"info":{"description":"Summary info about the run","allOf":[{"$ref":"#/components/schemas/ResultInfoDTO"}]},"total":{"type":"number","description":"Total number of documents compared"},"documents":{"description":"Detailed document comparison results","type":"array","items":{"$ref":"#/components/schemas/ResultDocumentDTO"}}},"required":["info","total","documents"]},"ResultInfoDTO":{"type":"object","properties":{"tokens":{"type":"number","description":"Number of tokens involved in the run"},"documents":{"type":"number","description":"Number of documents created during the run"}},"required":["tokens","documents"]},"ResultDocumentDTO":{"type":"object","properties":{"type":{"type":"string","description":"Document type (VC, VP, etc.)"},"schema":{"type":"string","description":"Schema identifier"},"rate":{"type":"string","description":"Match rate between recorded and replayed document"},"documents":{"type":"object","description":"Document comparison details","additionalProperties":true}},"required":["type","schema","rate","documents"]}}}} ``` ## The RoleDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RoleDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"createDate":{"type":"string","description":"Role creation date in ISO 8601 format"},"updateDate":{"type":"string","description":"Last update date in ISO 8601 format"},"uuid":{"type":"string","description":"Unique universal identifier"},"name":{"type":"string","description":"Role name"},"description":{"type":"string","description":"Role description"},"owner":{"type":"string","description":"DID of the Standard Registry who created this role"},"permissions":{"type":"array","description":"List of permission names assigned to this role","items":{"type":"string","enum":["ANALYTIC_POLICY_READ","ANALYTIC_MODULE_READ","ANALYTIC_TOOL_READ","ANALYTIC_SCHEMA_READ","ANALYTIC_DOCUMENT_READ","ARTIFACTS_FILE_READ","ARTIFACTS_FILE_CREATE","ARTIFACTS_FILE_DELETE","CONTRACTS_CONTRACT_READ","CONTRACTS_CONTRACT_EXECUTE","LOG_LOG_READ","LOG_SYSTEM_READ","LOG_USERS_READ","MODULES_MODULE_READ","MODULES_MODULE_CREATE","MODULES_MODULE_UPDATE","MODULES_MODULE_DELETE","MODULES_MODULE_REVIEW","POLICIES_POLICY_READ","POLICIES_POLICY_CREATE","POLICIES_POLICY_UPDATE","POLICIES_POLICY_DELETE","POLICIES_POLICY_REVIEW","POLICIES_POLICY_EXECUTE","POLICIES_POLICY_MANAGE","POLICIES_POLICY_AUDIT","POLICIES_POLICY_TAG","POLICIES_EXTERNAL_POLICY_READ","POLICIES_EXTERNAL_POLICY_CREATE","POLICIES_EXTERNAL_POLICY_UPDATE","POLICIES_EXTERNAL_POLICY_DELETE","SCHEMAS_SCHEMA_READ","SCHEMAS_SCHEMA_CREATE","SCHEMAS_SCHEMA_UPDATE","SCHEMAS_SCHEMA_DELETE","SCHEMAS_SCHEMA_REVIEW","TOOLS_TOOL_READ","TOOLS_TOOL_CREATE","TOOLS_TOOL_UPDATE","TOOLS_TOOL_DELETE","TOOLS_TOOL_REVIEW","TOKENS_TOKEN_READ","TOKENS_TOKEN_CREATE","TOKENS_TOKEN_UPDATE","TOKENS_TOKEN_DELETE","TOKENS_TOKEN_EXECUTE","TOKENS_TOKEN_MANAGE","TAGS_TAG_READ","TAGS_TAG_CREATE","SUGGESTIONS_SUGGESTIONS_READ","SUGGESTIONS_SUGGESTIONS_UPDATE","PERMISSIONS_ROLE_READ","PERMISSIONS_ROLE_CREATE","PERMISSIONS_ROLE_UPDATE","PERMISSIONS_ROLE_DELETE","PERMISSIONS_ROLE_MANAGE","STATISTICS_STATISTIC_READ","STATISTICS_STATISTIC_CREATE","STATISTICS_LABEL_READ","STATISTICS_LABEL_CREATE","SCHEMAS_RULE_READ","SCHEMAS_RULE_CREATE","SCHEMAS_RULE_EXECUTE","FORMULAS_FORMULA_READ","FORMULAS_FORMULA_CREATE","WORKER_TASKS_READ","WORKER_TASKS_EXECUTE","WORKER_TASKS_DELETE","ACCESS_POLICY_ALL","ACCESS_POLICY_ASSIGNED","ACCESS_POLICY_PUBLISHED","ACCESS_POLICY_ASSIGNED_AND_PUBLISHED","CREDENTIALS_USER_READ","CREDENTIALS_USER_WRITE","CREDENTIALS_SR_READ","CREDENTIALS_SR_WRITE","DELEGATION_ROLE_MANAGE"]}},"default":{"type":"boolean","description":"Whether this is the default role for new users"},"readonly":{"type":"boolean","description":"Whether the role is read-only (system role)"}},"required":["id","createDate","updateDate","uuid","name","description","owner","permissions","default","readonly"]}}}} ``` ## The PermissionsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PermissionsDTO":{"type":"object","properties":{"name":{"type":"string","enum":["ANALYTIC_POLICY_READ","ANALYTIC_MODULE_READ","ANALYTIC_TOOL_READ","ANALYTIC_SCHEMA_READ","ANALYTIC_DOCUMENT_READ","ARTIFACTS_FILE_READ","ARTIFACTS_FILE_CREATE","ARTIFACTS_FILE_DELETE","CONTRACTS_CONTRACT_READ","CONTRACTS_CONTRACT_EXECUTE","LOG_LOG_READ","LOG_SYSTEM_READ","LOG_USERS_READ","MODULES_MODULE_READ","MODULES_MODULE_CREATE","MODULES_MODULE_UPDATE","MODULES_MODULE_DELETE","MODULES_MODULE_REVIEW","POLICIES_POLICY_READ","POLICIES_POLICY_CREATE","POLICIES_POLICY_UPDATE","POLICIES_POLICY_DELETE","POLICIES_POLICY_REVIEW","POLICIES_POLICY_EXECUTE","POLICIES_POLICY_MANAGE","POLICIES_POLICY_AUDIT","POLICIES_POLICY_TAG","POLICIES_EXTERNAL_POLICY_READ","POLICIES_EXTERNAL_POLICY_CREATE","POLICIES_EXTERNAL_POLICY_UPDATE","POLICIES_EXTERNAL_POLICY_DELETE","SCHEMAS_SCHEMA_READ","SCHEMAS_SCHEMA_CREATE","SCHEMAS_SCHEMA_UPDATE","SCHEMAS_SCHEMA_DELETE","SCHEMAS_SCHEMA_REVIEW","TOOLS_TOOL_READ","TOOLS_TOOL_CREATE","TOOLS_TOOL_UPDATE","TOOLS_TOOL_DELETE","TOOLS_TOOL_REVIEW","TOKENS_TOKEN_READ","TOKENS_TOKEN_CREATE","TOKENS_TOKEN_UPDATE","TOKENS_TOKEN_DELETE","TOKENS_TOKEN_EXECUTE","TOKENS_TOKEN_MANAGE","TAGS_TAG_READ","TAGS_TAG_CREATE","SUGGESTIONS_SUGGESTIONS_READ","SUGGESTIONS_SUGGESTIONS_UPDATE","PERMISSIONS_ROLE_READ","PERMISSIONS_ROLE_CREATE","PERMISSIONS_ROLE_UPDATE","PERMISSIONS_ROLE_DELETE","PERMISSIONS_ROLE_MANAGE","STATISTICS_STATISTIC_READ","STATISTICS_STATISTIC_CREATE","STATISTICS_LABEL_READ","STATISTICS_LABEL_CREATE","SCHEMAS_RULE_READ","SCHEMAS_RULE_CREATE","SCHEMAS_RULE_EXECUTE","FORMULAS_FORMULA_READ","FORMULAS_FORMULA_CREATE","WORKER_TASKS_READ","WORKER_TASKS_EXECUTE","WORKER_TASKS_DELETE","ACCESS_POLICY_ALL","ACCESS_POLICY_ASSIGNED","ACCESS_POLICY_PUBLISHED","ACCESS_POLICY_ASSIGNED_AND_PUBLISHED","CREDENTIALS_USER_READ","CREDENTIALS_USER_WRITE","CREDENTIALS_SR_READ","CREDENTIALS_SR_WRITE","DELEGATION_ROLE_MANAGE"]},"category":{"type":"string","enum":["ACCOUNTS","SESSION","PROFILES","ANALYTIC","ARTIFACTS","POLICIES","BRANDING","CONTRACTS","DEMO","IPFS","LOG","MODULES","SETTINGS","SUGGESTIONS","TAGS","SCHEMAS","TOKENS","AUDIT","TOOLS","PERMISSIONS","ACCESS","DELEGATION","STATISTICS","FORMULAS","WORKER_TASKS","CREDENTIALS"]},"entity":{"type":"string","enum":["ACCOUNT","STANDARD_REGISTRY","USER","BALANCE","RESTORE","RECORD","POLICY","TOOL","DOCUMENT","SCHEMA","MODULE","FILE","CONFIG","CONTRACT","WIPE_REQUEST","WIPE_ADMIN","WIPE_MANAGER","WIPER","POOL","RETIRE_REQUEST","RETIRE_ADMIN","PERMISSIONS","KEY","LOG","MIGRATION","SETTINGS","SUGGESTIONS","TAG","SYSTEM_SCHEMA","THEME","TOKEN","TRUST_CHAIN","ROLE","STATISTIC","RULE","LABEL","FORMULA","EXTERNAL_POLICY","WORKER_TASK","CREDENTIAL"]},"action":{"type":"string","enum":["ALL","READ","CREATE","UPDATE","DELETE","REVIEW","TAG","AUDIT","EXECUTE","MANAGE","ASSIGNED","PUBLISHED","ASSIGNED_AND_PUBLISHED","SYSTEM","USERS"]},"disabled":{"type":"boolean"},"dependOn":{"type":"array","items":{"type":"string"}}},"required":["name","category","entity","action","disabled","dependOn"]}}}} ``` ## The UserDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"UserDTO":{"type":"object","properties":{"username":{"type":"string"},"role":{"type":"string","enum":["STANDARD_REGISTRY","USER","AUDITOR"]},"permissionsGroup":{"type":"array","items":{"type":"string"}},"permissions":{"type":"array","items":{"type":"string"}},"did":{"type":"string"},"parent":{"type":"string"},"hederaAccountId":{"type":"string"}},"required":["username","role","permissions"]}}}} ``` ## The AssignPolicyDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"AssignPolicyDTO":{"type":"object","properties":{"policyIds":{"type":"array","items":{"type":"string"}},"assign":{"type":"boolean"}},"required":["policyIds","assign"]}}}} ``` ## The StatisticDefinitionDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"StatisticDefinitionDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"messageId":{"type":"string"},"policyId":{"type":"string"},"policyTopicId":{"type":"string"},"policyInstanceTopicId":{"type":"string"},"status":{"type":"string","enum":["DRAFT","DRY_RUN","PUBLISHED","ERROR","ACTIVE"]},"config":{"type":"object","nullable":true,"additionalProperties":true}},"required":["name","config"]}}}} ``` ## The StatisticDefinitionRelationshipsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"StatisticDefinitionRelationshipsDTO":{"type":"object","properties":{"policy":{"$ref":"#/components/schemas/PolicyDTO"},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/SchemaDTO"}},"schema":{"$ref":"#/components/schemas/SchemaDTO"}}},"PolicyDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"topicDescription":{"type":"string"},"applicabilityConditions":{"type":"string"},"detailsUrl":{"type":"string"},"typicalProjects":{"type":"string"},"importantParameters":{"$ref":"#/components/schemas/PolicyImportantParametersDTO"},"policyTag":{"type":"string"},"status":{"type":"string","enum":["DRY-RUN","DRAFT","PUBLISH_ERROR","PUBLISH","DISCONTINUED","DEMO","VIEW"]},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"instanceTopicId":{"type":"string"},"messageId":{"type":"string"},"availability":{"type":"string","enum":["private","public"]},"codeVersion":{"type":"string"},"tools":{"type":"array","items":{"$ref":"#/components/schemas/PolicyToolDTO"}},"createDate":{"type":"string"},"version":{"type":"string"},"originalChanged":{"type":"string"},"editableParametersSettings":{"type":"array","items":{"$ref":"#/components/schemas/PolicyEditableFieldDTO"}},"config":{"type":"object","additionalProperties":true},"userRole":{"type":"string"},"userRoles":{"type":"array","items":{"type":"string"}},"userGroup":{"type":"object","additionalProperties":true,"nullable":true,"description":"Last active group in iteration order (not a separate summary). Often shown via groupLabel or uuid."},"userGroups":{"additionalProperties":true,"description":"Full list of group rows for this user in the policy (getGroupsByUser), including inactive.","type":"array","items":{"type":"object"}},"policyRoles":{"type":"array","items":{"type":"string"}},"policyNavigation":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTopics":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTokens":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyGroups":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyDocumentation":{"additionalProperties":true,"description":"User-configured policy API documentation entries. The `alias` may be a single slug (`create-device`) or a path of slugs separated by `/` (`monitoring-reports/create`).","type":"array","items":{"type":"object"}},"categories":{"type":"array","items":{"type":"string"}},"projectSchema":{"type":"string"},"tests":{"type":"array","items":{"$ref":"#/components/schemas/PolicyTestDTO"}},"ignoreRules":{"description":"Validation-only rules to hide matching warnings/infos (not persisted)","type":"array","items":{"$ref":"#/components/schemas/IgnoreRuleDTO"}}},"required":["id","uuid","name","description","topicDescription","policyTag","status","creator","owner","topicId","instanceTopicId","messageId","codeVersion","tools","createDate","version","editableParametersSettings","config","userRole","userRoles","userGroup","userGroups","policyRoles","policyNavigation","policyTopics","policyTokens","policyGroups","policyDocumentation","categories","projectSchema","tests"]},"PolicyImportantParametersDTO":{"type":"object","properties":{"atValidation":{"type":"string"},"monitored":{"type":"string"}}},"PolicyToolDTO":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string","nullable":true},"topicId":{"type":"string"},"messageId":{"type":"string"}},"required":["name","topicId","messageId"]},"PolicyEditableFieldDTO":{"type":"object","properties":{}},"PolicyTestDTO":{"type":"object","properties":{"id":{"type":"string","description":"Test ID"},"uuid":{"type":"string","description":"Test UUID"},"name":{"type":"string","description":"Test Name"},"policyId":{"type":"string","description":"Policy ID"},"owner":{"type":"string","description":"Test owner"},"status":{"type":"string","description":"Test status","enum":["New","Running","Stopped","Success","Failure"]},"date":{"type":"string","description":"Last start date"},"duration":{"type":"string","description":"Test duration"},"progress":{"type":"string","description":"Test progress"},"resultId":{"type":"string","description":"Test result"},"result":{"type":"string","description":"Test result"}},"required":["id","uuid","name","policyId","owner","status","date","duration","progress","resultId","result"]},"IgnoreRuleDTO":{"type":"object","properties":{"code":{"type":"string","description":"Stable message code, e.g. DEPRECATION_BLOCK"},"blockType":{"type":"string","description":"Limit by block type"},"property":{"type":"string","description":"Limit by property"},"contains":{"type":"string","description":"Substring filter applied to message text"},"severity":{"type":"string","description":"Type of message","enum":["warning","info"]}}},"SchemaDTO":{"type":"object","properties":{"createDate":{"type":"string","nullable":true},"updateDate":{"type":"string","nullable":true},"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"entity":{"type":"string","enum":["NONE","VC","EVC","STANDARD_REGISTRY","USER","POLICY","MINT_TOKEN","INTEGRATION_DATA_V2","RETIRE","WIPE_TOKEN","MINT_NFTOKEN","ISSUER","USER_ROLE","CHUNK","ACTIVITY_IMPACT","TOKEN_DATA_SOURCE","ROLE","USER_PERMISSIONS","POLICY_DISCUSSION_V2","POLICY_COMMENT","POLICY_EXPORT_PROOF","EVIDENCE_ATTACHMENTS"]},"iri":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","UNPUBLISHED","ERROR","DEMO","VIEW"]},"topicId":{"type":"string"},"version":{"type":"string"},"creator":{"type":"string","nullable":true},"owner":{"type":"string"},"messageId":{"type":"string","nullable":true},"category":{"type":"string","enum":["POLICY","MODULE","SYSTEM","TAG","TOOL","STATISTIC","LABEL"]},"documentURL":{"type":"string"},"contextURL":{"type":"string"},"document":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"context":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"readonly":{"type":"boolean","nullable":true},"system":{"type":"boolean","nullable":true},"active":{"type":"boolean","nullable":true},"codeVersion":{"type":"string","nullable":true},"topicCount":{"type":"number","nullable":true}},"required":["id","uuid","name","description","entity","iri","status","topicId","version","owner","category","documentURL","contextURL","document","context"]}}}} ``` ## The StatisticAssessmentDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"StatisticAssessmentDTO":{"type":"object","properties":{"id":{"type":"string"},"definitionId":{"type":"string"},"policyId":{"type":"string"},"policyTopicId":{"type":"string"},"policyInstanceTopicId":{"type":"string"},"topicId":{"type":"string"},"creator":{"type":"string"},"owner":{"type":"string"},"messageId":{"type":"string"},"target":{"type":"string"},"relationships":{"type":"array","items":{"type":"string"}},"document":{"type":"object","nullable":true,"additionalProperties":true}},"required":["document"]}}}} ``` ## The StatisticAssessmentRelationshipsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"StatisticAssessmentRelationshipsDTO":{"type":"object","properties":{"target":{"$ref":"#/components/schemas/VcDocumentDTO"},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/VcDocumentDTO"}}}},"VcDocumentDTO":{"type":"object","properties":{"id":{"type":"string"},"policyId":{"type":"string"},"hash":{"type":"string"},"signature":{"type":"number"},"status":{"type":"string","enum":["NEW","ISSUE","REVOKE","SUSPEND","RESUME","FAILED"]},"tag":{"type":"string"},"type":{"type":"string"},"createDate":{"type":"string"},"updateDate":{"type":"string"},"owner":{"type":"string"},"hederaStatus":{"type":"string"},"option":{"type":"object","additionalProperties":true},"topicId":{"type":"string"},"messageId":{"type":"string"},"document":{"$ref":"#/components/schemas/VcDTO"}}},"VcDTO":{"type":"object","properties":{"id":{"type":"string","nullable":true},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"credentialSubject":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"issuer":{"oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]},"issuanceDate":{"type":"string"},"proof":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ProofDTO"}]}},"required":["id","@context","type","credentialSubject","issuer","issuanceDate","proof"]},"ProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]}}}} ``` ## The SchemaRuleDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SchemaRuleDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"creator":{"type":"string"},"owner":{"type":"string"},"policyId":{"type":"string"},"policyTopicId":{"type":"string"},"policyInstanceTopicId":{"type":"string"},"status":{"type":"string","enum":["DRAFT","DRY_RUN","PUBLISHED","ERROR","ACTIVE"]},"config":{"type":"object","nullable":true,"additionalProperties":true}},"required":["name","config"]}}}} ``` ## The SchemaRuleRelationshipsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SchemaRuleRelationshipsDTO":{"type":"object","properties":{"policy":{"$ref":"#/components/schemas/PolicyDTO"},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/SchemaDTO"}}}},"PolicyDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"topicDescription":{"type":"string"},"applicabilityConditions":{"type":"string"},"detailsUrl":{"type":"string"},"typicalProjects":{"type":"string"},"importantParameters":{"$ref":"#/components/schemas/PolicyImportantParametersDTO"},"policyTag":{"type":"string"},"status":{"type":"string","enum":["DRY-RUN","DRAFT","PUBLISH_ERROR","PUBLISH","DISCONTINUED","DEMO","VIEW"]},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"instanceTopicId":{"type":"string"},"messageId":{"type":"string"},"availability":{"type":"string","enum":["private","public"]},"codeVersion":{"type":"string"},"tools":{"type":"array","items":{"$ref":"#/components/schemas/PolicyToolDTO"}},"createDate":{"type":"string"},"version":{"type":"string"},"originalChanged":{"type":"string"},"editableParametersSettings":{"type":"array","items":{"$ref":"#/components/schemas/PolicyEditableFieldDTO"}},"config":{"type":"object","additionalProperties":true},"userRole":{"type":"string"},"userRoles":{"type":"array","items":{"type":"string"}},"userGroup":{"type":"object","additionalProperties":true,"nullable":true,"description":"Last active group in iteration order (not a separate summary). Often shown via groupLabel or uuid."},"userGroups":{"additionalProperties":true,"description":"Full list of group rows for this user in the policy (getGroupsByUser), including inactive.","type":"array","items":{"type":"object"}},"policyRoles":{"type":"array","items":{"type":"string"}},"policyNavigation":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTopics":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTokens":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyGroups":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyDocumentation":{"additionalProperties":true,"description":"User-configured policy API documentation entries. The `alias` may be a single slug (`create-device`) or a path of slugs separated by `/` (`monitoring-reports/create`).","type":"array","items":{"type":"object"}},"categories":{"type":"array","items":{"type":"string"}},"projectSchema":{"type":"string"},"tests":{"type":"array","items":{"$ref":"#/components/schemas/PolicyTestDTO"}},"ignoreRules":{"description":"Validation-only rules to hide matching warnings/infos (not persisted)","type":"array","items":{"$ref":"#/components/schemas/IgnoreRuleDTO"}}},"required":["id","uuid","name","description","topicDescription","policyTag","status","creator","owner","topicId","instanceTopicId","messageId","codeVersion","tools","createDate","version","editableParametersSettings","config","userRole","userRoles","userGroup","userGroups","policyRoles","policyNavigation","policyTopics","policyTokens","policyGroups","policyDocumentation","categories","projectSchema","tests"]},"PolicyImportantParametersDTO":{"type":"object","properties":{"atValidation":{"type":"string"},"monitored":{"type":"string"}}},"PolicyToolDTO":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string","nullable":true},"topicId":{"type":"string"},"messageId":{"type":"string"}},"required":["name","topicId","messageId"]},"PolicyEditableFieldDTO":{"type":"object","properties":{}},"PolicyTestDTO":{"type":"object","properties":{"id":{"type":"string","description":"Test ID"},"uuid":{"type":"string","description":"Test UUID"},"name":{"type":"string","description":"Test Name"},"policyId":{"type":"string","description":"Policy ID"},"owner":{"type":"string","description":"Test owner"},"status":{"type":"string","description":"Test status","enum":["New","Running","Stopped","Success","Failure"]},"date":{"type":"string","description":"Last start date"},"duration":{"type":"string","description":"Test duration"},"progress":{"type":"string","description":"Test progress"},"resultId":{"type":"string","description":"Test result"},"result":{"type":"string","description":"Test result"}},"required":["id","uuid","name","policyId","owner","status","date","duration","progress","resultId","result"]},"IgnoreRuleDTO":{"type":"object","properties":{"code":{"type":"string","description":"Stable message code, e.g. DEPRECATION_BLOCK"},"blockType":{"type":"string","description":"Limit by block type"},"property":{"type":"string","description":"Limit by property"},"contains":{"type":"string","description":"Substring filter applied to message text"},"severity":{"type":"string","description":"Type of message","enum":["warning","info"]}}},"SchemaDTO":{"type":"object","properties":{"createDate":{"type":"string","nullable":true},"updateDate":{"type":"string","nullable":true},"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"entity":{"type":"string","enum":["NONE","VC","EVC","STANDARD_REGISTRY","USER","POLICY","MINT_TOKEN","INTEGRATION_DATA_V2","RETIRE","WIPE_TOKEN","MINT_NFTOKEN","ISSUER","USER_ROLE","CHUNK","ACTIVITY_IMPACT","TOKEN_DATA_SOURCE","ROLE","USER_PERMISSIONS","POLICY_DISCUSSION_V2","POLICY_COMMENT","POLICY_EXPORT_PROOF","EVIDENCE_ATTACHMENTS"]},"iri":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","UNPUBLISHED","ERROR","DEMO","VIEW"]},"topicId":{"type":"string"},"version":{"type":"string"},"creator":{"type":"string","nullable":true},"owner":{"type":"string"},"messageId":{"type":"string","nullable":true},"category":{"type":"string","enum":["POLICY","MODULE","SYSTEM","TAG","TOOL","STATISTIC","LABEL"]},"documentURL":{"type":"string"},"contextURL":{"type":"string"},"document":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"context":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"readonly":{"type":"boolean","nullable":true},"system":{"type":"boolean","nullable":true},"active":{"type":"boolean","nullable":true},"codeVersion":{"type":"string","nullable":true},"topicCount":{"type":"number","nullable":true}},"required":["id","uuid","name","description","entity","iri","status","topicId","version","owner","category","documentURL","contextURL","document","context"]}}}} ``` ## The SchemaRuleOptionsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SchemaRuleOptionsDTO":{"type":"object","properties":{"policyId":{"type":"string"},"schemaId":{"type":"string"},"documentId":{"type":"string"},"parentId":{"type":"string"}}}}}} ``` ## The SchemaRuleDataDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"SchemaRuleDataDTO":{"type":"object","properties":{"rules":{"$ref":"#/components/schemas/SchemaRuleDTO"},"document":{"$ref":"#/components/schemas/VcDocumentDTO"},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/VcDocumentDTO"}}}},"SchemaRuleDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"creator":{"type":"string"},"owner":{"type":"string"},"policyId":{"type":"string"},"policyTopicId":{"type":"string"},"policyInstanceTopicId":{"type":"string"},"status":{"type":"string","enum":["DRAFT","DRY_RUN","PUBLISHED","ERROR","ACTIVE"]},"config":{"type":"object","nullable":true,"additionalProperties":true}},"required":["name","config"]},"VcDocumentDTO":{"type":"object","properties":{"id":{"type":"string"},"policyId":{"type":"string"},"hash":{"type":"string"},"signature":{"type":"number"},"status":{"type":"string","enum":["NEW","ISSUE","REVOKE","SUSPEND","RESUME","FAILED"]},"tag":{"type":"string"},"type":{"type":"string"},"createDate":{"type":"string"},"updateDate":{"type":"string"},"owner":{"type":"string"},"hederaStatus":{"type":"string"},"option":{"type":"object","additionalProperties":true},"topicId":{"type":"string"},"messageId":{"type":"string"},"document":{"$ref":"#/components/schemas/VcDTO"}}},"VcDTO":{"type":"object","properties":{"id":{"type":"string","nullable":true},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"credentialSubject":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"issuer":{"oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]},"issuanceDate":{"type":"string"},"proof":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ProofDTO"}]}},"required":["id","@context","type","credentialSubject","issuer","issuanceDate","proof"]},"ProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]}}}} ``` ## The FormulaDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"FormulaDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"creator":{"type":"string"},"owner":{"type":"string"},"messageId":{"type":"string"},"policyId":{"type":"string"},"policyTopicId":{"type":"string"},"policyInstanceTopicId":{"type":"string"},"status":{"type":"string","enum":["DRAFT","DRY_RUN","PUBLISHED","ERROR","ACTIVE"]},"config":{"type":"object","nullable":true,"additionalProperties":true}},"required":["name","config"]}}}} ``` ## The FormulaRelationshipsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"FormulaRelationshipsDTO":{"type":"object","properties":{"policy":{"$ref":"#/components/schemas/PolicyDTO"},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/SchemaDTO"}},"formulas":{"type":"array","items":{"$ref":"#/components/schemas/FormulaDTO"}}}},"PolicyDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"topicDescription":{"type":"string"},"applicabilityConditions":{"type":"string"},"detailsUrl":{"type":"string"},"typicalProjects":{"type":"string"},"importantParameters":{"$ref":"#/components/schemas/PolicyImportantParametersDTO"},"policyTag":{"type":"string"},"status":{"type":"string","enum":["DRY-RUN","DRAFT","PUBLISH_ERROR","PUBLISH","DISCONTINUED","DEMO","VIEW"]},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"instanceTopicId":{"type":"string"},"messageId":{"type":"string"},"availability":{"type":"string","enum":["private","public"]},"codeVersion":{"type":"string"},"tools":{"type":"array","items":{"$ref":"#/components/schemas/PolicyToolDTO"}},"createDate":{"type":"string"},"version":{"type":"string"},"originalChanged":{"type":"string"},"editableParametersSettings":{"type":"array","items":{"$ref":"#/components/schemas/PolicyEditableFieldDTO"}},"config":{"type":"object","additionalProperties":true},"userRole":{"type":"string"},"userRoles":{"type":"array","items":{"type":"string"}},"userGroup":{"type":"object","additionalProperties":true,"nullable":true,"description":"Last active group in iteration order (not a separate summary). Often shown via groupLabel or uuid."},"userGroups":{"additionalProperties":true,"description":"Full list of group rows for this user in the policy (getGroupsByUser), including inactive.","type":"array","items":{"type":"object"}},"policyRoles":{"type":"array","items":{"type":"string"}},"policyNavigation":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTopics":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTokens":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyGroups":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyDocumentation":{"additionalProperties":true,"description":"User-configured policy API documentation entries. The `alias` may be a single slug (`create-device`) or a path of slugs separated by `/` (`monitoring-reports/create`).","type":"array","items":{"type":"object"}},"categories":{"type":"array","items":{"type":"string"}},"projectSchema":{"type":"string"},"tests":{"type":"array","items":{"$ref":"#/components/schemas/PolicyTestDTO"}},"ignoreRules":{"description":"Validation-only rules to hide matching warnings/infos (not persisted)","type":"array","items":{"$ref":"#/components/schemas/IgnoreRuleDTO"}}},"required":["id","uuid","name","description","topicDescription","policyTag","status","creator","owner","topicId","instanceTopicId","messageId","codeVersion","tools","createDate","version","editableParametersSettings","config","userRole","userRoles","userGroup","userGroups","policyRoles","policyNavigation","policyTopics","policyTokens","policyGroups","policyDocumentation","categories","projectSchema","tests"]},"PolicyImportantParametersDTO":{"type":"object","properties":{"atValidation":{"type":"string"},"monitored":{"type":"string"}}},"PolicyToolDTO":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string","nullable":true},"topicId":{"type":"string"},"messageId":{"type":"string"}},"required":["name","topicId","messageId"]},"PolicyEditableFieldDTO":{"type":"object","properties":{}},"PolicyTestDTO":{"type":"object","properties":{"id":{"type":"string","description":"Test ID"},"uuid":{"type":"string","description":"Test UUID"},"name":{"type":"string","description":"Test Name"},"policyId":{"type":"string","description":"Policy ID"},"owner":{"type":"string","description":"Test owner"},"status":{"type":"string","description":"Test status","enum":["New","Running","Stopped","Success","Failure"]},"date":{"type":"string","description":"Last start date"},"duration":{"type":"string","description":"Test duration"},"progress":{"type":"string","description":"Test progress"},"resultId":{"type":"string","description":"Test result"},"result":{"type":"string","description":"Test result"}},"required":["id","uuid","name","policyId","owner","status","date","duration","progress","resultId","result"]},"IgnoreRuleDTO":{"type":"object","properties":{"code":{"type":"string","description":"Stable message code, e.g. DEPRECATION_BLOCK"},"blockType":{"type":"string","description":"Limit by block type"},"property":{"type":"string","description":"Limit by property"},"contains":{"type":"string","description":"Substring filter applied to message text"},"severity":{"type":"string","description":"Type of message","enum":["warning","info"]}}},"SchemaDTO":{"type":"object","properties":{"createDate":{"type":"string","nullable":true},"updateDate":{"type":"string","nullable":true},"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"entity":{"type":"string","enum":["NONE","VC","EVC","STANDARD_REGISTRY","USER","POLICY","MINT_TOKEN","INTEGRATION_DATA_V2","RETIRE","WIPE_TOKEN","MINT_NFTOKEN","ISSUER","USER_ROLE","CHUNK","ACTIVITY_IMPACT","TOKEN_DATA_SOURCE","ROLE","USER_PERMISSIONS","POLICY_DISCUSSION_V2","POLICY_COMMENT","POLICY_EXPORT_PROOF","EVIDENCE_ATTACHMENTS"]},"iri":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","UNPUBLISHED","ERROR","DEMO","VIEW"]},"topicId":{"type":"string"},"version":{"type":"string"},"creator":{"type":"string","nullable":true},"owner":{"type":"string"},"messageId":{"type":"string","nullable":true},"category":{"type":"string","enum":["POLICY","MODULE","SYSTEM","TAG","TOOL","STATISTIC","LABEL"]},"documentURL":{"type":"string"},"contextURL":{"type":"string"},"document":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"context":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"readonly":{"type":"boolean","nullable":true},"system":{"type":"boolean","nullable":true},"active":{"type":"boolean","nullable":true},"codeVersion":{"type":"string","nullable":true},"topicCount":{"type":"number","nullable":true}},"required":["id","uuid","name","description","entity","iri","status","topicId","version","owner","category","documentURL","contextURL","document","context"]},"FormulaDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"creator":{"type":"string"},"owner":{"type":"string"},"messageId":{"type":"string"},"policyId":{"type":"string"},"policyTopicId":{"type":"string"},"policyInstanceTopicId":{"type":"string"},"status":{"type":"string","enum":["DRAFT","DRY_RUN","PUBLISHED","ERROR","ACTIVE"]},"config":{"type":"object","nullable":true,"additionalProperties":true}},"required":["name","config"]}}}} ``` ## The FormulasDataDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"FormulasDataDTO":{"type":"object","properties":{"formulas":{"type":"array","items":{"$ref":"#/components/schemas/FormulaDTO"}},"document":{"$ref":"#/components/schemas/VcDocumentDTO"},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/VcDocumentDTO"}},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/SchemaDTO"}}}},"FormulaDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"creator":{"type":"string"},"owner":{"type":"string"},"messageId":{"type":"string"},"policyId":{"type":"string"},"policyTopicId":{"type":"string"},"policyInstanceTopicId":{"type":"string"},"status":{"type":"string","enum":["DRAFT","DRY_RUN","PUBLISHED","ERROR","ACTIVE"]},"config":{"type":"object","nullable":true,"additionalProperties":true}},"required":["name","config"]},"VcDocumentDTO":{"type":"object","properties":{"id":{"type":"string"},"policyId":{"type":"string"},"hash":{"type":"string"},"signature":{"type":"number"},"status":{"type":"string","enum":["NEW","ISSUE","REVOKE","SUSPEND","RESUME","FAILED"]},"tag":{"type":"string"},"type":{"type":"string"},"createDate":{"type":"string"},"updateDate":{"type":"string"},"owner":{"type":"string"},"hederaStatus":{"type":"string"},"option":{"type":"object","additionalProperties":true},"topicId":{"type":"string"},"messageId":{"type":"string"},"document":{"$ref":"#/components/schemas/VcDTO"}}},"VcDTO":{"type":"object","properties":{"id":{"type":"string","nullable":true},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"credentialSubject":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"issuer":{"oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]},"issuanceDate":{"type":"string"},"proof":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ProofDTO"}]}},"required":["id","@context","type","credentialSubject","issuer","issuanceDate","proof"]},"ProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]},"SchemaDTO":{"type":"object","properties":{"createDate":{"type":"string","nullable":true},"updateDate":{"type":"string","nullable":true},"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"entity":{"type":"string","enum":["NONE","VC","EVC","STANDARD_REGISTRY","USER","POLICY","MINT_TOKEN","INTEGRATION_DATA_V2","RETIRE","WIPE_TOKEN","MINT_NFTOKEN","ISSUER","USER_ROLE","CHUNK","ACTIVITY_IMPACT","TOKEN_DATA_SOURCE","ROLE","USER_PERMISSIONS","POLICY_DISCUSSION_V2","POLICY_COMMENT","POLICY_EXPORT_PROOF","EVIDENCE_ATTACHMENTS"]},"iri":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","UNPUBLISHED","ERROR","DEMO","VIEW"]},"topicId":{"type":"string"},"version":{"type":"string"},"creator":{"type":"string","nullable":true},"owner":{"type":"string"},"messageId":{"type":"string","nullable":true},"category":{"type":"string","enum":["POLICY","MODULE","SYSTEM","TAG","TOOL","STATISTIC","LABEL"]},"documentURL":{"type":"string"},"contextURL":{"type":"string"},"document":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"context":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"readonly":{"type":"boolean","nullable":true},"system":{"type":"boolean","nullable":true},"active":{"type":"boolean","nullable":true},"codeVersion":{"type":"string","nullable":true},"topicCount":{"type":"number","nullable":true}},"required":["id","uuid","name","description","entity","iri","status","topicId","version","owner","category","documentURL","contextURL","document","context"]}}}} ``` ## The FormulasOptionsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"FormulasOptionsDTO":{"type":"object","properties":{"policyId":{"type":"string"},"schemaId":{"type":"string"},"documentId":{"type":"string"},"parentId":{"type":"string"}}}}}} ``` ## The ExternalPolicyDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ExternalPolicyDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"Policy UUID"},"name":{"type":"string","description":"Policy name"},"description":{"type":"string","description":"Policy description"},"version":{"type":"string","description":"Policy version"},"topicId":{"type":"string","description":"Policy topic id"},"instanceTopicId":{"type":"string","description":"Policy instance topic id"},"messageId":{"type":"string","description":"Policy message id"},"policyTag":{"type":"string","description":"Policy tag"},"owner":{"type":"string","description":"Policy owner"},"status":{"type":"string","enum":["NEW","APPROVED","REJECTED"]},"username":{"type":"string","description":"Username"}},"required":["uuid","name","description","version","topicId","instanceTopicId","messageId","policyTag","owner","status","username"]}}}} ``` ## The PolicyRequestDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyRequestDTO":{"type":"object","properties":{"uuid":{"type":"string","description":"Action UUID"},"type":{"type":"string","description":"Action type","enum":["ACTION","REQUEST","REMOTE_ACTION"]},"messageId":{"type":"string","description":"Action message id"},"startMessageId":{"type":"string","description":"Action start message id"},"status":{"type":"string","description":"Action status","enum":["NEW","ERROR","COMPLETED","REJECTED","CANCELED"]},"lastStatus":{"type":"string","description":"Action last status","enum":["NEW","ERROR","COMPLETED","REJECTED","CANCELED"]},"accountId":{"type":"string","description":"Action owner"},"sender":{"type":"string","description":"Message sender"},"owner":{"type":"string","description":"Action owner"},"topicId":{"type":"string","description":"Action topic id"},"document":{"type":"object","description":"Action data","additionalProperties":true},"policyId":{"type":"string","description":"Policy UU"},"blockTag":{"type":"string","description":"Block tag"},"policyMessageId":{"type":"string","description":"Policy message id"},"loaded":{"type":"boolean","description":"File is loaded"}},"required":["uuid","type","messageId","startMessageId","status","lastStatus","accountId","sender","owner","topicId","document","policyId","blockTag","policyMessageId","loaded"]}}}} ``` ## The PolicyRequestCountDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyRequestCountDTO":{"type":"object","properties":{"requestsCount":{"type":"number","description":"Number of new requests"},"actionsCount":{"type":"number","description":"Number of new actions"},"delayCount":{"type":"number","description":"Number of recent actions"},"total":{"type":"number","description":"Total"}},"required":["requestsCount","actionsCount","delayCount","total"]}}}} ``` ## The PolicyLabelDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyLabelDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"messageId":{"type":"string"},"policyId":{"type":"string"},"policyTopicId":{"type":"string"},"policyInstanceTopicId":{"type":"string"},"status":{"type":"string","enum":["DRAFT","DRY_RUN","PUBLISHED","ERROR","ACTIVE"]},"config":{"type":"object","additionalProperties":true,"nullable":true}},"required":["name","config"]}}}} ``` ## The PolicyLabelRelationshipsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyLabelRelationshipsDTO":{"type":"object","properties":{"policy":{"$ref":"#/components/schemas/PolicyDTO"},"policySchemas":{"type":"array","items":{"$ref":"#/components/schemas/SchemaDTO"}},"documentsSchemas":{"type":"array","items":{"$ref":"#/components/schemas/SchemaDTO"}}}},"PolicyDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"topicDescription":{"type":"string"},"applicabilityConditions":{"type":"string"},"detailsUrl":{"type":"string"},"typicalProjects":{"type":"string"},"importantParameters":{"$ref":"#/components/schemas/PolicyImportantParametersDTO"},"policyTag":{"type":"string"},"status":{"type":"string","enum":["DRY-RUN","DRAFT","PUBLISH_ERROR","PUBLISH","DISCONTINUED","DEMO","VIEW"]},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"instanceTopicId":{"type":"string"},"messageId":{"type":"string"},"availability":{"type":"string","enum":["private","public"]},"codeVersion":{"type":"string"},"tools":{"type":"array","items":{"$ref":"#/components/schemas/PolicyToolDTO"}},"createDate":{"type":"string"},"version":{"type":"string"},"originalChanged":{"type":"string"},"editableParametersSettings":{"type":"array","items":{"$ref":"#/components/schemas/PolicyEditableFieldDTO"}},"config":{"type":"object","additionalProperties":true},"userRole":{"type":"string"},"userRoles":{"type":"array","items":{"type":"string"}},"userGroup":{"type":"object","additionalProperties":true,"nullable":true,"description":"Last active group in iteration order (not a separate summary). Often shown via groupLabel or uuid."},"userGroups":{"additionalProperties":true,"description":"Full list of group rows for this user in the policy (getGroupsByUser), including inactive.","type":"array","items":{"type":"object"}},"policyRoles":{"type":"array","items":{"type":"string"}},"policyNavigation":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTopics":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyTokens":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyGroups":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"policyDocumentation":{"additionalProperties":true,"description":"User-configured policy API documentation entries. The `alias` may be a single slug (`create-device`) or a path of slugs separated by `/` (`monitoring-reports/create`).","type":"array","items":{"type":"object"}},"categories":{"type":"array","items":{"type":"string"}},"projectSchema":{"type":"string"},"tests":{"type":"array","items":{"$ref":"#/components/schemas/PolicyTestDTO"}},"ignoreRules":{"description":"Validation-only rules to hide matching warnings/infos (not persisted)","type":"array","items":{"$ref":"#/components/schemas/IgnoreRuleDTO"}}},"required":["id","uuid","name","description","topicDescription","policyTag","status","creator","owner","topicId","instanceTopicId","messageId","codeVersion","tools","createDate","version","editableParametersSettings","config","userRole","userRoles","userGroup","userGroups","policyRoles","policyNavigation","policyTopics","policyTokens","policyGroups","policyDocumentation","categories","projectSchema","tests"]},"PolicyImportantParametersDTO":{"type":"object","properties":{"atValidation":{"type":"string"},"monitored":{"type":"string"}}},"PolicyToolDTO":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string","nullable":true},"topicId":{"type":"string"},"messageId":{"type":"string"}},"required":["name","topicId","messageId"]},"PolicyEditableFieldDTO":{"type":"object","properties":{}},"PolicyTestDTO":{"type":"object","properties":{"id":{"type":"string","description":"Test ID"},"uuid":{"type":"string","description":"Test UUID"},"name":{"type":"string","description":"Test Name"},"policyId":{"type":"string","description":"Policy ID"},"owner":{"type":"string","description":"Test owner"},"status":{"type":"string","description":"Test status","enum":["New","Running","Stopped","Success","Failure"]},"date":{"type":"string","description":"Last start date"},"duration":{"type":"string","description":"Test duration"},"progress":{"type":"string","description":"Test progress"},"resultId":{"type":"string","description":"Test result"},"result":{"type":"string","description":"Test result"}},"required":["id","uuid","name","policyId","owner","status","date","duration","progress","resultId","result"]},"IgnoreRuleDTO":{"type":"object","properties":{"code":{"type":"string","description":"Stable message code, e.g. DEPRECATION_BLOCK"},"blockType":{"type":"string","description":"Limit by block type"},"property":{"type":"string","description":"Limit by property"},"contains":{"type":"string","description":"Substring filter applied to message text"},"severity":{"type":"string","description":"Type of message","enum":["warning","info"]}}},"SchemaDTO":{"type":"object","properties":{"createDate":{"type":"string","nullable":true},"updateDate":{"type":"string","nullable":true},"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"entity":{"type":"string","enum":["NONE","VC","EVC","STANDARD_REGISTRY","USER","POLICY","MINT_TOKEN","INTEGRATION_DATA_V2","RETIRE","WIPE_TOKEN","MINT_NFTOKEN","ISSUER","USER_ROLE","CHUNK","ACTIVITY_IMPACT","TOKEN_DATA_SOURCE","ROLE","USER_PERMISSIONS","POLICY_DISCUSSION_V2","POLICY_COMMENT","POLICY_EXPORT_PROOF","EVIDENCE_ATTACHMENTS"]},"iri":{"type":"string"},"status":{"type":"string","enum":["DRAFT","PUBLISHED","UNPUBLISHED","ERROR","DEMO","VIEW"]},"topicId":{"type":"string"},"version":{"type":"string"},"creator":{"type":"string","nullable":true},"owner":{"type":"string"},"messageId":{"type":"string","nullable":true},"category":{"type":"string","enum":["POLICY","MODULE","SYSTEM","TAG","TOOL","STATISTIC","LABEL"]},"documentURL":{"type":"string"},"contextURL":{"type":"string"},"document":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"context":{"oneOf":[{"type":"object","additionalProperties":true},{"type":"string"}]},"readonly":{"type":"boolean","nullable":true},"system":{"type":"boolean","nullable":true},"active":{"type":"boolean","nullable":true},"codeVersion":{"type":"string","nullable":true},"topicCount":{"type":"number","nullable":true}},"required":["id","uuid","name","description","entity","iri","status","topicId","version","owner","category","documentURL","contextURL","document","context"]}}}} ``` ## The PolicyLabelFiltersDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyLabelFiltersDTO":{"type":"object","properties":{"text":{"type":"string"},"owner":{"type":"string"},"components":{"type":"string","description":"Component type","enum":["all","label","statistic"]}}}}}} ``` ## The PolicyLabelComponentsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyLabelComponentsDTO":{"type":"object","properties":{"statistics":{"type":"array","items":{"$ref":"#/components/schemas/StatisticDefinitionDTO"}},"labels":{"type":"array","items":{"$ref":"#/components/schemas/PolicyLabelDTO"}}}},"StatisticDefinitionDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"messageId":{"type":"string"},"policyId":{"type":"string"},"policyTopicId":{"type":"string"},"policyInstanceTopicId":{"type":"string"},"status":{"type":"string","enum":["DRAFT","DRY_RUN","PUBLISHED","ERROR","ACTIVE"]},"config":{"type":"object","nullable":true,"additionalProperties":true}},"required":["name","config"]},"PolicyLabelDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"messageId":{"type":"string"},"policyId":{"type":"string"},"policyTopicId":{"type":"string"},"policyInstanceTopicId":{"type":"string"},"status":{"type":"string","enum":["DRAFT","DRY_RUN","PUBLISHED","ERROR","ACTIVE"]},"config":{"type":"object","additionalProperties":true,"nullable":true}},"required":["name","config"]}}}} ``` ## The PolicyLabelDocumentDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyLabelDocumentDTO":{"type":"object","properties":{"id":{"type":"string"},"definitionId":{"type":"string"},"policyId":{"type":"string"},"policyTopicId":{"type":"string"},"policyInstanceTopicId":{"type":"string"},"topicId":{"type":"string"},"creator":{"type":"string"},"owner":{"type":"string"},"messageId":{"type":"string"},"target":{"type":"string"},"relationships":{"type":"array","items":{"type":"string"}},"document":{"type":"object","nullable":true,"additionalProperties":true}},"required":["document"]}}}} ``` ## The PolicyLabelDocumentRelationshipsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyLabelDocumentRelationshipsDTO":{"type":"object","properties":{"target":{"$ref":"#/components/schemas/VpDocumentDTO"},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/VcDocumentDTO"}}}},"VpDocumentDTO":{"type":"object","properties":{"id":{"type":"string"},"policyId":{"type":"string"},"hash":{"type":"string"},"signature":{"type":"number"},"status":{"type":"string","enum":["NEW","ISSUE","REVOKE","SUSPEND","RESUME","FAILED"]},"tag":{"type":"string"},"type":{"type":"string"},"createDate":{"type":"string"},"updateDate":{"type":"string"},"owner":{"type":"string"},"document":{"$ref":"#/components/schemas/VpDTO"}},"required":["id","policyId","hash","signature","status","tag","type","createDate","updateDate","owner","document"]},"VpDTO":{"type":"object","properties":{"@context":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"type":{"type":"array","items":{"type":"string"}},"verifiableCredential":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"proof":{"$ref":"#/components/schemas/ProofDTO"}},"required":["@context","id","type","verifiableCredential","proof"]},"ProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]},"VcDocumentDTO":{"type":"object","properties":{"id":{"type":"string"},"policyId":{"type":"string"},"hash":{"type":"string"},"signature":{"type":"number"},"status":{"type":"string","enum":["NEW","ISSUE","REVOKE","SUSPEND","RESUME","FAILED"]},"tag":{"type":"string"},"type":{"type":"string"},"createDate":{"type":"string"},"updateDate":{"type":"string"},"owner":{"type":"string"},"hederaStatus":{"type":"string"},"option":{"type":"object","additionalProperties":true},"topicId":{"type":"string"},"messageId":{"type":"string"},"document":{"$ref":"#/components/schemas/VcDTO"}}},"VcDTO":{"type":"object","properties":{"id":{"type":"string","nullable":true},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"credentialSubject":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"issuer":{"oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]},"issuanceDate":{"type":"string"},"proof":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ProofDTO"}]}},"required":["id","@context","type","credentialSubject","issuer","issuanceDate","proof"]}}}} ``` ## The PolicyCommentUserDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyCommentUserDTO":{"type":"object","properties":{"label":{"type":"string","description":"Display name (username for users, role name for roles, \"All\" for broadcast)"},"value":{"type":"string","description":"Value to use when targeting (DID for users, role name for roles, \"all\" for broadcast)"},"type":{"type":"string","description":"Entry type: \"all\" = broadcast to everyone, \"role\" = target by role, \"user\" = target specific user","enum":["all","role","user"]},"roles":{"description":"List of roles assigned to this user (only present when type = \"user\")","type":"array","items":{"type":"string"}}},"required":["label","value","type"]}}}} ``` ## The PolicyCommentRelationshipDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyCommentRelationshipDTO":{"type":"object","properties":{"label":{"type":"string"},"value":{"type":"string"}},"required":["label","value"]}}}} ``` ## The PolicyDiscussionDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyDiscussionDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"creator":{"type":"string"},"owner":{"type":"string"},"policyId":{"type":"string"},"target":{"type":"string"},"targetId":{"type":"string"},"messageId":{"type":"string"},"parent":{"type":"string"},"hash":{"type":"string"},"name":{"type":"string"},"field":{"type":"string"},"fieldName":{"type":"string"},"relationships":{"type":"array","items":{"type":"string"}},"relationshipIds":{"type":"array","items":{"type":"string"}},"privacy":{"type":"string","enum":["public","roles","users"]},"roles":{"type":"array","items":{"type":"string"}},"users":{"type":"array","items":{"type":"string"}},"system":{"type":"boolean"},"count":{"type":"number","description":"Number of comments in this discussion"},"document":{"nullable":false,"allOf":[{"$ref":"#/components/schemas/VcDTO"}]},"historyIds":{"description":"Array of document IDs that form the history chain for this discussion target (added by API for GET /discussions)","type":"array","items":{"type":"string"}}},"required":["id","document"]},"VcDTO":{"type":"object","properties":{"id":{"type":"string","nullable":true},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"credentialSubject":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"issuer":{"oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]},"issuanceDate":{"type":"string"},"proof":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ProofDTO"}]}},"required":["id","@context","type","credentialSubject","issuer","issuanceDate","proof"]},"ProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]}}}} ``` ## The NewPolicyDiscussionDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"NewPolicyDiscussionDTO":{"type":"object","properties":{"name":{"type":"string"},"field":{"type":"string"},"fieldName":{"type":"string"},"parent":{"type":"string"},"privacy":{"type":"string","enum":["public","roles","users"]},"roles":{"type":"array","items":{"type":"string"}},"users":{"type":"array","items":{"type":"string"}},"relationships":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The PolicyCommentDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyCommentDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"creator":{"type":"string"},"owner":{"type":"string"},"policyId":{"type":"string"},"topicId":{"type":"string"},"policyTopicId":{"type":"string"},"policyInstanceTopicId":{"type":"string"},"target":{"type":"string"},"targetId":{"type":"string"},"discussionMessageId":{"type":"string"},"discussionId":{"type":"string"},"messageId":{"type":"string"},"timestamp":{"type":"string"},"hash":{"type":"string"},"sender":{"type":"string"},"senderRole":{"type":"string"},"senderName":{"type":"string"},"recipients":{"type":"array","items":{"type":"string"}},"fields":{"type":"array","items":{"type":"string"}},"text":{"type":"string"},"document":{"nullable":false,"allOf":[{"$ref":"#/components/schemas/VcDTO"}]},"isOwner":{"type":"boolean","description":"Whether the current user is the sender of this comment (added by API, not stored in DB)"}},"required":["id","document"]},"VcDTO":{"type":"object","properties":{"id":{"type":"string","nullable":true},"@context":{"type":"array","items":{"type":"string"}},"type":{"type":"array","items":{"type":"string"}},"credentialSubject":{"additionalProperties":true,"type":"array","items":{"type":"object"}},"issuer":{"oneOf":[{"type":"string"},{"type":"object","additionalProperties":true}]},"issuanceDate":{"type":"string"},"proof":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/ProofDTO"}]}},"required":["id","@context","type","credentialSubject","issuer","issuanceDate","proof"]},"ProofDTO":{"type":"object","properties":{"type":{"type":"string"},"created":{"type":"string"},"verificationMethod":{"type":"string"},"proofPurpose":{"type":"string"},"jws":{"type":"string"}},"required":["type","created","verificationMethod","proofPurpose","jws"]}}}} ``` ## The NewPolicyCommentDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"NewPolicyCommentDTO":{"type":"object","properties":{"anchor":{"type":"string"},"recipients":{"type":"array","items":{"type":"string"}},"fields":{"type":"array","items":{"type":"string"}},"text":{"type":"string"},"files":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The PolicyCommentSearchDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyCommentSearchDTO":{"type":"object","properties":{"search":{"type":"string","description":"Search text — matches against comment text, field name, sender name, or sender role"},"field":{"type":"string","description":"Filter by schema field path (e.g. \"#schema-uuid&version/fieldName\")"},"lt":{"type":"string","description":"Cursor for pagination — return comments with _id less than this value (older comments)"},"gt":{"type":"string","description":"Cursor for pagination — return comments with _id greater than this value (newer comments)"}}}}}} ``` ## The PolicyCommentCountDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"PolicyCommentCountDTO":{"type":"object","properties":{"fields":{"type":"object","description":"Map of schema field paths to comment counts. Key = field IRI, value = number of comments on that field.","additionalProperties":{"type":"number"}},"count":{"type":"number","description":"Number of comments in this discussion"}},"required":["fields"]}}}} ``` ## The RelayerAccountDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RelayerAccountDTO":{"type":"object","properties":{"id":{"type":"string","description":"Internal database identifier"},"name":{"type":"string","description":"Human-readable name of the relayer account"},"username":{"type":"string","description":"Username of the relayer account owner"},"owner":{"type":"string","description":"DID of the relayer account owner"},"parent":{"type":"string","description":"DID of the parent Standard Registry (for child users)","nullable":true},"account":{"type":"string","description":"Hedera account ID of the relayer"},"createDate":{"type":"string","description":"Creation date in ISO 8601 format"},"updateDate":{"type":"string","description":"Last update date in ISO 8601 format"}},"required":["id"]}}}} ``` ## The NewRelayerAccountDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"NewRelayerAccountDTO":{"type":"object","properties":{"name":{"type":"string","description":"Human-readable name for the new relayer account"},"account":{"type":"string","description":"Hedera account ID to use as relayer"},"key":{"type":"string","description":"Private key for the Hedera account (stored securely in wallet)"}}}}}} ``` ## The WorkersTasksDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"WorkersTasksDTO":{"type":"object","properties":{"createDate":{"type":"string"},"done":{"type":"boolean"},"id":{"type":"string"},"isRetryableTask":{"type":"boolean"},"processedTime":{"type":"string"},"sent":{"type":"boolean"},"taskId":{"type":"string"},"type":{"type":"string"},"updateDate":{"type":"string"}},"required":["createDate","done","id","isRetryableTask","processedTime","sent","taskId","type","updateDate"]}}}} ``` ## The CredentialSubjectDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"CredentialSubjectDTO":{"type":"object","properties":{"geography":{"type":"string"},"law":{"type":"string"},"tags":{"type":"string"},"ISIC":{"type":"string"},"@context":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"type":{"type":"string"}},"required":["geography","law","tags","ISIC","@context","id","type"]}}}} ``` ## The DebugBlockHistoryDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"DebugBlockHistoryDTO":{"type":"object","properties":{"id":{"type":"string","description":"History ID"},"createDate":{"type":"string","description":"Create date"},"document":{"type":"object","description":"Input data","additionalProperties":true}},"required":["id","createDate","document"]}}}} ``` ## The FilterSchemasDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"FilterSchemasDTO":{"type":"object","properties":{"schemaId1":{"type":"string"},"schemaId2":{"type":"string"},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/FilterSchemaDTO"}},"idLvl":{"oneOf":[{"type":"string","enum":["0","1"]},{"type":"number","enum":[0,1]}]}}},"FilterSchemaDTO":{"type":"object","properties":{"type":{"type":"string","description":"Identifier type","enum":["id","policy-message","policy-file"]},"value":{"type":"string","description":"Schema ID"},"policy":{"oneOf":[{"description":"Policy Message ID","type":"string"},{"$ref":"#/components/schemas/CompareFileDTO","description":"Policy File"}]}},"required":["type","value"]},"CompareFileDTO":{"type":"object","properties":{"id":{"type":"string","description":"File ID"},"name":{"type":"string","description":"File Name"},"value":{"type":"string","description":"Buffer"}},"required":["id","name","value"]}}}} ``` ## The FilterToolsDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"FilterToolsDTO":{"type":"object","properties":{"idLvl":{"oneOf":[{"type":"string","enum":["0","1"]},{"type":"number","enum":[0,1]}]},"eventsLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"propLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"childrenLvl":{"oneOf":[{"type":"string","enum":["0","1","2"]},{"type":"number","enum":[0,1,2]}]},"toolId1":{"type":"string"},"toolId2":{"type":"string"},"toolIds":{"type":"array","items":{"type":"string"}}}}}}} ``` ## The LoginOTPRequiredResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"LoginOTPRequiredResponseDTO":{"type":"object","properties":{"success":{"type":"boolean"},"otprequired":{"type":"boolean"}},"required":["success","otprequired"]}}}} ``` ## The LoginSuccessResponseDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"LoginSuccessResponseDTO":{"type":"object","properties":{"did":{"type":"string"},"refreshToken":{"type":"string"},"role":{"type":"string"},"username":{"type":"string"},"weakPassword":{"type":"string"}},"required":["did","refreshToken","role","username","weakPassword"]}}}} ``` ## The RetireRequestTokenDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"RetireRequestTokenDTO":{"type":"object","properties":{"token":{"type":"string"},"count":{"type":"number","description":"For FT: amount to retire. For NFT: keep `0`."},"serials":{"description":"For NFT: serial numbers to retire. For FT: use empty array.","type":"array","items":{"type":"string"}}},"required":["token","count","serials"]}}}} ``` ## The ToolListV1ItemDTO object ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0-rc"},"components":{"schemas":{"ToolListV1ItemDTO":{"type":"object","properties":{"id":{"type":"string"},"uuid":{"type":"string"},"hash":{"type":"string","nullable":true,"description":"Hash (for PUBLISHED tools only)"},"name":{"type":"string"},"description":{"type":"string","nullable":true},"status":{"type":"string","enum":["DRAFT","PUBLISHED","PUBLISH_ERROR"]},"creator":{"type":"string"},"owner":{"type":"string"},"topicId":{"type":"string"},"messageId":{"type":"string","nullable":true,"description":"Message ID (for PUBLISHED tools only)"}},"required":["id","uuid","hash","name","description","status","creator","owner","topicId","messageId"]}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://dev.guardian.hedera.com/api-reference/models.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.