Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Offer API

4 actions 4 updates phrasing extends openapi/bindbee-offer-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/offers'].get
$.paths['/api/ats/v1/offers'].post
$.paths['/api/ats/v1/offers/{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 Offer API
  version: 1.0.0
extends: openapi/bindbee-offer-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/offers'].get
  update:
    x-apievangelist-phrasing:
      intent: List job offers
      effect: read
      questions:
      - Which offers have been extended for a given application?
      - Can I see all offers created by a particular recruiter?
      instructions:
      - text: List offers for application {application}.
        slots:
          application: query.application
      - text: Show offers created by user {creator}.
        slots:
          creator: query.creator
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/offers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a job offer
      effect: write
      questions:
      - How do I record a new offer for a candidate in the ATS?
      - Can I create offers through the unified recruiting API?
      instructions:
      - text: Create a new offer in the ATS for connector {connector}.
        slots:
          connector: header.x-connector-token
      - text: Record a job offer for a candidate's application.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/offers/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one job offer
      effect: read
      questions:
      - What are the details and status of one offer?
      - Can I fetch a single offer by id?
      instructions:
      - text: Get offer {id}.
        slots:
          id: path.id
      - text: Retrieve offer {id} and expand {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'