# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Avatars API
  version: 1.0.0
extends: openapi/atlassian-avatars-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/rest/api/3/avatar/{type}/system'].get
  update:
    x-apievangelist-phrasing:
      intent: List the built-in system avatars by type
      effect: read
      questions:
      - What built-in avatars can I choose from for projects, issue types or users?
      - Which system avatars ship with Jira for a given owner type?
      instructions:
      - text: List the system avatars for type {type}.
        slots:
          type: path.type
      - text: Show all built-in {type} avatars.
        slots:
          type: path.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/universal_avatar/type/{type}/owner/{entityId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List avatars available to a project or issue type
      effect: read
      questions:
      - Which system and custom avatars can a specific project use?
      - What custom avatars have been uploaded for one issue type?
      instructions:
      - text: List the {type} avatars available to {entityId}.
        slots:
          type: path.type
          entityId: path.entityId
      - text: Show system and custom avatars for {type} {entityId}.
        slots:
          type: path.type
          entityId: path.entityId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/universal_avatar/type/{type}/owner/{entityId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a custom avatar for a project or issue type
      effect: write
      questions:
      - How do I upload my own image as a project avatar?
      - Can I crop an uploaded avatar to a square region?
      instructions:
      - text: Upload a custom {type} avatar for {entityId} cropped to size {size}.
        slots:
          type: path.type
          entityId: path.entityId
          size: query.size
      - text: Load an avatar for {type} {entityId} cropped at x {x}, y {y}, size {size}.
        slots:
          type: path.type
          entityId: path.entityId
          x: query.x
          y: query.y
          size: query.size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom avatar
      effect: destructive
      questions:
      - How do I remove a custom avatar from a project?
      - Who is allowed to delete an issue type's avatar?
      instructions:
      - text: Delete avatar {id} from {type} {owningObjectId}.
        slots:
          id: path.id
          type: path.type
          owningObjectId: path.owningObjectId
      - text: Remove the custom {type} avatar {id} owned by {owningObjectId}.
        slots:
          type: path.type
          id: path.id
          owningObjectId: path.owningObjectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/universal_avatar/view/type/{type}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default avatar image for a type
      effect: read
      questions:
      - What does the default project avatar image look like?
      - Can I download the default issue type icon as a PNG?
      instructions:
      - text: Get the default {type} avatar image.
        slots:
          type: path.type
      - text: Download the default {type} avatar in {format} at size {size}.
        slots:
          type: path.type
          format: query.format
          size: query.size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/universal_avatar/view/type/{type}/avatar/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an avatar image by its ID
      effect: read
      questions:
      - Can I download the image file for a specific avatar ID?
      - What sizes and formats can an avatar image be returned in?
      instructions:
      - text: Get the image for {type} avatar {id}.
        slots:
          type: path.type
          id: path.id
      - text: Download avatar {id} of type {type} as {format}.
        slots:
          id: path.id
          type: path.type
          format: query.format
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/universal_avatar/view/type/{type}/owner/{entityId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current avatar image of a project or issue type
      effect: read
      questions:
      - What avatar image is a specific project currently showing?
      - Can I fetch the icon an issue type uses without knowing the avatar ID?
      instructions:
      - text: Get the avatar image used by {type} {entityId}.
        slots:
          type: path.type
          entityId: path.entityId
      - text: Download the current icon of {type} {entityId} at size {size}.
        slots:
          type: path.type
          entityId: path.entityId
          size: query.size
      method: generated
      generated: '2026-10-01'