Atlassian · OpenAPI Overlay 1.0.0

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

3 actions 3 updates phrasing extends openapi/atlassian-project-email-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 3

$.info

$.paths['/rest/api/3/project/{projectId}/email'].get

$.paths['/rest/api/3/project/{projectId}/email'].put

OpenAPI Overlay

# 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 Email API
  version: 1.0.0
extends: openapi/atlassian-project-email-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: 2
- target: $.paths['/rest/api/3/project/{projectId}/email'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project's sender email address
      effect: read
      questions:
      - Which email address does a Jira project send notifications from?
      - Is this project using the default sender address?
      instructions:
      - text: Get the sender email address for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show which From address project {projectId} uses for notifications.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/project/{projectId}/email'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a project's sender email address
      effect: write
      questions:
      - How do I change the From address on a project's notification emails?
      - Can I restore the default sender address for a project?
      instructions:
      - text: Set project {projectId}'s sender email to {emailAddress}.
        slots:
          projectId: path.projectId
          emailAddress: requestBody.emailAddress
      - text: Restore the default notification sender for project {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'