# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for BigPanda Topology API
  version: 1.0.0
extends: openapi/bigpanda-topology-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: 5
- target: $.paths['/resources/v2.0/topologies'].get
  update:
    x-apievangelist-phrasing:
      intent: List topology models
      effect: read
      questions:
      - Does my organization already have a topology model defined?
      - Can I list the topology models BigPanda uses for my services?
      instructions:
      - text: List all topology models.
      - text: Show the organization's topologies.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/topologies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create the organization's topology model
      effect: write
      questions:
      - How do I describe how my services and hosts connect to each other?
      - Can I have more than one topology model per organization?
      instructions:
      - text: Create a topology model with links {links}.
        slots:
          links: requestBody.links
      - text: Set up our organization's first topology model.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/topologies/{model_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a topology model
      effect: read
      questions:
      - What links are in my current topology model?
      - Can I fetch a topology model by its model ID?
      instructions:
      - text: Get topology model {model_id}.
        slots:
          model_id: path.model_id
      - text: Show the links in topology {model_id}.
        slots:
          model_id: path.model_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/topologies/{model_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the topology model's links
      effect: write
      questions:
      - Can I replace the service dependency links in my topology?
      - How do I add new connections to an existing topology model?
      instructions:
      - text: Update topology {model_id} with links {links}.
        slots:
          model_id: path.model_id
          links: requestBody.links
      - text: Replace the dependency links of topology {model_id}.
        slots:
          model_id: path.model_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resources/v2.0/topologies/{model_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete the topology model
      effect: destructive
      questions:
      - How do I remove my organization's topology model entirely?
      - Can I delete a topology so I can create a fresh one?
      instructions:
      - text: Delete topology model {model_id}.
        slots:
          model_id: path.model_id
      - text: Remove topology {model_id} from the system.
        slots:
          model_id: path.model_id
      method: generated
      generated: '2026-09-26'