# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Cloud platform REST JQL API
  version: 1.0.0
extends: openapi/jira-jql-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/rest/api/3/jql/autocompletedata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get JQL field and function reference data
      effect: read
      questions:
      - What fields and functions can I use when writing JQL searches?
      - Is there a downloadable reference of every JQL field and reserved word?
      instructions:
      - text: Get the full JQL field and function reference data.
      - text: Download the JQL autocomplete reference for all fields.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/jql/autocompletedata'].post
  update:
    x-apievangelist-phrasing:
      intent: Get JQL reference data for specific projects
      effect: read
      questions:
      - Can I get JQL field reference data limited to certain projects?
      - Is there a way to include collapsed fields in the JQL reference?
      instructions:
      - text: Get JQL reference data for projects {projectIds}.
        slots:
          projectIds: requestBody.projectIds
      - text: Fetch JQL field reference with collapsed fields set to {includeCollapsedFields}.
        slots:
          includeCollapsedFields: requestBody.includeCollapsedFields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/jql/autocompletedata/suggestions'].get
  update:
    x-apievangelist-phrasing:
      intent: Suggest JQL values for a field
      effect: read
      questions:
      - What values can I type for a field in a JQL query?
      - Can I get autocomplete suggestions for a partially typed field value?
      instructions:
      - text: Suggest JQL values for field {fieldName}.
        slots:
          fieldName: query.fieldName
      - text: Suggest values for {fieldName} that contain {fieldValue}.
        slots:
          fieldName: query.fieldName
          fieldValue: query.fieldValue
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/jql/parse'].post
  update:
    x-apievangelist-phrasing:
      intent: Parse and validate JQL queries
      effect: read
      questions:
      - How can I check whether a JQL query is valid before running it?
      - Can I get the parsed structure of a JQL query?
      instructions:
      - text: Parse and validate JQL {queries} with validation mode {validation}.
        slots:
          queries: requestBody.queries
          validation: query.validation
      - text: Check JQL queries {queries} for errors using {validation} validation.
        slots:
          queries: requestBody.queries
          validation: query.validation
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/jql/pdcleaner'].post
  update:
    x-apievangelist-phrasing:
      intent: Convert usernames in JQL to account IDs
      effect: write
      questions:
      - How do I make stored JQL queries GDPR compliant by replacing usernames?
      - Can I convert user keys in saved JQL to account IDs?
      instructions:
      - text: Convert user identifiers in JQL {queryStrings} to account IDs.
        slots:
          queryStrings: requestBody.queryStrings
      - text: Rewrite queries {queryStrings} so they reference account IDs instead of usernames.
        slots:
          queryStrings: requestBody.queryStrings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/jql/sanitize'].post
  update:
    x-apievangelist-phrasing:
      intent: Hide details a user can't see in JQL
      effect: read
      questions:
      - How do I strip project names a user isn't allowed to see out of a JQL query?
      - Can I sanitize JQL for a specific user's permissions?
      instructions:
      - text: Sanitize JQL queries {queries}.
        slots:
          queries: requestBody.queries
      - text: Replace restricted names with IDs in queries {queries}.
        slots:
          queries: requestBody.queries
      method: generated
      generated: '2026-09-26'