Generated by API Evangelist
Written by API Evangelist tooling for Deputy's API. It is a proposal applied on top of the contract, not a document Deputy publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Deputy V2 Leave Balance API
version: 1.0.0
extends: openapi/deputy-leave-balance-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-11-17'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/management/v2/leave-balance'].post
update:
x-apievangelist-phrasing:
intent: Create a leave balance
effect: write
questions:
- How do I set a new leave balance for an employee?
- Can I create a leave balance for a leave rule?
instructions:
- text: Create leave balance {balance}.
slots:
balance: requestBody.balance
- text: Add a new leave balance record.
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/leave-balance/employees/{employeeId}/balances'].get
update:
x-apievangelist-phrasing:
intent: List an employee's leave balances
effect: read
questions:
- What leave balances does an employee have?
- Can I see only the leave balances visible to the employee?
instructions:
- text: List leave balances for employee {employeeId}.
slots:
employeeId: path.employeeId
- text: 'Show employee {employeeId}''s leave balances visible to them: {onlyVisibleToEmployee}.'
slots:
employeeId: path.employeeId
onlyVisibleToEmployee: query.onlyVisibleToEmployee
method: generated
generated: '2026-11-17'
- target: $.paths['/management/v2/leave-balance/employees/{employeeId}/leave-rules/{leaveRuleId}'].get
update:
x-apievangelist-phrasing:
intent: Get an employee's leave balance for a rule
effect: read
questions:
- How much leave does an employee have under a specific leave rule?
- What is the balance for one leave rule?
instructions:
- text: Get leave balance for employee {employeeId} under leave rule {leaveRuleId}.
slots:
employeeId: path.employeeId
leaveRuleId: path.leaveRuleId
- text: Show the balance of leave rule {leaveRuleId} for employee {employeeId}.
slots:
leaveRuleId: path.leaveRuleId
employeeId: path.employeeId
method: generated
generated: '2026-11-17'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.