Atlassian Compass · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Compass REST Package Dependencies API

3 actions 3 updates phrasing extends openapi/atlassian-compass-package-dependencies-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 3

$.info

$.paths['/compass/v1/package_dependencies/lock_file'].put

$.paths['/compass/v1/package_dependencies/lock_file/{componentId}/{sourceId}'].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 Package Dependencies API
  version: 1.0.0
extends: openapi/atlassian-compass-package-dependencies-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: 2
- target: $.paths['/compass/v1/package_dependencies/lock_file'].put
  update:
    x-apievangelist-phrasing:
      intent: Record a component's package dependencies from a lock file
      effect: write
      questions:
      - Can I load a package-lock.json into Compass to track a component's dependencies?
      - What size limit applies to the lock file I upload for package dependencies?
      - How do I link dependencies back to the exact lines in my lock file on GitHub or Bitbucket?
      instructions:
      - text: Upload {file} as the package lock file for component {componentId} with source {sourceId} at {baseSourceUrl}.
        slots:
          file: requestBody.file
          componentId: query.componentId
          sourceId: query.sourceId
          baseSourceUrl: query.baseSourceUrl
      - text: Import the dependencies in our package-lock.json for component {componentId}, sourced from {baseSourceUrl}.
        slots:
          componentId: query.componentId
          baseSourceUrl: query.baseSourceUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compass/v1/package_dependencies/lock_file/{componentId}/{sourceId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete package dependencies from one lock file source
      effect: destructive
      questions:
      - How do I remove all the package dependencies Compass recorded from one lock file?
      - Does the source id need to be Base64 encoded when deleting a lock file's dependencies?
      instructions:
      - text: Delete the package dependencies from source {sourceId} on component {componentId}.
        slots:
          sourceId: path.sourceId
          componentId: path.componentId
      - text: Clear every dependency that lock file {sourceId} added to component {componentId}.
        slots:
          sourceId: path.sourceId
          componentId: path.componentId
      method: generated
      generated: '2026-09-26'