# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Flora.ai Projects API
  version: 1.0.0
extends: openapi/flora-fauna-projects-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: 5
- target: $.paths['/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List projects in a workspace
      effect: read
      questions:
      - Which projects are in my workspace, most recently active first?
      - Can I search a workspace's projects by name?
      instructions:
      - text: List the projects in workspace {workspace_id}.
        slots:
          workspace_id: query.workspace_id
      - text: Find projects matching {query} in workspace {workspace_id}.
        slots:
          query: query.query
          workspace_id: query.workspace_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project
      effect: write
      questions:
      - How do I start a new Flora project through the API?
      - What do I need to provide to create a project in a workspace?
      instructions:
      - text: Create a project named {name} in workspace {workspace_id}.
        slots:
          name: requestBody.name
          workspace_id: requestBody.workspace_id
      - text: Set up a new project {name} under workspace {workspace_id}.
        slots:
          name: requestBody.name
          workspace_id: requestBody.workspace_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project's details
      effect: read
      questions:
      - How can I look up the metadata for one project by its ID?
      - Does a project I can't access return the same error as one that doesn't exist?
      instructions:
      - text: Get project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show me the details of project {projectId}.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/canvas'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project canvas as a Mermaid flowchart
      effect: read
      questions:
      - Can I export the layout of a project canvas as a Mermaid diagram?
      - How do I see how the nodes on my canvas are connected?
      instructions:
      - text: Get the canvas flowchart for project {projectId}.
        slots:
          projectId: path.projectId
      - text: Show the node topology of project {projectId}'s canvas in Mermaid.
        slots:
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/projects/{projectId}/canvas'].patch
  update:
    x-apievangelist-phrasing:
      intent: Add and connect canvas nodes from Mermaid
      effect: write
      questions:
      - Can I add nodes to a canvas by sending a Mermaid flowchart?
      - How do I wire new nodes to existing ones on my project canvas programmatically?
      - Is there a way to set parameters on individual nodes when patching the canvas?
      instructions:
      - text: Apply Mermaid diagram {diagram} to the canvas of project {projectId}.
        slots:
          diagram: requestBody.diagram
          projectId: path.projectId
      - text: Patch project {projectId}'s canvas with {diagram} using node parameters {node_params}.
        slots:
          projectId: path.projectId
          diagram: requestBody.diagram
          node_params: requestBody.node_params
      method: generated
      generated: '2026-10-01'