AppsFlyer · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OneLink API v2.0 OneLink REST API v2.0 API

7 actions 7 updates phrasing extends openapi/appsflyer-onelink-rest-api-v2-0-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 7

$.info
$.paths['/shortlinks/{onelink-id}/{shortlink-id}'].get
$.paths['/shortlinks/{onelink-id}/{shortlink-id}'].put
$.paths['/shortlinks/{onelink-id}/{shortlink-id}'].delete
$.paths['/shortlinks/{onelink-id}/{shortlink-id}/qr'].get
$.paths['/shortlinks-quota/{account-id}'].get
$.paths['/shortlinks/{onelink-id}'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for OneLink API v2.0 OneLink REST API v2.0 API
  version: 1.0.0
extends: openapi/appsflyer-onelink-rest-api-v2-0-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: 6
- target: $.paths['/shortlinks/{onelink-id}/{shortlink-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a OneLink short link's data
      effect: read
      questions:
      - How do I look up the parameters behind an existing OneLink short link?
      - What data is stored on short link qwer9876 under my OneLink template?
      instructions:
      - text: Get the data for short link {shortlink_id} in OneLink template {onelink_id}.
        slots:
          shortlink_id: path.shortlink-id
          onelink_id: path.onelink-id
      - text: Show the query parameters of OneLink {onelink_id}/{shortlink_id}.
        slots:
          onelink_id: path.onelink-id
          shortlink_id: path.shortlink-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shortlinks/{onelink-id}/{shortlink-id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing OneLink short link
      effect: write
      questions:
      - Can I change the parameters of a OneLink short link I already created?
      - How do I extend the time to live on an existing short link?
      instructions:
      - text: Update short link {shortlink_id} in template {onelink_id} with data {data}.
        slots:
          shortlink_id: path.shortlink-id
          onelink_id: path.onelink-id
          data: requestBody.data
      - text: Change the TTL of existing link {onelink_id}/{shortlink_id} to {ttl} and keep data {data}.
        slots:
          onelink_id: path.onelink-id
          shortlink_id: path.shortlink-id
          ttl: requestBody.ttl
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shortlinks/{onelink-id}/{shortlink-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a OneLink short link
      effect: destructive
      questions:
      - How do I delete a OneLink short link I no longer need?
      - Is removing a short link from a OneLink template permanent?
      instructions:
      - text: Delete short link {shortlink_id} from OneLink template {onelink_id}.
        slots:
          shortlink_id: path.shortlink-id
          onelink_id: path.onelink-id
      - text: Remove OneLink {onelink_id}/{shortlink_id}.
        slots:
          onelink_id: path.onelink-id
          shortlink_id: path.shortlink-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shortlinks/{onelink-id}/{shortlink-id}/qr'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a QR code for a OneLink short link
      effect: read
      questions:
      - Can I generate a QR code for one of my OneLink short links?
      - What sizes and formats can the OneLink QR code come in?
      instructions:
      - text: Get the QR code for short link {shortlink_id} in template {onelink_id}.
        slots:
          shortlink_id: path.shortlink-id
          onelink_id: path.onelink-id
      - text: Make a {size} {format} QR code for OneLink {onelink_id}/{shortlink_id}.
        slots:
          size: query.size
          format: query.format
          onelink_id: path.onelink-id
          shortlink_id: path.shortlink-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shortlinks-quota/{account-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the account's short link quota
      effect: read
      questions:
      - How many OneLink short links do I have left in my quota?
      - Am I close to the short link creation limit on my account?
      instructions:
      - text: Check the short link quota for account {account_id}.
        slots:
          account_id: path.account-id
      - text: Show remaining OneLink quota on {account_id}.
        slots:
          account_id: path.account-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shortlinks/{onelink-id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a OneLink short link
      effect: write
      questions:
      - How do I create a new OneLink short link from my template?
      - Can I pick my own short link ID instead of a random one?
      - What is the maximum time to live for a new short link?
      instructions:
      - text: Create a short link in OneLink template {onelink_id} with data {data}.
        slots:
          onelink_id: path.onelink-id
          data: requestBody.data
      - text: Create OneLink link {shortlink_id} under {onelink_id} with params {data}, valid for {ttl}.
        slots:
          shortlink_id: requestBody.shortlink_id
          onelink_id: path.onelink-id
          data: requestBody.data
          ttl: requestBody.ttl
      method: generated
      generated: '2026-10-01'