Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Project Avatars API

5 actions 5 updates phrasing extends openapi/atlassian-project-avatars-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/rest/api/3/project/{projectIdOrKey}/avatar'].put
$.paths['/rest/api/3/project/{projectIdOrKey}/avatar/{id}'].delete
$.paths['/rest/api/3/project/{projectIdOrKey}/avatar2'].post
$.paths['/rest/api/3/project/{projectIdOrKey}/avatars'].get

OpenAPI Overlay

Raw ↑ 
# 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 Project Avatars API
  version: 1.0.0
extends: openapi/atlassian-project-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: 4
- target: $.paths['/rest/api/3/project/{projectIdOrKey}/avatar'].put
  update:
    x-apievangelist-phrasing:
      intent: Set the avatar shown for a project
      effect: write
      questions:
      - How do I change which avatar is displayed for a Jira project?
      - Do I need to upload an avatar before I can make it the project's displayed one?
      instructions:
      - text: Set project {projectIdOrKey} to display avatar {id}.
        slots:
          projectIdOrKey: path.projectIdOrKey
          id: requestBody.id
      - text: Make avatar {id} the selected avatar for project {projectIdOrKey}.
        slots:
          id: requestBody.id
          projectIdOrKey: path.projectIdOrKey
      method: generated
      generated: '2026-10-01'
- 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 delete a custom avatar I uploaded to a project?
      - Can system avatars be removed from a project?
      instructions:
      - text: Delete avatar {id} from project {projectIdOrKey}.
        slots:
          id: path.id
          projectIdOrKey: path.projectIdOrKey
      - text: Remove custom avatar {id} that was uploaded to {projectIdOrKey}.
        slots:
          id: path.id
          projectIdOrKey: path.projectIdOrKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/project/{projectIdOrKey}/avatar2'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload an avatar image to a project
      effect: write
      questions:
      - How do I upload a new image to use as a project avatar?
      - Can I crop the uploaded project avatar to a square at a given offset?
      instructions:
      - text: Upload a new avatar image to project {projectIdOrKey}.
        slots:
          projectIdOrKey: path.projectIdOrKey
      - text: Load an avatar for {projectIdOrKey} cropped at {x},{y} with size {size}.
        slots:
          projectIdOrKey: path.projectIdOrKey
          x: query.x
          y: query.y
          size: query.size
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/project/{projectIdOrKey}/avatars'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's available avatars
      effect: read
      questions:
      - What avatars can I choose from for a project?
      - Which of a project's avatars are system ones versus custom uploads?
      instructions:
      - text: List all avatars for project {projectIdOrKey}.
        slots:
          projectIdOrKey: path.projectIdOrKey
      - text: Show system and custom avatars available to {projectIdOrKey}.
        slots:
          projectIdOrKey: path.projectIdOrKey
      method: generated
      generated: '2026-10-01'