API reference
Discover marsql
Contract and client context
Operation: discover_marsql · HTTP: POST /v1/discover/marsql
Use an operator-supplied registry base URL. Request execution is disabled in this documentation explorer. Generated request snippets are templates, not signed or authorized submissions.
Exact operation definition
{
"operationId": "discover_marsql",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarsQlRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarsQueryResult"
}
}
},
"description": "MARS-QL DISCOVER results"
},
"400": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Invalid MARS-QL DISCOVER expression"
},
"413": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Query body exceeds the explicit admission limit"
},
"429": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
},
"description": "Query rate limit exceeded"
}
},
"tags": [
"discovery"
]
}Resolve schema references against the complete OpenAPI document. Standalone schemas and hashes are generated from the same checked-in source.
POST
/v1/discover/marsqlRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body for POST /v1/discover/marsql.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/discover/marsql" \ -H "Content-Type: application/json" \ -d '{ "query": "string" }'{ "cursor": "string", "entries": [ { "accessPolicy": null, "anchorState": "unanchored", "bondReference": null, "customMetadata": { "property1": null, "property2": null }, "description": "string", "entryDid": "string", "entryType": "AgentDefinition", "itemData": null, "itemDataHash": "string", "itemSchemaUri": "string", "lifecycleStatus": "draft", "lineageReference": null, "marsVersion": "string", "name": "string", "publishedAt": "2019-08-24T14:15:22Z", "publisherDid": "string", "relationships": [ { "label": "string", "relationshipType": "dependsOn", "targetDid": "string" } ], "semanticAnnotations": [ { "objectLiteral": "string", "objectUri": "string", "predicateUri": "string" } ], "sequence": 0, "serviceEndpoints": [ { "id": "string", "priority": 0, "properties": { "property1": null, "property2": null }, "type": "string", "url": "string" } ], "shardAssignment": "string", "signature": { "algorithm": "string", "created": "string", "keyId": "string", "value": "string" }, "tags": [ "string" ], "updatedAt": "2019-08-24T14:15:22Z", "verifiableAttestations": [ null ], "version": "string" } ], "hasMore": true, "totalCount": 0}