Emboss · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Getemboss Ai Proposals API

7 actions 7 updates phrasing extends openapi/getemboss-ai-proposals-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/proposals/{proposal_id}/commit'].post

$.paths['/proposals/{proposal_id}'].get

$.paths['/proposals/{proposal_id}/receipt'].get

$.paths['/proposals/{proposal_id}/pdf'].get

$.paths['/proposals/{proposal_id}/attachments'].post

$.paths['/proposals/{proposal_id}/attachments/{n}'].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 Getemboss Ai Proposals API
  version: 1.0.0
extends: openapi/getemboss-ai-proposals-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: 6
- target: $.paths['/proposals/{proposal_id}/commit'].post
  update:
    x-apievangelist-phrasing:
      intent: Commit a reviewed proposal into a filled PDF
      effect: write
      questions:
      - How do I accept a proposal and render the final filled form?
      - Can I override some proposed values when committing?
      - Is committing a proposal safe to retry?
      instructions:
      - text: Commit proposal {proposal_id}.
        slots:
          proposal_id: path.proposal_id
      - text: Commit proposal {proposal_id} with corrected values {values}.
        slots:
          proposal_id: path.proposal_id
          values: requestBody.values
      - text: Commit {proposal_id} using idempotency key {idempotency_key}.
        slots:
          proposal_id: path.proposal_id
          idempotency_key: requestBody.idempotency_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/proposals/{proposal_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Review a fill proposal
      effect: read
      questions:
      - What answers were proposed for my form before I commit?
      - Can an anonymous pay-door payer read their proposal with a token?
      instructions:
      - text: Show proposal {proposal_id}.
        slots:
          proposal_id: path.proposal_id
      - text: Let me review the proposed answers in {proposal_id}.
        slots:
          proposal_id: path.proposal_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/proposals/{proposal_id}/receipt'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the receipt for a committed proposal
      effect: read
      questions:
      - Where do I get a receipt after committing a proposal?
      - What record is kept of a committed fill?
      instructions:
      - text: Get the receipt for proposal {proposal_id}.
        slots:
          proposal_id: path.proposal_id
      - text: Show what was committed for {proposal_id}.
        slots:
          proposal_id: path.proposal_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/proposals/{proposal_id}/pdf'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the PDF from a committed proposal
      effect: read
      questions:
      - Where do I download the filled PDF after committing a proposal?
      - Can I get the final document for a proposal I committed?
      instructions:
      - text: Download the committed PDF for proposal {proposal_id}.
        slots:
          proposal_id: path.proposal_id
      - text: Save the final filled form from {proposal_id}.
        slots:
          proposal_id: path.proposal_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/proposals/{proposal_id}/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a supporting file to a proposal
      effect: write
      questions:
      - Can I attach a supporting document to a proposal before committing?
      - How do I say which field or item an attachment is for?
      instructions:
      - text: Attach {file} to proposal {proposal_id}.
        slots:
          file: requestBody.file
          proposal_id: path.proposal_id
      - text: Add {file} to {proposal_id} as the attachment for {for}.
        slots:
          file: requestBody.file
          proposal_id: path.proposal_id
          for: requestBody.for
      method: generated
      generated: '2026-10-01'
- target: $.paths['/proposals/{proposal_id}/attachments/{n}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an attachment from a proposal
      effect: destructive
      questions:
      - How do I take an attachment back off a proposal?
      - Can I remove the wrong file I attached to a proposal?
      instructions:
      - text: Remove attachment {n} from proposal {proposal_id}.
        slots:
          n: path.n
          proposal_id: path.proposal_id
      - text: Delete the attachment numbered {n} on {proposal_id}.
        slots:
          n: path.n
          proposal_id: path.proposal_id
      method: generated
      generated: '2026-10-01'