Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee EEOC API

4 actions 4 updates phrasing extends openapi/bindbee-eeoc-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/eeocs'].get
$.paths['/api/ats/v1/eeocs'].post
$.paths['/api/ats/v1/eeocs/{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 EEOC API
  version: 1.0.0
extends: openapi/bindbee-eeoc-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/eeocs'].get
  update:
    x-apievangelist-phrasing:
      intent: List EEOC demographic records
      effect: read
      questions:
      - Where do I read candidates' EEOC self-identification data?
      - Can I get the EEOC record for one candidate?
      instructions:
      - text: List EEOC records for candidate {candidate}.
        slots:
          candidate: query.candidate
      - text: Show EEOC records modified after {modified_after}.
        slots:
          modified_after: query.modified_after
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/eeocs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an EEOC record
      effect: write
      questions:
      - How do I submit a candidate's EEOC self-identification to the ATS?
      - Can I write EEOC demographic data through the unified API?
      instructions:
      - text: Create an EEOC record in the ATS for connector {connector}.
        slots:
          connector: header.x-connector-token
      - text: Submit a candidate's EEOC self-identification.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/eeocs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one EEOC record
      effect: read
      questions:
      - What fields are in a single EEOC record?
      - Can I fetch one EEOC entry by its id?
      instructions:
      - text: Get EEOC record {id}.
        slots:
          id: path.id
      - text: Retrieve EEOC entry {id} with raw data.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'