# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Atlassian Bitbucket Properties API version: 1.0.0 extends: openapi/atlassian-properties-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: 12 - target: $.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}'].get update: x-apievangelist-phrasing: intent: Read an app property stored on a commit effect: read questions: - Can my Bitbucket app read back data it stored against a specific commit? - Where is an application property attached to a commit retrieved from? instructions: - text: Get app {app_key}'s property {property_name} on commit {commit} in {workspace}/{repo_slug}. slots: app_key: path.app_key property_name: path.property_name commit: path.commit workspace: path.workspace repo_slug: path.repo_slug - text: Read the {property_name} value my app {app_key} saved on commit {commit}. slots: property_name: path.property_name app_key: path.app_key commit: path.commit method: generated generated: '2026-10-01' - target: $.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}'].put update: x-apievangelist-phrasing: intent: Store an app property on a commit effect: write questions: - How can my app attach its own metadata to a commit? - Can I overwrite an application property value saved against a commit? instructions: - text: Set app {app_key}'s property {property_name} on commit {commit} in {workspace}/{repo_slug}. slots: app_key: path.app_key property_name: path.property_name commit: path.commit workspace: path.workspace repo_slug: path.repo_slug - text: Save property {property_name} for app {app_key} against commit {commit}. slots: property_name: path.property_name app_key: path.app_key commit: path.commit method: generated generated: '2026-10-01' - target: $.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}'].delete update: x-apievangelist-phrasing: intent: Delete an app property from a commit effect: destructive questions: - Can my app remove the metadata it stored on a commit? - What's the call to clear an application property from a single commit? instructions: - text: Delete app {app_key}'s property {property_name} from commit {commit} in {workspace}/{repo_slug}. slots: app_key: path.app_key property_name: path.property_name commit: path.commit workspace: path.workspace repo_slug: path.repo_slug - text: Remove commit {commit}'s {property_name} property for app {app_key}. slots: commit: path.commit property_name: path.property_name app_key: path.app_key method: generated generated: '2026-10-01' - target: $.paths['/repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}'].get update: x-apievangelist-phrasing: intent: Read an app property stored on a repository effect: read questions: - Can my app look up settings it saved at the repository level? - Where does an application property stored against a whole repository come from? instructions: - text: Get app {app_key}'s repository property {property_name} in {workspace}/{repo_slug}. slots: app_key: path.app_key property_name: path.property_name workspace: path.workspace repo_slug: path.repo_slug - text: Read the {property_name} value app {app_key} keeps on repository {repo_slug}. slots: property_name: path.property_name app_key: path.app_key repo_slug: path.repo_slug method: generated generated: '2026-10-01' - target: $.paths['/repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}'].put update: x-apievangelist-phrasing: intent: Store an app property on a repository effect: write questions: - How does an app save its own configuration against a repository? - Can I update a repository-level application property my app owns? instructions: - text: Set app {app_key}'s repository property {property_name} on {workspace}/{repo_slug}. slots: app_key: path.app_key property_name: path.property_name workspace: path.workspace repo_slug: path.repo_slug - text: Save repository-level property {property_name} for app {app_key} in repo {repo_slug}. slots: property_name: path.property_name app_key: path.app_key repo_slug: path.repo_slug method: generated generated: '2026-10-01' - target: $.paths['/repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}'].delete update: x-apievangelist-phrasing: intent: Delete an app property from a repository effect: destructive questions: - Can my app delete the data it stored on a repository when it's uninstalled? - Is there a way to clear one repository-level application property? instructions: - text: Delete app {app_key}'s repository property {property_name} from {workspace}/{repo_slug}. slots: app_key: path.app_key property_name: path.property_name workspace: path.workspace repo_slug: path.repo_slug - text: Remove repository property {property_name} owned by app {app_key}. slots: property_name: path.property_name app_key: path.app_key method: generated generated: '2026-10-01' - target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}'].get update: x-apievangelist-phrasing: intent: Read an app property stored on a pull request effect: read questions: - Can my app read metadata it attached to a particular pull request? - Where do I fetch an application property saved against a PR? instructions: - text: Get app {app_key}'s property {property_name} on pull request {pullrequest_id} in {workspace}/{repo_slug}. slots: app_key: path.app_key property_name: path.property_name pullrequest_id: path.pullrequest_id workspace: path.workspace repo_slug: path.repo_slug - text: Read PR {pullrequest_id}'s {property_name} value for app {app_key}. slots: pullrequest_id: path.pullrequest_id property_name: path.property_name app_key: path.app_key method: generated generated: '2026-10-01' - target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}'].put update: x-apievangelist-phrasing: intent: Store an app property on a pull request effect: write questions: - How can an app tag a pull request with its own data, like a review score? - Can I update an application property already stored on a PR? instructions: - text: Set app {app_key}'s property {property_name} on pull request {pullrequest_id} in {workspace}/{repo_slug}. slots: app_key: path.app_key property_name: path.property_name pullrequest_id: path.pullrequest_id workspace: path.workspace repo_slug: path.repo_slug - text: Save {property_name} for app {app_key} against PR {pullrequest_id}. slots: property_name: path.property_name app_key: path.app_key pullrequest_id: path.pullrequest_id method: generated generated: '2026-10-01' - target: $.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}'].delete update: x-apievangelist-phrasing: intent: Delete an app property from a pull request effect: destructive questions: - Can my app remove data it stored on a pull request? - What clears an application property attached to a PR? instructions: - text: Delete app {app_key}'s property {property_name} from pull request {pullrequest_id} in {workspace}/{repo_slug}. slots: app_key: path.app_key property_name: path.property_name pullrequest_id: path.pullrequest_id workspace: path.workspace repo_slug: path.repo_slug - text: Remove PR {pullrequest_id}'s {property_name} property for app {app_key}. slots: pullrequest_id: path.pullrequest_id property_name: path.property_name app_key: path.app_key method: generated generated: '2026-10-01' - target: $.paths['/users/{selected_user}/properties/{app_key}/{property_name}'].get update: x-apievangelist-phrasing: intent: Read an app property stored on a Bitbucket user effect: read questions: - Can my Bitbucket app read preferences it saved for a specific user? - Where is an application property stored against a user retrieved? instructions: - text: Get app {app_key}'s property {property_name} for Bitbucket user {selected_user}. slots: app_key: path.app_key property_name: path.property_name selected_user: path.selected_user - text: Read the {property_name} value app {app_key} stored on user {selected_user}. slots: property_name: path.property_name app_key: path.app_key selected_user: path.selected_user method: generated generated: '2026-10-01' - target: $.paths['/users/{selected_user}/properties/{app_key}/{property_name}'].put update: x-apievangelist-phrasing: intent: Store an app property on a Bitbucket user effect: write questions: - How can an app save per-user preferences in Bitbucket? - Can I update an application property my app keeps on a user? instructions: - text: Set app {app_key}'s property {property_name} on Bitbucket user {selected_user}. slots: app_key: path.app_key property_name: path.property_name selected_user: path.selected_user - text: Save per-user property {property_name} for app {app_key} on {selected_user}. slots: property_name: path.property_name app_key: path.app_key selected_user: path.selected_user method: generated generated: '2026-10-01' - target: $.paths['/users/{selected_user}/properties/{app_key}/{property_name}'].delete update: x-apievangelist-phrasing: intent: Delete an app property from a Bitbucket user effect: destructive questions: - Can my app delete the data it stored on a user account? - Is there a call to clear one app property from a Bitbucket user? instructions: - text: Delete app {app_key}'s property {property_name} from Bitbucket user {selected_user}. slots: app_key: path.app_key property_name: path.property_name selected_user: path.selected_user - text: Remove user {selected_user}'s {property_name} property for app {app_key}. slots: selected_user: path.selected_user property_name: path.property_name app_key: path.app_key method: generated generated: '2026-10-01'