# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Dynatrace API v2 Problems API
  version: 1.0.0
extends: openapi/dynatrace-problems-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: 8
- target: $.paths['/problems'].get
  update:
    x-apievangelist-phrasing:
      intent: List detected problems
      effect: read
      questions:
      - What problems is Dynatrace reporting right now?
      - Can I filter problems to certain entities or a time range?
      instructions:
      - text: List problems matching {selector} from {from} to {to}.
        slots:
          selector: query.problemSelector
          from: query.from
          to: query.to
      - text: Show problems affecting entities matching {entities}.
        slots:
          entities: query.entitySelector
      method: generated
      generated: '2026-09-26'
- target: $.paths['/problems/{problemId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a problem's details and root cause
      effect: read
      questions:
      - What is the root cause and impact of a specific problem?
      - Can I see the evidence and affected entities for one problem?
      instructions:
      - text: Get the details of problem {problem}.
        slots:
          problem: path.problemId
      - text: Show root cause and evidence for problem {problem} with fields {fields}.
        slots:
          problem: path.problemId
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/problems/{problemId}/close'].post
  update:
    x-apievangelist-phrasing:
      intent: Close an open problem
      effect: destructive
      questions:
      - How do I manually close a problem once it's resolved?
      - Can I leave a closing message explaining why a problem was closed?
      instructions:
      - text: Close problem {problem}.
        slots:
          problem: path.problemId
      - text: Close problem {problem} with the note {message}.
        slots:
          problem: path.problemId
          message: requestBody.message
      method: generated
      generated: '2026-09-26'
- target: $.paths['/problems/{problemId}/comments'].get
  update:
    x-apievangelist-phrasing:
      intent: List comments on a problem
      effect: read
      questions:
      - What investigation notes has the team left on a problem?
      - Can I page through all comments on one problem?
      instructions:
      - text: List the comments on problem {problem}.
        slots:
          problem: path.problemId
      - text: Show {size} comments per page for problem {problem}.
        slots:
          size: query.pageSize
          problem: path.problemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/problems/{problemId}/comments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to a problem
      effect: write
      questions:
      - Can I attach a ticket reference to a problem as a comment?
      - Where do I post remediation notes on a problem?
      instructions:
      - text: Comment {message} on problem {problem}.
        slots:
          message: requestBody.message
          problem: path.problemId
      - text: Add a note {message} to problem {problem} with context {context}.
        slots:
          message: requestBody.message
          problem: path.problemId
          context: requestBody.context
      method: generated
      generated: '2026-09-26'
- target: $.paths['/problems/{problemId}/comments/{commentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one comment on a problem
      effect: read
      questions:
      - Can I read a single problem comment by its ID?
      - What exactly did a particular comment on a problem say?
      instructions:
      - text: Get comment {comment} on problem {problem}.
        slots:
          comment: path.commentId
          problem: path.problemId
      - text: Show me comment {comment} from problem {problem}.
        slots:
          comment: path.commentId
          problem: path.problemId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/problems/{problemId}/comments/{commentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a comment on a problem
      effect: write
      questions:
      - Can I fix a typo in a comment I already left on a problem?
      - Who is allowed to edit a problem comment?
      instructions:
      - text: Change comment {comment} on problem {problem} to {message}.
        slots:
          comment: path.commentId
          problem: path.problemId
          message: requestBody.message
      - text: Edit comment {comment} of problem {problem} to read {message} with context {context}.
        slots:
          comment: path.commentId
          problem: path.problemId
          message: requestBody.message
          context: requestBody.context
      method: generated
      generated: '2026-09-26'
- target: $.paths['/problems/{problemId}/comments/{commentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment from a problem
      effect: destructive
      questions:
      - How do I remove a comment posted on the wrong problem?
      - Is deleting a problem comment reversible?
      instructions:
      - text: Delete comment {comment} from problem {problem}.
        slots:
          comment: path.commentId
          problem: path.problemId
      - text: Remove the comment {comment} on problem {problem} permanently.
        slots:
          comment: path.commentId
          problem: path.problemId
      method: generated
      generated: '2026-09-26'