Bindbee · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bindbee Scorecard API

4 actions 4 updates phrasing extends openapi/bindbee-scorecard-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/scorecards'].get
$.paths['/api/ats/v1/scorecards'].post
$.paths['/api/ats/v1/scorecards/{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 Scorecard API
  version: 1.0.0
extends: openapi/bindbee-scorecard-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/scorecards'].get
  update:
    x-apievangelist-phrasing:
      intent: List interview scorecards
      effect: read
      questions:
      - What feedback scorecards were submitted for an application?
      - Can I see all scorecards from one interviewer?
      instructions:
      - text: List scorecards for application {application}.
        slots:
          application: query.application
      - text: Show scorecards submitted by interviewer {interviewer}.
        slots:
          interviewer: query.interviewer
      - text: Find scorecards for interview {interview}.
        slots:
          interview: query.interview
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/scorecards'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit an interview scorecard
      effect: write
      questions:
      - How do I submit interview feedback as a scorecard?
      - Can I create scorecards through the unified API?
      instructions:
      - text: Create a new scorecard in the ATS for connector {connector}.
        slots:
          connector: header.x-connector-token
      - text: Submit interview feedback as a scorecard.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ats/v1/scorecards/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one interview scorecard
      effect: read
      questions:
      - What rating and notes are on one scorecard?
      - Can I fetch one scorecard by id?
      instructions:
      - text: Get scorecard {id}.
        slots:
          id: path.id
      - text: Retrieve scorecard {id} and expand {expand}.
        slots:
          id: path.id
          expand: query.expand
      method: generated
      generated: '2026-09-26'