> 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-guardian/modules.md). # Modules ## Return a list of all modules. > Returns all modules. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"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"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/modules":{"get":{"description":"Returns all modules. Only users with the Standard Registry role are allowed to make the request.","operationId":"ModulesApi_getModulesV2_2","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"The number of pages to skip before starting to collect the result set","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"The numbers of items to return","schema":{"type":"number"}}],"responses":{"200":{"description":"Successful operation.","headers":{"X-Total-Count":{"schema":{"type":"integer"},"description":"Total items in the collection."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ModuleDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Return a list of all modules.","tags":["modules"]}}}} ``` ## Creates a new module. > Creates a new module. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"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"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/modules":{"post":{"description":"Creates a new module. Only users with the Standard Registry role are allowed to make the request.","operationId":"ModulesApi_postModules","parameters":[],"requestBody":{"required":true,"description":"Module configuration. Only config with blockType: \"module\" is required. Other fields (name, description) are optional. Fields like id, uuid, creator, owner are set by the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleDTO"}}}},"responses":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"422":{"description":"Invalid module config (missing config or config.blockType !== \"module\").","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Creates a new module.","tags":["modules"]}}}} ``` ## Return a list of all module schemas. > Returns all module schemas. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"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"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/modules/schemas":{"get":{"description":"Returns all module schemas. Only users with the Standard Registry role are allowed to make the request.","operationId":"ModulesApi_getModuleSchemas","parameters":[{"name":"pageIndex","required":false,"in":"query","description":"The number of pages to skip before starting to collect the result set","schema":{"type":"number"}},{"name":"pageSize","required":false,"in":"query","description":"The numbers of items to return","schema":{"type":"number"}},{"name":"topicId","required":false,"in":"query","description":"Filter module schemas by topic id.","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","headers":{"X-Total-Count":{"schema":{"type":"integer"},"description":"Total items in the collection."}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SchemaDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Return a list of all module schemas.","tags":["modules"]}}}} ``` ## Creates a new module schema. > Creates a new module schema. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"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"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/modules/schemas":{"post":{"description":"Creates a new module schema. Only users with the Standard Registry role are allowed to make the request.","operationId":"ModulesApi_postSchemas","parameters":[],"requestBody":{"required":true,"description":"Schema config.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaDTO"}}}},"responses":{"201":{"description":"Created schema.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SchemaDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"422":{"description":"Schema does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Creates a new module schema.","tags":["modules"]}}}} ``` ## Retrieves module configuration. > Retrieves module configuration for the specified module ID. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"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"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/modules/{uuid}":{"get":{"description":"Retrieves module configuration for the specified module ID. Only users with the Standard Registry role are allowed to make the request.","operationId":"ModulesApi_getModule","parameters":[{"name":"uuid","required":true,"in":"path","description":"Module Identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"422":{"description":"Invalid uuid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Retrieves module configuration.","tags":["modules"]}}}} ``` ## Updates module configuration. > Updates module configuration for the specified module ID. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"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"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/modules/{uuid}":{"put":{"description":"Updates module configuration for the specified module ID. Only users with the Standard Registry role are allowed to make the request.","operationId":"ModulesApi_putModule","parameters":[{"name":"uuid","required":true,"in":"path","description":"Module Identifier","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Module config.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleDTO"}}}},"responses":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"422":{"description":"Invalid module config.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Updates module configuration.","tags":["modules"]}}}} ``` ## Deletes the module. > Deletes the module with the provided module ID. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/modules/{uuid}":{"delete":{"description":"Deletes the module with the provided module ID. Only users with the Standard Registry role are allowed to make the request.","operationId":"ModulesApi_deleteModule","parameters":[{"name":"uuid","required":true,"in":"path","description":"Module Identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"type":"boolean"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Deletes the module.","tags":["modules"]}}}} ``` ## Return a list of modules. > Returns modules menu. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"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"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/modules/menu":{"get":{"description":"Returns modules menu. Only users with the Standard Registry role are allowed to make the request.","operationId":"ModulesApi_getMenu","parameters":[],"responses":{"200":{"description":"Modules.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ModuleDTO"}}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Return a list of modules.","tags":["modules"]}}}} ``` ## Return module and its artifacts in a zip file format for the specified module. > Returns a zip file containing the published module and all associated artifacts, i.e. schemas and VCs. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/modules/{uuid}/export/file":{"get":{"description":"Returns a zip file containing the published module and all associated artifacts, i.e. schemas and VCs. Only users with the Standard Registry role are allowed to make the request.","operationId":"ModulesApi_moduleExportFile","parameters":[{"name":"uuid","required":true,"in":"path","description":"Module Identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Binary ZIP archive (`Content-Type: application/zip`, `Content-Disposition: attachment`). Not JSON.","content":{"application/zip":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unauthorized request.","content":{"application/zip":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/zip":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/zip":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Return module and its artifacts in a zip file format for the specified module.","tags":["modules"]}}}} ``` ## Return Heder message ID for the specified published module. > Returns the Hedera message ID for the specified module published onto IPFS. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"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"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/modules/{uuid}/export/message":{"get":{"description":"Returns the Hedera message ID for the specified module published onto IPFS. Only users with the Standard Registry role are allowed to make the request.","operationId":"ModulesApi_moduleExportMessage","parameters":[{"name":"uuid","required":true,"in":"path","description":"Module Identifier","schema":{"type":"string"}}],"responses":{"200":{"description":"Message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportMessageDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Return Heder message ID for the specified published module.","tags":["modules"]}}}} ``` ## Imports new module from IPFS. > Imports new module and all associated artifacts from IPFS into the local DB. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ImportMessageDTO":{"type":"object","properties":{"messageId":{"type":"string","description":"Hedera topic message id"},"metadata":{"type":"object","additionalProperties":true,"nullable":true}},"required":["messageId","metadata"]},"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"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/modules/import/message":{"post":{"description":"Imports new module and all associated artifacts from IPFS into the local DB. Only users with the Standard Registry role are allowed to make the request.","operationId":"ModulesApi_moduleImportMessage","parameters":[],"requestBody":{"required":true,"description":"Message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportMessageDTO"}}}},"responses":{"201":{"description":"Created module.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"422":{"description":"Message ID in body is empty.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Imports new module from IPFS.","tags":["modules"]}}}} ``` ## Imports new module from a zip file. > Imports new module and all associated artifacts, such as schemas and VCs, from the provided zip file into the local DB. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"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"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/modules/import/file":{"post":{"description":"Imports new module and all associated artifacts, such as schemas and VCs, from the provided zip file into the local DB. Only users with the Standard Registry role are allowed to make the request.","operationId":"ModulesApi_moduleImportFile","parameters":[],"requestBody":{"required":true,"description":"Module archive as raw binary request body.","content":{"binary/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"201":{"description":"Created module.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Imports new module from a zip file.","tags":["modules"]}}}} ``` ## Imports new module from IPFS. > Imports new module and all associated artifacts from IPFS into the local DB. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ImportMessageDTO":{"type":"object","properties":{"messageId":{"type":"string","description":"Hedera topic message id"},"metadata":{"type":"object","additionalProperties":true,"nullable":true}},"required":["messageId","metadata"]},"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"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"UnprocessableEntityErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/modules/import/message/preview":{"post":{"description":"Imports new module and all associated artifacts from IPFS into the local DB. Only users with the Standard Registry role are allowed to make the request.","operationId":"ModulesApi_moduleImportMessagePreview","parameters":[],"requestBody":{"required":true,"description":"Message.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportMessageDTO"}}}},"responses":{"200":{"description":"Module preview.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModulePreviewDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"422":{"description":"Message ID in body is empty.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Imports new module from IPFS.","tags":["modules"]}}}} ``` ## Imports new module from a zip file. > Imports new module and all associated artifacts, such as schemas and VCs, from the provided zip file into the local DB. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"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"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/modules/import/file/preview":{"post":{"description":"Imports new module and all associated artifacts, such as schemas and VCs, from the provided zip file into the local DB. Only users with the Standard Registry role are allowed to make the request.","operationId":"ModulesApi_moduleImportFilePreview","parameters":[],"requestBody":{"required":true,"description":"Module archive as raw binary request body.","content":{"binary/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Module preview.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleImportFileResponseDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Imports new module from a zip file.","tags":["modules"]}}}} ``` ## Publishes the module onto IPFS. > Publishes the module with the specified (internal) module ID onto IPFS, sends a message featuring its IPFS CID into the corresponding Hedera topic. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"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"]},"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"]},"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"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/modules/{uuid}/publish":{"put":{"description":"Publishes the module with the specified (internal) module ID onto IPFS, sends a message featuring its IPFS CID into the corresponding Hedera topic. Only users with the Standard Registry role are allowed to make the request.","operationId":"ModulesApi_publishModule","parameters":[{"name":"uuid","required":true,"in":"path","description":"Module Identifier","schema":{"type":"string"}}],"requestBody":{"required":false,"description":"Ignored by the current implementation. Publish uses the `uuid` path parameter and the module stored in DB.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleDTO"}}}},"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModulePublishResponseDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Publishes the module onto IPFS.","tags":["modules"]}}}} ``` ## Validates selected module. > Validates selected module. Only users with the Standard Registry role are allowed to make the request. ```json {"openapi":"3.0.0","info":{"title":"Guardian","version":"3.6.0"},"servers":[{"url":"/api/v1","description":"version 1.0"}],"security":[{"bearer":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"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"]},"ModuleValidationDTO":{"type":"object","properties":{"module":{"nullable":false,"allOf":[{"$ref":"#/components/schemas/ModuleDTO"}]},"results":{"nullable":false,"allOf":[{"$ref":"#/components/schemas/ValidationErrorsDTO"}]}},"required":["module","results"]},"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"]},"UnauthorizedErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]},"ForbiddenErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"},"error":{"type":"string"}},"required":["statusCode","message"]},"InternalServerErrorDTO":{"type":"object","properties":{"statusCode":{"type":"number"},"message":{"type":"string"}},"required":["statusCode","message"]}}},"paths":{"/modules/validate":{"post":{"description":"Validates selected module. Only users with the Standard Registry role are allowed to make the request.","operationId":"ModulesApi_validateModule","parameters":[],"requestBody":{"required":true,"description":"Module config.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleDTO"}}}},"responses":{"200":{"description":"Validation result.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModuleValidationDTO"}}}},"401":{"description":"Unauthorized request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDTO"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDTO"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDTO"}}}}},"summary":"Validates selected module.","tags":["modules"]}}}} ``` --- # 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-guardian/modules.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.