Act! CRM · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for act.web.api Calendar API

5 actions 5 updates phrasing extends openapi/act-calendar-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Act! CRM's API. It is a proposal applied on top of the contract, not a document Act! CRM publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/api/calendar'].get
$.paths['/api/calendar/preferences'].get
$.paths['/api/calendar/preferences'].put
$.paths['/api/calendar/preferences'].post

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 act.web.api Calendar API
  version: 1.0.0
extends: openapi/act-calendar-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/calendar'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my calendar schedule
      effect: read
      questions:
      - What's on my calendar?
      - Can I filter my schedule with an OData query?
      instructions:
      - text: Show my calendar schedule.
      - text: Get the current user's calendar.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/calendar/preferences'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my calendar preferences
      effect: read
      questions:
      - What are my current calendar settings, like work week and start time?
      - Can I see which day my calendar week starts on?
      instructions:
      - text: Get my calendar preferences.
      - text: Show my calendar work week and time settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/calendar/preferences'].put
  update:
    x-apievangelist-phrasing:
      intent: Update my calendar preferences
      effect: write
      questions:
      - Can I change the start time of my working day on the calendar?
      - How do I update existing calendar preferences such as the work week length?
      instructions:
      - text: Update my calendar preferences so the day starts at {startTime}.
        slots:
          startTime: requestBody.startTime
      - text: Change my existing work week to {numberOfWorkWeekDays} days.
        slots:
          numberOfWorkWeekDays: requestBody.numberOfWorkWeekDays
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/calendar/preferences'].post
  update:
    x-apievangelist-phrasing:
      intent: Create my calendar preferences
      effect: write
      questions:
      - I've never set calendar preferences; how do I create them?
      - Can I set up initial calendar preferences with a daily time increment?
      instructions:
      - text: Create calendar preferences with a {dailyCalendarIncrement} daily increment.
        slots:
          dailyCalendarIncrement: requestBody.dailyCalendarIncrement
      - text: Set up my first calendar preferences starting the week on {firsDayOfWeek}.
        slots:
          firsDayOfWeek: requestBody.firsDayOfWeek
      method: generated
      generated: '2026-10-01'