# 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 properties API
  version: 1.0.0
extends: openapi/jira-project-properties-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}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's property keys
      effect: read
      questions:
      - What custom property keys are stored on a project?
      - Can I see which app data keys exist for a project?
      instructions:
      - text: List the property keys on project {projectIdOrKey}.
        slots:
          projectIdOrKey: path.projectIdOrKey
      - text: Show custom data keys stored against project {projectIdOrKey}.
        slots:
          projectIdOrKey: path.projectIdOrKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a project property
      effect: read
      questions:
      - What value is saved under a given property key on a project?
      - Can I read an app's custom data stored on a project?
      instructions:
      - text: Get property {propertyKey} from project {projectIdOrKey}.
        slots:
          projectIdOrKey: path.projectIdOrKey
          propertyKey: path.propertyKey
      - text: Read the {propertyKey} value on project {projectIdOrKey}.
        slots:
          projectIdOrKey: path.projectIdOrKey
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Store a property on a project
      effect: write
      questions:
      - Can I store custom JSON data against a project without a database?
      - What permission is needed to write a project property?
      instructions:
      - text: Set property {propertyKey} on project {projectIdOrKey}.
        slots:
          projectIdOrKey: path.projectIdOrKey
          propertyKey: path.propertyKey
      - text: Save custom data under key {propertyKey} for project {projectIdOrKey}.
        slots:
          projectIdOrKey: path.projectIdOrKey
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/project/{projectIdOrKey}/properties/{propertyKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project property
      effect: destructive
      questions:
      - Can I remove a custom property from a project?
      - Who is allowed to delete project properties?
      instructions:
      - text: Delete property {propertyKey} from project {projectIdOrKey}.
        slots:
          projectIdOrKey: path.projectIdOrKey
          propertyKey: path.propertyKey
      - text: Remove the {propertyKey} custom data from project {projectIdOrKey}.
        slots:
          projectIdOrKey: path.projectIdOrKey
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-09-26'