Agorapulse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Open Simple Scheduling API

3 actions 3 updates phrasing extends openapi/agorapulse-simple-scheduling-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 3

$.info
$.paths['/v1.0/publishing/organizations/{organizationId}/workspaces/{workspaceId}/simple-schedule-posts'].post
$.paths['/v1.0/publishing/organizations/{organizationId}/workspaces/{workspaceId}/simple-schedule-posts:publish-now'].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 Open Simple Scheduling API
  version: 1.0.0
extends: openapi/agorapulse-simple-scheduling-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: 2
- target: $.paths['/v1.0/publishing/organizations/{organizationId}/workspaces/{workspaceId}/simple-schedule-posts'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a post for later
      effect: write
      questions:
      - How do I schedule a social post to go out at a set time on several profiles?
      - Can a scheduled post include media URLs and a link?
      instructions:
      - text: Schedule a {type} post saying {text} with scheduling {scheduling} in workspace {workspace}, org {org}.
        slots:
          type: requestBody.type
          text: requestBody.text
          scheduling: requestBody.scheduling
          workspace: path.workspaceId
          org: path.organizationId
      - text: Queue a {type} post with link {link} and media {media} for {scheduling} in workspace {workspace}, org {org}.
        slots:
          type: requestBody.type
          link: requestBody.link
          media: requestBody.mediaUrls
          scheduling: requestBody.scheduling
          workspace: path.workspaceId
          org: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1.0/publishing/organizations/{organizationId}/workspaces/{workspaceId}/simple-schedule-posts:publish-now'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a post immediately
      effect: write
      questions:
      - How do I post something right now to my social profiles instead of scheduling it?
      - Which profiles will an instant publish go out to?
      instructions:
      - text: Publish a {type} post saying {text} right now to profiles {profiles} in workspace {workspace}, org {org}.
        slots:
          type: requestBody.type
          text: requestBody.text
          profiles: requestBody.profileUids
          workspace: path.workspaceId
          org: path.organizationId
      - text: Post {text} with media {media} immediately as a {type} post on profiles {profiles} (workspace {workspace}, org {org}).
        slots:
          text: requestBody.text
          media: requestBody.mediaUrls
          type: requestBody.type
          profiles: requestBody.profileUids
          workspace: path.workspaceId
          org: path.organizationId
      method: generated
      generated: '2026-10-01'