Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Passthrough API

2 actions 2 updates phrasing extends openapi/bindbee-passthrough-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 2

$.info
$.paths['/api/v1/passthrough'].post

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 Passthrough API
  version: 1.0.0
extends: openapi/bindbee-passthrough-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: 1
- target: $.paths['/api/v1/passthrough'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a raw request to the underlying system
      effect: write
      questions:
      - How do I call an endpoint of the underlying HR or ATS system that the unified model does not cover?
      - Can I choose the request format and a timeout for a passthrough call?
      instructions:
      - text: Send a {method} passthrough request to {path} with headers {headers}.
        slots:
          method: requestBody.method
          path: requestBody.path
          headers: requestBody.headers
      - text: Pass through a {method} call to {path} with headers {headers} and body {data}.
        slots:
          method: requestBody.method
          path: requestBody.path
          headers: requestBody.headers
          data: requestBody.data
      - text: Call {path} on the source system via {method} with query params {params}, headers {headers}, and a {timeout} second timeout.
        slots:
          path: requestBody.path
          method: requestBody.method
          params: requestBody.params
          headers: requestBody.headers
          timeout: requestBody.timeout
      method: generated
      generated: '2026-09-26'