# 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 Project avatars API
  version: 1.0.0
extends: openapi/jira-project-avatars-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: 4
- target: $.paths['/rest/api/3/project/{projectIdOrKey}/avatar'].put
  update:
    x-apievangelist-phrasing:
      intent: Choose the avatar a project displays
      effect: write
      questions:
      - How do I switch which avatar a project shows?
      - Do I have to load a custom project avatar before I can display it?
      instructions:
      - text: Set project {projectIdOrKey} to display avatar {id}.
        slots:
          projectIdOrKey: path.projectIdOrKey
          id: requestBody.id
      - text: Make avatar {id} the visible icon for project {projectIdOrKey}.
        slots:
          id: requestBody.id
          projectIdOrKey: path.projectIdOrKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/project/{projectIdOrKey}/avatar/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom project avatar
      effect: destructive
      questions:
      - How do I remove a custom avatar I uploaded to a project?
      - Can system avatars be deleted from a project?
      instructions:
      - text: Delete custom avatar {id} from project {projectIdOrKey}.
        slots:
          id: path.id
          projectIdOrKey: path.projectIdOrKey
      - text: Remove the uploaded icon {id} from project {projectIdOrKey}.
        slots:
          id: path.id
          projectIdOrKey: path.projectIdOrKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/project/{projectIdOrKey}/avatar2'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a custom avatar to a project
      effect: write
      questions:
      - How do I upload our logo as a project avatar?
      - Can I crop a project avatar image when uploading it?
      instructions:
      - text: Upload this image as an avatar for project {projectIdOrKey}.
        slots:
          projectIdOrKey: path.projectIdOrKey
      - text: Load a project avatar for {projectIdOrKey} cropped to a {size} square at x {x}, y {y}.
        slots:
          projectIdOrKey: path.projectIdOrKey
          size: query.size
          x: query.x
          y: query.y
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/project/{projectIdOrKey}/avatars'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's system and custom avatars
      effect: read
      questions:
      - Which avatars can a project choose from, including ones we uploaded?
      - What custom avatars have been loaded for a project?
      instructions:
      - text: List all avatars for project {projectIdOrKey}.
        slots:
          projectIdOrKey: path.projectIdOrKey
      - text: Show the system and custom avatar options for project {projectIdOrKey}.
        slots:
          projectIdOrKey: path.projectIdOrKey
      method: generated
      generated: '2026-09-26'