AppsFlyer · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Test Console Allowed devices API

3 actions 3 updates phrasing extends openapi/appsflyer-allowed-devices-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for AppsFlyer's API. It is a proposal applied on top of the contract, not a document AppsFlyer publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/{app-id}/devices/{device-id}'].delete

$.paths['/{app-id}/devices'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Test Console Allowed devices API
  version: 1.0.0
extends: openapi/appsflyer-allowed-devices-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: 2
- target: $.paths['/{app-id}/devices/{device-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a test device from an app
      effect: destructive
      questions:
      - How do I take a registered test device off my app?
      - Can I unregister a device I no longer use for testing?
      instructions:
      - text: Remove test device {device_id} from app {app_id}.
        slots:
          device_id: path.device-id
          app_id: path.app-id
      - text: Delete device {device_id} from the allowed test devices of {app_id}.
        slots:
          device_id: path.device-id
          app_id: path.app-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{app-id}/devices'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a test device for an app
      effect: write
      questions:
      - How do I register a phone as a test device for my app?
      - What device ID types can I use when adding a test device?
      - Can I give a test device a friendly name when I register it?
      instructions:
      - text: Add test device {device_id} of type {device_id_type} named {device_name} to app {app_id}.
        slots:
          device_id: requestBody.device_id
          device_id_type: requestBody.device_id_type
          device_name: requestBody.device_name
          app_id: path.app-id
      - text: Register my phone {device_id} as an allowed test device for {app_id}, ID type {device_id_type}, called {device_name}.
        slots:
          device_id: requestBody.device_id
          app_id: path.app-id
          device_id_type: requestBody.device_id_type
          device_name: requestBody.device_name
      method: generated
      generated: '2026-10-01'