# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Firefly Services - InDesign Custom Scripts API
  version: 1.0.0
extends: openapi/adobe-suite-custom-scripts-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: 7
- target: $.paths['/v3/scripts'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered InDesign custom scripts
      effect: read
      questions:
      - Which custom InDesign scripts have we registered?
      - Can I page through registered scripts with their versions and download links?
      instructions:
      - text: List my registered custom scripts.
      - text: Show page {page} of registered custom scripts.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/scripts'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a custom script bundle
      effect: write
      questions:
      - How do I register my own InDesign script to run in the cloud?
      - What do I get back after submitting a custom script bundle?
      instructions:
      - text: Register this custom script bundle.
      - text: Submit my script bundle and return the execution URL.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/{script_id}/{script_name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a registered custom script
      effect: write
      questions:
      - How do I run a registered custom script against my InDesign files?
      - Can I pass parameters and output locations when executing a script?
      instructions:
      - text: Run script {script_name} ({script_id}) on assets {assets}.
        slots:
          script_name: path.script_name
          script_id: path.script_id
          assets: requestBody.assets
      - text: Execute {script_name} version {script_id} on {assets} with params {params}, writing to {outputs}.
        slots:
          script_name: path.script_name
          script_id: path.script_id
          assets: requestBody.assets
          params: requestBody.params
          outputs: requestBody.outputs
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/scripts/{script_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one custom script
      effect: read
      questions:
      - What version and registration date does a particular custom script have?
      - Can I get the download link for one registered script?
      instructions:
      - text: Show details for custom script {script_name}.
        slots:
          script_name: path.script_name
      - text: Get the download link for script {script_name}.
        slots:
          script_name: path.script_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/scripts/{script_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom script and all its versions
      effect: destructive
      questions:
      - How do I unregister a custom script?
      - Does deleting a custom script remove every version of it?
      instructions:
      - text: Delete custom script {script_name}.
        slots:
          script_name: path.script_name
      - text: Permanently remove every version of script {script_name}.
        slots:
          script_name: path.script_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/scripts/{script_name}/app-version'].put
  update:
    x-apievangelist-phrasing:
      intent: Pin the InDesign version a script runs on
      effect: write
      questions:
      - Can I fix a custom script to a specific InDesign major or minor version?
      - How do I make a script always use the latest InDesign version?
      instructions:
      - text: Set script {script_name} to app version strategy {strategy}.
        slots:
          script_name: path.script_name
          strategy: requestBody.appVersionStrategy
      - text: Pin script {script_name} to InDesign {major}.{minor} using strategy {strategy}.
        slots:
          script_name: path.script_name
          major: requestBody.majorAppVersion
          minor: requestBody.minorAppVersion
          strategy: requestBody.appVersionStrategy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/app-versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List available InDesign app versions
      effect: read
      questions:
      - Which InDesign versions can custom scripts run on?
      - What is the status of each available InDesign app version?
      instructions:
      - text: List the available InDesign app versions.
      - text: Show every InDesign major and minor version with its status.
      method: generated
      generated: '2026-09-26'