# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Microsoft Azure Azure IoT Central Dashboards API
  version: 1.0.0
extends: openapi/microsoft-azure-dashboards-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['/dashboards'].get
  update:
    x-apievangelist-phrasing:
      intent: List dashboards in an IoT Central app
      effect: read
      questions:
      - What dashboards exist in my IoT Central application?
      - Can I filter or sort the list of IoT Central dashboards?
      instructions:
      - text: List dashboards matching filter {filter}.
        slots:
          filter: query.filter
      - text: List the application's dashboards ordered by {orderby}, {page_size} per page.
        slots:
          orderby: query.orderby
          page_size: query.maxpagesize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboards/{dashboardId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an IoT Central dashboard
      effect: read
      questions:
      - How do I retrieve one IoT Central dashboard and its tiles?
      - Is a particular dashboard personal or shared with the whole app?
      instructions:
      - text: Get dashboard {dashboard_id}.
        slots:
          dashboard_id: path.dashboardId
      - text: Show the tiles on IoT Central dashboard {dashboard_id}.
        slots:
          dashboard_id: path.dashboardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboards/{dashboardId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an IoT Central dashboard
      effect: write
      questions:
      - How do I create a new dashboard in IoT Central through the API?
      - Can I make a personal dashboard and mark it as a favorite when creating it?
      instructions:
      - text: Create dashboard {dashboard_id} called {display_name}.
        slots:
          dashboard_id: path.dashboardId
          display_name: requestBody.displayName
      - text: Create a personal ({personal}) dashboard {dashboard_id} named {display_name} with tiles {tiles}.
        slots:
          personal: requestBody.personal
          dashboard_id: path.dashboardId
          display_name: requestBody.displayName
          tiles: requestBody.tiles
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboards/{dashboardId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an IoT Central dashboard
      effect: destructive
      questions:
      - How do I delete a dashboard from my IoT Central application?
      - Can I remove an old dashboard by its ID?
      instructions:
      - text: Delete dashboard {dashboard_id}.
        slots:
          dashboard_id: path.dashboardId
      - text: Remove IoT Central dashboard {dashboard_id} from the app.
        slots:
          dashboard_id: path.dashboardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/dashboards/{dashboardId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an IoT Central dashboard
      effect: write
      questions:
      - How do I change an existing IoT Central dashboard?
      - Can I guard a dashboard update with an ETag so I don't overwrite someone else's edit?
      instructions:
      - text: Update dashboard {dashboard_id}.
        slots:
          dashboard_id: path.dashboardId
      - text: Update dashboard {dashboard_id} only if its ETag still matches {etag}.
        slots:
          dashboard_id: path.dashboardId
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'