Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Department API

4 actions 4 updates phrasing extends openapi/bindbee-department-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/departments'].get
$.paths['/api/ats/v1/departments'].post
$.paths['/api/ats/v1/departments/{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 Department API
  version: 1.0.0
extends: openapi/bindbee-department-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/departments'].get
  update:
    x-apievangelist-phrasing:
      intent: List recruiting departments in the ATS
      effect: read
      questions:
      - Which departments are set up in our applicant tracking system?
      - Can I list ATS departments changed since a certain date?
      instructions:
      - text: List ATS departments modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      - text: Show all hiring departments from the recruiting system.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/departments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a department in the ATS
      effect: write
      questions:
      - How do I add a new department to the recruiting system?
      - Can I create departments in the ATS through the unified API?
      instructions:
      - text: Create a new department in the ATS for connector {connector}.
        slots:
          connector: header.x-connector-token
      - text: Add a hiring department to the applicant tracking system.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/departments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one ATS department
      effect: read
      questions:
      - What details are held for one recruiting department?
      - Can I fetch a single ATS department by id?
      instructions:
      - text: Get ATS department {id}.
        slots:
          id: path.id
      - text: Retrieve recruiting department {id} with raw data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'