Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Attachment API

4 actions 4 updates phrasing extends openapi/bindbee-attachment-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Bindbee's API. It is a proposal applied on top of the contract, not a document Bindbee publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/api/ats/v1/attachments'].get
$.paths['/api/ats/v1/attachments'].post
$.paths['/api/ats/v1/attachments/{id}'].get

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bindbee Attachment API
  version: 1.0.0
extends: openapi/bindbee-attachment-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: 3
- target: $.paths['/api/ats/v1/attachments'].get
  update:
    x-apievangelist-phrasing:
      intent: List candidate attachments
      effect: read
      questions:
      - Which resumes and files are stored across our ATS?
      - Can I list only the documents attached to a certain candidate?
      instructions:
      - text: List attachments belonging to candidate {candidate}.
        slots:
          candidate: query.candidate
      - text: Show attachment records modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/attachments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an attachment record
      effect: write
      questions:
      - How do I add a new attachment object through the generic attachments endpoint?
      - Can I create an attachment without going through a specific candidate's upload path?
      instructions:
      - text: Create a standalone attachment record in the ATS for connector {connector}.
        slots:
          connector: header.x-connector-token
      - text: Add an attachment object via the general attachments endpoint.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/attachments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one attachment by id
      effect: read
      questions:
      - What metadata comes back for a single attachment?
      - Can I look up one resume file record by its id?
      instructions:
      - text: Get attachment {id}.
        slots:
          id: path.id
      - text: Show the details of attachment {id} with raw data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'