Bitbucket · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bitbucket Properties API

13 actions 13 updates phrasing extends openapi/bitbucket-properties-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Bitbucket's API. It is a proposal applied on top of the contract, not a document Bitbucket publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 13

$.info

$.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}'].get

$.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}'].put

$.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/properties/{app_key}/{property_name}'].delete

$.paths['/repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}'].get

$.paths['/repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}'].put

$.paths['/repositories/{workspace}/{repo_slug}/properties/{app_key}/{property_name}'].delete

$.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}'].get

$.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}'].put

$.paths['/repositories/{workspace}/{repo_slug}/pullrequests/{pullrequest_id}/properties/{app_key}/{property_name}'].delete

$.paths['/users/{selected_user}/properties/{app_key}/{property_name}'].get

$.paths['/users/{selected_user}/properties/{app_key}/{property_name}'].put

$.paths['/users/{selected_user}/properties/{app_key}/{property_name}'].delete

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 Bitbucket Properties API
  version: 1.0.0
extends: openapi/bitbucket-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:
      - How does my Connect app read data it saved against a specific commit?
      - Can I fetch an application property attached to one commit hash?
      instructions:
      - text: Get property {property_name} of app {app_key} on commit {commit} in {workspace}/{repo_slug}.
        slots:
          property_name: path.property_name
          app_key: path.app_key
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Read the {app_key} app's {property_name} value stored on commit {commit}.
        slots:
          app_key: path.app_key
          property_name: path.property_name
          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 save its own metadata against a commit?
      - Can I overwrite an application property value that's already on a commit?
      instructions:
      - text: Set property {property_name} for app {app_key} on commit {commit} in {workspace}/{repo_slug} to {attributes}.
        slots:
          property_name: path.property_name
          app_key: path.app_key
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
          attributes: requestBody._attributes
      - text: Save {attributes} as the {app_key} app's {property_name} on commit {commit}.
        slots:
          attributes: requestBody._attributes
          app_key: path.app_key
          property_name: path.property_name
          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:
      - How do I remove data my app stored on a commit?
      - Can an app clean up an application property it attached to a commit?
      instructions:
      - text: Delete property {property_name} of app {app_key} from commit {commit} in {workspace}/{repo_slug}.
        slots:
          property_name: path.property_name
          app_key: path.app_key
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Remove the {app_key} app's {property_name} value stored on commit {commit}.
        slots:
          app_key: path.app_key
          property_name: path.property_name
          commit: path.commit
      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:
      - How does my app read settings it saved at the repository level?
      - Can I get an application property attached to a whole repo rather than a commit?
      instructions:
      - text: Get property {property_name} of app {app_key} on repository {workspace}/{repo_slug}.
        slots:
          property_name: path.property_name
          app_key: path.app_key
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Read the {app_key} app's repo-level {property_name} value for {repo_slug}.
        slots:
          app_key: path.app_key
          property_name: path.property_name
          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 can my app persist per-repository configuration in Bitbucket?
      - Can I update an application property saved against a repository?
      instructions:
      - text: Set repo property {property_name} for app {app_key} on {workspace}/{repo_slug} to {attributes}.
        slots:
          property_name: path.property_name
          app_key: path.app_key
          workspace: path.workspace
          repo_slug: path.repo_slug
          attributes: requestBody._attributes
      - text: Save {attributes} as the {app_key} app's repo-level {property_name} on {repo_slug}.
        slots:
          attributes: requestBody._attributes
          app_key: path.app_key
          property_name: path.property_name
          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:
      - How do I remove an application property my app stored on a repo?
      - Can an app delete its repository-level data when it's uninstalled from a repo?
      instructions:
      - text: Delete repo property {property_name} of app {app_key} from {workspace}/{repo_slug}.
        slots:
          property_name: path.property_name
          app_key: path.app_key
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Remove the {app_key} app's repository-level {property_name} on {repo_slug}.
        slots:
          app_key: path.app_key
          property_name: path.property_name
          repo_slug: path.repo_slug
      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:
      - How does my app read data it attached to a pull request?
      - Can I fetch an application property saved on one PR?
      instructions:
      - text: Get property {property_name} of app {app_key} on pull request {pullrequest_id} in {workspace}/{repo_slug}.
        slots:
          property_name: path.property_name
          app_key: path.app_key
          pullrequest_id: path.pullrequest_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Read the {app_key} app's {property_name} value on PR {pullrequest_id}.
        slots:
          app_key: path.app_key
          property_name: path.property_name
          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}'].put
  update:
    x-apievangelist-phrasing:
      intent: Store an app property on a pull request
      effect: write
      questions:
      - How can my app attach its own state to a pull request?
      - Can I update the application property my app keeps on a PR?
      instructions:
      - text: Set property {property_name} for app {app_key} on pull request {pullrequest_id} in {workspace}/{repo_slug} to {attributes}.
        slots:
          property_name: path.property_name
          app_key: path.app_key
          pullrequest_id: path.pullrequest_id
          workspace: path.workspace
          repo_slug: path.repo_slug
          attributes: requestBody._attributes
      - text: Save {attributes} as the {app_key} app's {property_name} on PR {pullrequest_id}.
        slots:
          attributes: requestBody._attributes
          app_key: path.app_key
          property_name: path.property_name
          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:
      - How do I remove data my app saved on a pull request?
      - Can an app clear an application property from a PR once it's merged?
      instructions:
      - text: Delete property {property_name} of app {app_key} from pull request {pullrequest_id} in {workspace}/{repo_slug}.
        slots:
          property_name: path.property_name
          app_key: path.app_key
          pullrequest_id: path.pullrequest_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Remove the {app_key} app's {property_name} value on PR {pullrequest_id}.
        slots:
          app_key: path.app_key
          property_name: path.property_name
          pullrequest_id: path.pullrequest_id
      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 user
      effect: read
      questions:
      - How does my app read per-user preferences it stored?
      - Can I get an application property saved against a specific Bitbucket user?
      instructions:
      - text: Get property {property_name} of app {app_key} for user {selected_user}.
        slots:
          property_name: path.property_name
          app_key: path.app_key
          selected_user: path.selected_user
      - text: Read the {app_key} app's user-level {property_name} for {selected_user}.
        slots:
          app_key: path.app_key
          property_name: path.property_name
          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 user
      effect: write
      questions:
      - How can my app save a setting for an individual user?
      - Can I overwrite the application property my app keeps on a user?
      instructions:
      - text: Set user property {property_name} for app {app_key} on {selected_user} to {attributes}.
        slots:
          property_name: path.property_name
          app_key: path.app_key
          selected_user: path.selected_user
          attributes: requestBody._attributes
      - text: Save {attributes} as the {app_key} app's {property_name} for user {selected_user}.
        slots:
          attributes: requestBody._attributes
          app_key: path.app_key
          property_name: path.property_name
          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 user
      effect: destructive
      questions:
      - How do I delete data my app stored against a user?
      - Can an app remove a user's application property when they opt out?
      instructions:
      - text: Delete user property {property_name} of app {app_key} from {selected_user}.
        slots:
          property_name: path.property_name
          app_key: path.app_key
          selected_user: path.selected_user
      - text: Remove the {app_key} app's {property_name} value for user {selected_user}.
        slots:
          app_key: path.app_key
          property_name: path.property_name
          selected_user: path.selected_user
      method: generated
      generated: '2026-10-01'