Generated by API Evangelist
Written by API Evangelist tooling for Progress Software's API. It is a proposal applied on top of the contract, not a document Progress Software publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Chef Automate API Documentation Event Feed Service API
version: 1.0.0
extends: openapi/progress-software-eventfeedservice-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/api/v0/event_task_counts'].get
update:
x-apievangelist-phrasing:
intent: Count create, update and delete actions in events
effect: read
questions:
- How many create, update and delete actions happened in Chef Automate this week?
- Can I break down event activity by action type for a time window?
instructions:
- text: Count event tasks between {start} and {end}.
slots:
start: query.start
end: query.end
- text: Show create, update and delete totals for events matching {filter}.
slots:
filter: query.filter
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v0/event_type_counts'].get
update:
x-apievangelist-phrasing:
intent: Count role, cookbook and organization events
effect: read
questions:
- How many cookbook events versus role events were recorded?
- What are the totals per event type over a date range?
instructions:
- text: Count events by type between {start} and {end}.
slots:
start: query.start
end: query.end
- text: Show role, cookbook and organization event totals for {filter}.
slots:
filter: query.filter
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v0/eventfeed'].get
update:
x-apievangelist-phrasing:
intent: List recorded events
effect: read
questions:
- What changed recently on my Chef Infra Server, like new cookbooks or policyfile updates?
- Can I page through the event feed with a cursor?
- Which events were recorded in a specific time window?
instructions:
- text: Show the latest events in the event feed.
- text: List events between {start} and {end}, {page_size} per page.
slots:
start: query.start
end: query.end
page_size: query.page_size
- text: List feed events matching {filter}.
slots:
filter: query.filter
method: generated
generated: '2026-10-01'
- target: $.paths['/api/v0/eventstrings'].get
update:
x-apievangelist-phrasing:
intent: Get hourly event summary buckets
effect: read
questions:
- What data drives the event timeline graphic above the event feed?
- Can I bucket event activity into hour blocks in my timezone?
instructions:
- text: Get event string buckets from {start} to {end} in timezone {timezone}.
slots:
start: query.start
end: query.end
timezone: query.timezone
- text: Summarize events every {hours_between} hours.
slots:
hours_between: query.hours_between
method: generated
generated: '2026-10-01'
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. See our Privacy Policy and
Terms.