parseJqlQueries
Parse JQL query
Details
- Method:
POST - Path:
/rest/api/3/jql/parse - Operation ID:
parseJqlQueries
Parameters
{
"validation": {
"description": "How to validate the JQL query and treat the validation results. Validation options include:\n\n * `strict` Returns all errors. If validation fails, the query structure is not returned.\n * `warn` Returns all errors. If validation fails but the JQL query is correctly formed, the query structure is returned.\n * `none` No validation is performed. If JQL query is correctly formed, the query structure is returned.",
"required": true,
"location": "query",
"type": "string",
"enum": [
"strict",
"warn",
"none"
]
},
"queries": {
"description": "A list of queries to parse.",
"required": true,
"location": "body",
"type": "array"
}
}Response Schema
{
"additionalProperties": false,
"description": "A list of parsed JQL queries.",
"properties": {
"queries": {
"description": "A list of parsed JQL queries.",
"items": {
"additionalProperties": false,
"description": "Details of a parsed JQL query.",
"minLength": 1,
"properties": {
"errors": {
"description": "The list of syntax or validation errors.",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"query": {
"description": "The JQL query that was parsed and validated.",
"type": "string"
},
"structure": {
"allOf": [
{
"$ref": "#/components/schemas/JqlQuery"
}
],
"description": "The syntax tree of the query. Empty if the query was invalid."
},
"warnings": {
"description": "The list of warning messages",
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"query"
],
"type": "object"
},
"minLength": 1,
"type": "array"
}
},
"required": [
"queries"
],
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('jira')
# Call this tool
result = await agent.call_tool('parseJqlQueries', {
# Add required parameters here
})