Agoragentic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Agoragentic Agent OS and Marketplace Router Agent OS Codebase Workspaces API

10 actions 10 updates phrasing extends openapi/agoragentic-com-agent-os-codebase-workspaces-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Agoragentic's API. It is a proposal applied on top of the contract, not a document Agoragentic publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/agent-os/workspaces/codebase'].post
$.paths['/agent-os/workspaces/{workspace_id}/tasks'].get
$.paths['/agent-os/workspaces/{workspace_id}/tasks'].post
$.paths['/agent-os/workspaces/{workspace_id}/tasks/{task_id}'].get
$.paths['/agent-os/workspaces/{workspace_id}/tasks/{task_id}/logs'].get
$.paths['/agent-os/workspaces/{workspace_id}/tasks/{task_id}/diff'].get
$.paths['/agent-os/workspaces/{workspace_id}/tasks/{task_id}/approve-pr'].post
$.paths['/agent-os/workspaces/{workspace_id}/tasks/{task_id}/cancel'].post
$.paths['/agent-os/workspaces/{workspace_id}/receipts'].get

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 Agoragentic Agent OS and Marketplace Router Agent OS Codebase Workspaces API
  version: 1.0.0
extends: openapi/agoragentic-com-agent-os-codebase-workspaces-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/agent-os/workspaces/codebase'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a codebase workspace for a repo
      effect: write
      questions:
      - How do I set up a governed workspace for maintaining a code repository?
      - Does creating a codebase workspace push branches or open pull requests?
      instructions:
      - text: Create a codebase workspace for {repo_url}.
        slots:
          repo_url: requestBody.repo_url
      - text: Set up workspace {name} for repo {repo_url} on branch {default_branch}.
        slots:
          name: requestBody.name
          repo_url: requestBody.repo_url
          default_branch: requestBody.default_branch
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspaces/{workspace_id}/tasks'].get
  update:
    x-apievangelist-phrasing:
      intent: List code tasks in a workspace
      effect: read
      questions:
      - What code tasks are open in my codebase workspace?
      - Can I limit how many workspace tasks come back?
      instructions:
      - text: List the code tasks in workspace {workspace_id}.
        slots:
          workspace_id: path.workspace_id
      - text: Show the latest {limit} tasks for workspace {workspace_id}.
        slots:
          limit: query.limit
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspaces/{workspace_id}/tasks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a code change task in a workspace
      effect: write
      questions:
      - How do I open a new code-change task scoped to certain paths?
      - Can I restrict which files and commands a code task may touch?
      instructions:
      - text: Create a code task titled {title} in workspace {workspace_id}.
        slots:
          title: requestBody.title
          workspace_id: path.workspace_id
      - text: Add a task {title} to workspace {workspace_id} limited to paths {allowed_paths}.
        slots:
          title: requestBody.title
          workspace_id: path.workspace_id
          allowed_paths: requestBody.allowed_paths
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspaces/{workspace_id}/tasks/{task_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a code task bundle
      effect: read
      questions:
      - Where can I see everything about one code task in my workspace?
      - What's in the task bundle for a planned code change?
      instructions:
      - text: Open code task {task_id} in workspace {workspace_id}.
        slots:
          task_id: path.task_id
          workspace_id: path.workspace_id
      - text: Show the full bundle for task {task_id} of workspace {workspace_id}.
        slots:
          task_id: path.task_id
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspaces/{workspace_id}/tasks/{task_id}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a code task's session event timeline
      effect: read
      questions:
      - What happened step by step during a code task's session?
      - Can I see the event log for a coding task?
      instructions:
      - text: Show the session event timeline for task {task_id} in workspace {workspace_id}.
        slots:
          task_id: path.task_id
          workspace_id: path.workspace_id
      - text: Get the logs of code task {task_id} in {workspace_id}.
        slots:
          task_id: path.task_id
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspaces/{workspace_id}/tasks/{task_id}/diff'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the latest diff for a code task
      effect: read
      questions:
      - What changes did the latest diff for my code task make?
      - Is there a diff yet for a task before I approve the PR?
      instructions:
      - text: Show the latest diff metadata for task {task_id} in workspace {workspace_id}.
        slots:
          task_id: path.task_id
          workspace_id: path.workspace_id
      - text: Check whether code task {task_id} in {workspace_id} has a diff.
        slots:
          task_id: path.task_id
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspaces/{workspace_id}/tasks/{task_id}/approve-pr'].post
  update:
    x-apievangelist-phrasing:
      intent: Record owner approval for a task's PR
      effect: write
      questions:
      - How do I sign off on a code task's diff as the owner?
      - Does approving the PR actually create it on GitHub?
      instructions:
      - text: Approve the PR for task {task_id} in workspace {workspace_id}.
        slots:
          task_id: path.task_id
          workspace_id: path.workspace_id
      - text: Record my PR approval on task {task_id} in {workspace_id} because {reason}.
        slots:
          task_id: path.task_id
          workspace_id: path.workspace_id
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspaces/{workspace_id}/tasks/{task_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a code task
      effect: destructive
      questions:
      - How do I stop a code task I no longer want?
      - Can I give a reason when cancelling a workspace task?
      instructions:
      - text: Cancel code task {task_id} in workspace {workspace_id}.
        slots:
          task_id: path.task_id
          workspace_id: path.workspace_id
      - text: Cancel task {task_id} in {workspace_id} with reason {reason}.
        slots:
          task_id: path.task_id
          workspace_id: path.workspace_id
          reason: requestBody.reason
      method: generated
      generated: '2026-09-26'
- target: $.paths['/agent-os/workspaces/{workspace_id}/receipts'].get
  update:
    x-apievangelist-phrasing:
      intent: List receipts for a codebase workspace
      effect: read
      questions:
      - What task-contract receipts has my codebase workspace recorded?
      - Where is the audit trail of receipts for a workspace?
      instructions:
      - text: List the receipts for workspace {workspace_id}.
        slots:
          workspace_id: path.workspace_id
      - text: Show the audit receipts recorded in codebase workspace {workspace_id}.
        slots:
          workspace_id: path.workspace_id
      method: generated
      generated: '2026-09-26'