Atlassian Compass · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Compass REST Attachment Rest Controller API

6 actions 6 updates phrasing extends openapi/atlassian-compass-attachment-rest-controller-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}'].get

$.paths['/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}'].put

$.paths['/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}'].delete

$.paths['/compass/v1/component/{componentId}/api_specs'].put

$.paths['/compass/v1/component/{componentId}/api_specs'].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 Compass REST Attachment Rest Controller API
  version: 1.0.0
extends: openapi/atlassian-compass-attachment-rest-controller-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: 5
- target: $.paths['/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a Forge app file attached to a component
      effect: read
      questions:
      - How do I fetch a file my Forge app attached to a Compass component?
      - Can I read back an attachment by its key for a specific component and app?
      - What does a component's Forge app attachment contain right now?
      instructions:
      - text: Download attachment {key} that Forge app {forgeAppId} stored on component {componentId}.
        slots:
          key: path.key
          forgeAppId: path.forgeAppId
          componentId: path.componentId
      - text: Show me the contents of the {key} file attached to component {componentId}.
        slots:
          key: path.key
          componentId: path.componentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Attach a file to a component from a Forge app
      effect: write
      questions:
      - Can my Compass Forge app upload a file and attach it to a component?
      - What do I need enabled before a Forge app can attach files to components?
      - Is there a way to replace a component attachment stored under a given key?
      instructions:
      - text: Upload {file} as attachment {key} on component {componentId} for Forge app {forgeAppId}.
        slots:
          file: requestBody.file
          key: path.key
          componentId: path.componentId
          forgeAppId: path.forgeAppId
      - text: Attach this file to component {componentId} under the key {key}.
        slots:
          componentId: path.componentId
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compass/v1/component/{componentId}/app/{forgeAppId}/attachment/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a Forge app attachment from a component
      effect: destructive
      questions:
      - How can I delete a file a Forge app attached to a component?
      - Can I remove one attachment key without touching the component's other files?
      instructions:
      - text: Delete attachment {key} from component {componentId} for Forge app {forgeAppId}.
        slots:
          key: path.key
          componentId: path.componentId
          forgeAppId: path.forgeAppId
      - text: Remove the {key} file my Forge app attached to component {componentId}.
        slots:
          key: path.key
          componentId: path.componentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compass/v1/component/{componentId}/api_specs'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload an API spec for a component
      effect: write
      questions:
      - Can I upload a swagger.yaml or OpenAPI file to a Compass component?
      - Where do I publish the API specification for one of my components?
      - Does uploading a new API spec file replace the one a component already has?
      instructions:
      - text: Upload {file} as the API spec for component {componentId}.
        slots:
          file: requestBody.file
          componentId: path.componentId
      - text: Publish our OpenAPI definition on component {componentId}.
        slots:
          componentId: path.componentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compass/v1/component/{componentId}/api_specs'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a component's API spec
      effect: destructive
      questions:
      - How do I remove the API specification from a Compass component?
      - Can I clear out an outdated API spec file on a component?
      instructions:
      - text: Delete the API spec file from component {componentId}.
        slots:
          componentId: path.componentId
      - text: Remove the outdated OpenAPI definition on component {componentId}.
        slots:
          componentId: path.componentId
      method: generated
      generated: '2026-09-26'