Agorapulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agorapulse Calendar notes API

5 actions 5 updates phrasing extends openapi/agorapulse-calendar-notes-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Agorapulse's API. It is a proposal applied on top of the contract, not a document Agorapulse publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/v1.0/publishing/organizations/{organizationId}/workspaces/{workspaceId}/notes'].get

$.paths['/v1.0/publishing/organizations/{organizationId}/workspaces/{workspaceId}/notes'].post

$.paths['/v1.0/publishing/organizations/{organizationId}/workspaces/{workspaceId}/notes/{uid}'].put

$.paths['/v1.0/publishing/organizations/{organizationId}/workspaces/{workspaceId}/notes/{uid}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Agorapulse Calendar notes API
  version: 1.0.0
extends: openapi/agorapulse-calendar-notes-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['/v1.0/publishing/organizations/{organizationId}/workspaces/{workspaceId}/notes'].get
  update:
    x-apievangelist-phrasing:
      intent: Search calendar notes in a workspace
      effect: read
      questions:
      - Which calendar notes are on my Agorapulse publishing calendar this month?
      - Can I filter calendar notes to only the ones tied to certain social profiles?
      - What notes fall between two dates on our content calendar?
      instructions:
      - text: Show the calendar notes in workspace {workspace} of organization {org}.
        slots:
          workspace: path.workspaceId
          org: path.organizationId
      - text: Find calendar notes in workspace {workspace} of org {org} dated between {since} and {until}.
        slots:
          workspace: path.workspaceId
          org: path.organizationId
          since: query.since
          until: query.until
      - text: List calendar notes for profiles {profiles} in workspace {workspace}, org {org}.
        slots:
          profiles: query.profileUids
          workspace: path.workspaceId
          org: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1.0/publishing/organizations/{organizationId}/workspaces/{workspaceId}/notes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a note to the publishing calendar
      effect: write
      questions:
      - How do I add a new note to our social media content calendar?
      - Can a calendar note span several days and be linked to specific profiles?
      - What color and date fields does a new calendar note need?
      instructions:
      - text: Create a calendar note titled {title} in workspace {workspace} of org {org} from {start} to {end} in {color}.
        slots:
          title: requestBody.title
          workspace: path.workspaceId
          org: path.organizationId
          start: requestBody.startDate
          end: requestBody.endDate
          color: requestBody.color
      - text: Add a new {color} calendar note {title} with text {body} running {start} to {end} in workspace {workspace}, org {org}.
        slots:
          color: requestBody.color
          title: requestBody.title
          body: requestBody.body
          start: requestBody.startDate
          end: requestBody.endDate
          workspace: path.workspaceId
          org: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1.0/publishing/organizations/{organizationId}/workspaces/{workspaceId}/notes/{uid}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing calendar note
      effect: write
      questions:
      - How do I change the dates or title of a calendar note I already created?
      - Can I recolor an existing note on the publishing calendar?
      instructions:
      - text: 'Update calendar note {uid} in workspace {workspace} of org {org}: title {title}, {color}, from {start} to {end}.'
        slots:
          uid: path.uid
          workspace: path.workspaceId
          org: path.organizationId
          title: requestBody.title
          color: requestBody.color
          start: requestBody.startDate
          end: requestBody.endDate
      - text: Move existing calendar note {uid} to run {start} through {end} in workspace {workspace}, org {org}, keeping title {title} and color {color}.
        slots:
          uid: path.uid
          start: requestBody.startDate
          end: requestBody.endDate
          workspace: path.workspaceId
          org: path.organizationId
          title: requestBody.title
          color: requestBody.color
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1.0/publishing/organizations/{organizationId}/workspaces/{workspaceId}/notes/{uid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a calendar note
      effect: destructive
      questions:
      - How do I remove a note from the publishing calendar?
      - Is deleting a calendar note permanent?
      instructions:
      - text: Delete calendar note {uid} from workspace {workspace} in org {org}.
        slots:
          uid: path.uid
          workspace: path.workspaceId
          org: path.organizationId
      - text: Remove the note {uid} from the content calendar of workspace {workspace}, org {org}.
        slots:
          uid: path.uid
          workspace: path.workspaceId
          org: path.organizationId
      method: generated
      generated: '2026-10-01'