Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Job API

4 actions 4 updates phrasing extends openapi/bindbee-job-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/jobs'].get
$.paths['/api/ats/v1/jobs'].post
$.paths['/api/ats/v1/jobs/{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 Job API
  version: 1.0.0
extends: openapi/bindbee-job-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/jobs'].get
  update:
    x-apievangelist-phrasing:
      intent: Search job openings in the ATS
      effect: read
      questions:
      - Which job openings are currently open in our ATS?
      - Can I filter jobs by office or requisition code?
      instructions:
      - text: List jobs with status {status}.
        slots:
          status: query.status
      - text: Find the job with requisition code {code}.
        slots:
          code: query.code
      - text: Show jobs located at office {offices}.
        slots:
          offices: query.offices
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Open a new job requisition
      effect: write
      questions:
      - How do I create a new job opening in the ATS?
      - Can I set hiring managers, recruiters and number of openings on a new job?
      instructions:
      - text: Create job {name} with code {code} and status {status}.
        slots:
          name: requestBody.name
          code: requestBody.code
          status: requestBody.status
      - text: Open a {name} job in department {departments} at office {offices} with {openings} openings.
        slots:
          name: requestBody.name
          departments: requestBody.departments
          offices: requestBody.offices
          openings: requestBody.openings
      - text: Create a confidential job {name} with hiring manager {hiring_managers}, confidential set to {confidential}.
        slots:
          name: requestBody.name
          hiring_managers: requestBody.hiring_managers
          confidential: requestBody.confidential
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/jobs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one job opening by id
      effect: read
      questions:
      - What details are stored for one job requisition?
      - Can I expand a job's departments and offices when I fetch it?
      instructions:
      - text: Get job {id}.
        slots:
          id: path.id
      - text: Retrieve job {id} and expand {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'