# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Dashboard Panel Positions API
  version: 1.0.0
extends: openapi/optimizely-dashboard-panel-positions-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['/api/v1/admin/DashboardPanelPositions'].get
  update:
    x-apievangelist-phrasing:
      intent: List admin dashboard panel positions
      effect: read
      questions:
      - How do I see how each admin user has arranged the panels on their dashboard?
      - Can I filter dashboard panel positions to one user's layout?
      instructions:
      - text: List all dashboard panel positions.
      - text: List dashboard panel positions matching {filter}, ordered by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/DashboardPanelPositions'].post
  update:
    x-apievangelist-phrasing:
      intent: Place a panel on a user's dashboard
      effect: write
      questions:
      - How do I add a panel to an admin user's dashboard layout?
      - What panel type is required when saving a dashboard panel position?
      instructions:
      - text: Add a {panelType} panel to the dashboard of user {userProfileId}.
        slots:
          panelType: requestBody.panelType
          userProfileId: requestBody.userProfileId
      - text: Create a dashboard panel position of type {panelType} at slot {sortOrder}.
        slots:
          panelType: requestBody.panelType
          sortOrder: requestBody.sortOrder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/DashboardPanelPositions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one dashboard panel position
      effect: read
      questions:
      - How do I look up a single dashboard panel placement by ID?
      - Which panel type and order does a specific panel position record hold?
      instructions:
      - text: Get dashboard panel position {id}.
        slots:
          id: path.id
      - text: Show the panel type and sort order for panel position {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/DashboardPanelPositions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a dashboard panel position
      effect: write
      questions:
      - How do I overwrite a whole dashboard panel position record?
      - Is there a way to fully replace a panel placement instead of patching it?
      instructions:
      - text: Replace panel position {id} with a {panelType} panel at order {sortOrder}.
        slots:
          id: path.id
          panelType: requestBody.panelType
          sortOrder: requestBody.sortOrder
      - text: Overwrite dashboard panel position {id} with panel type {panelType}.
        slots:
          id: path.id
          panelType: requestBody.panelType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/DashboardPanelPositions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a panel from a dashboard
      effect: destructive
      questions:
      - How do I take a panel off an admin user's dashboard?
      - Can I delete a panel position only if its ETag still matches?
      instructions:
      - text: Delete dashboard panel position {id}.
        slots:
          id: path.id
      - text: Remove panel position {id} if its ETag is still {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/DashboardPanelPositions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Reorder a panel on a dashboard
      effect: write
      questions:
      - How do I move a dashboard panel to a different position?
      - Can I change just the sort order of one panel placement?
      instructions:
      - text: Move dashboard panel position {id} to sort order {sortOrder}.
        slots:
          id: path.id
          sortOrder: requestBody.sortOrder
      - text: Change panel position {id} to show a {panelType} panel.
        slots:
          id: path.id
          panelType: requestBody.panelType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/DashboardPanelPositions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank dashboard panel position template
      effect: read
      questions:
      - What default values does a new dashboard panel position start with?
      - Can I fetch an empty panel position template before creating one?
      instructions:
      - text: Fetch the default dashboard panel position template.
      - text: Show me the starting values for a new panel placement.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/dashboardpanelpositions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete dashboard panel positions
      effect: destructive
      questions:
      - How do I clear several dashboard panel placements at once?
      - Can I remove a batch of panel positions by ID?
      instructions:
      - text: Bulk delete the dashboard panel positions with IDs {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these panel placements in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/dashboardpanelpositions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a panel position
      effect: read
      questions:
      - How do I read a custom property stored on a dashboard panel position?
      - Can I fetch one extra field value from a panel placement?
      instructions:
      - text: Get custom property {custompropertyKey} on dashboard panel position {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the custom property {custompropertyKey} of panel placement {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'