# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for stax-api File API
  version: 1.0.0
extends: openapi/stax-file-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['/file'].get
  update:
    x-apievangelist-phrasing:
      intent: List uploaded files
      effect: read
      questions:
      - Which files have I uploaded to my Stax account?
      - Can I see all of my stored files in one list?
      instructions:
      - text: List all the files I have uploaded.
      - text: Show every stored file on my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file
      effect: write
      questions:
      - Can I upload a file like a product image and classify it with a tag?
      - What do I need to provide to store a new generic file?
      instructions:
      - text: Upload file {file} named {name} with tag {tag}.
        slots:
          file: requestBody.file
          name: requestBody.name
          tag: requestBody.tag
      - text: Store {file} as a product-image file called {name}, tag {tag}.
        slots:
          file: requestBody.file
          name: requestBody.name
          tag: requestBody.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file/dispute/{evidenceFileId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a dispute evidence file
      effect: destructive
      questions:
      - Can I remove an evidence file I attached to a chargeback dispute by mistake?
      - Is there a way to delete dispute evidence before it is submitted?
      instructions:
      - text: Delete dispute evidence file {evidenceFileId}.
        slots:
          evidenceFileId: path.evidenceFileId
      - text: Remove the evidence file {evidenceFileId} from its dispute.
        slots:
          evidenceFileId: path.evidenceFileId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a file by ID
      effect: read
      questions:
      - Can I fetch the details of one uploaded file using its ID?
      - What name and tag does a particular stored file have?
      instructions:
      - text: Get file {id}.
        slots:
          id: path.id
      - text: Show me the name and tag of file ID {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an uploaded file
      effect: write
      questions:
      - Can I rename or retag a file I already uploaded?
      - Is it possible to replace the contents of an existing stored file?
      instructions:
      - text: Rename file {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the tag on file {id} to {tag}.
        slots:
          id: path.id
          tag: requestBody.tag
      - text: Replace the contents of file {id} with {file}.
        slots:
          id: path.id
          file: requestBody.file
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file/{tag}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get files by tag
      effect: read
      questions:
      - Can I pull up only the files classified with a certain tag, like thumbnail?
      - Which files are tagged as product closeups?
      instructions:
      - text: Get the files tagged {tag}.
        slots:
          tag: path.tag
      - text: Show only files classified under the tag {tag}.
        slots:
          tag: path.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/file/dispute'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload evidence for a dispute
      effect: write
      questions:
      - How do I attach evidence to a chargeback dispute?
      - What file types and sizes are accepted for dispute evidence?
      instructions:
      - text: Upload {file} as evidence named {name} for dispute {dispute_id}.
        slots:
          file: requestBody.file
          name: requestBody.name
          dispute_id: requestBody.dispute_id
      - text: Attach the signed receipt PDF {file} to dispute {dispute_id} as {name}.
        slots:
          file: requestBody.file
          dispute_id: requestBody.dispute_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'