AppsFlyer · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenDSR Production API

9 actions 9 updates phrasing extends openapi/appsflyer-production-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 9

$.info
$.paths['/api/gdpr/v1/opendsr_requests/{subject_request_id}'].get
$.paths['/api/gdpr/v1/opendsr_requests/{subject_request_id}'].delete
$.paths['/api/gdpr/v1/opendsr_requests/batch'].post
$.paths['/api/gdpr/v1/opendsr_requests'].post
$.paths['/api/gdpr/v1/discovery'].get
$.paths['/api/gdpr/v1/download/{subject_request_id}'].get
$.paths['/api/gdpr/v1/opendsr_requests/batch/{batch_id}'].get
$.paths['/api/gdpr/v1/certificate'].get

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 OpenDSR Production API
  version: 1.0.0
extends: openapi/appsflyer-production-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: 8
- target: $.paths['/api/gdpr/v1/opendsr_requests/{subject_request_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an OpenDSR request's status
      effect: read
      questions:
      - What is the status of the GDPR data subject request I submitted?
      - Has my OpenDSR erasure request been completed yet?
      instructions:
      - text: Get the status of OpenDSR request {subject_request_id}.
        slots:
          subject_request_id: path.subject_request_id
      - text: Check progress on data subject request {subject_request_id}.
        slots:
          subject_request_id: path.subject_request_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/gdpr/v1/opendsr_requests/{subject_request_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a pending OpenDSR request
      effect: destructive
      questions:
      - Can I cancel a GDPR request after submitting it?
      - Which OpenDSR requests can still be canceled, only pending ones?
      instructions:
      - text: Cancel OpenDSR request {subject_request_id}.
        slots:
          subject_request_id: path.subject_request_id
      - text: Withdraw the pending data subject request {subject_request_id}.
        slots:
          subject_request_id: path.subject_request_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/gdpr/v1/opendsr_requests/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a batch of OpenDSR requests
      effect: write
      questions:
      - How do I submit many GDPR deletion requests in a single call?
      - Can I send a batch of data subject requests together?
      instructions:
      - text: 'Submit these OpenDSR requests as one batch: {requests}.'
        slots:
          requests: requestBody.requests
      - text: File a batch of data subject requests {requests} with metadata {meta}.
        slots:
          requests: requestBody.requests
          meta: requestBody.meta
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/gdpr/v1/opendsr_requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a single OpenDSR request
      effect: write
      questions:
      - How do I submit a GDPR erasure request for one user?
      - Can I get a callback when a data subject request finishes?
      - What subject identities do I need to file an access request?
      instructions:
      - text: Submit an OpenDSR {subject_request_type} request for app {property_id} on {platform} with identities {subject_identities}.
        slots:
          subject_request_type: requestBody.subject_request_type
          property_id: requestBody.property_id
          platform: requestBody.platform
          subject_identities: requestBody.subject_identities
      - text: File data subject request {subject_request_id} and notify {status_callback_urls} when done.
        slots:
          subject_request_id: requestBody.subject_request_id
          status_callback_urls: requestBody.status_callback_urls
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/gdpr/v1/discovery'].get
  update:
    x-apievangelist-phrasing:
      intent: Get OpenDSR discovery metadata
      effect: read
      questions:
      - Which subject identity types and request types does the GDPR API support?
      - What API version is the OpenDSR service running?
      instructions:
      - text: Get the OpenDSR discovery metadata.
      - text: Show supported identity types and request types for data subject requests.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/gdpr/v1/download/{subject_request_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a completed access request report
      effect: read
      questions:
      - Where do I download the report for a finished GDPR access request?
      - Can I get the portability export once my request is complete?
      instructions:
      - text: Download the report for request {subject_request_id}.
        slots:
          subject_request_id: path.subject_request_id
      - text: Fetch the access or portability export of {subject_request_id}.
        slots:
          subject_request_id: path.subject_request_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/gdpr/v1/opendsr_requests/batch/{batch_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check statuses of an OpenDSR batch
      effect: read
      questions:
      - What is the status of each request in my GDPR batch?
      - Can I track a whole batch of data subject requests by its batch ID?
      instructions:
      - text: Get request statuses for batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Show how every request in OpenDSR batch {batch_id} is progressing.
        slots:
          batch_id: path.batch_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/gdpr/v1/certificate'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the OpenDSR signing certificate
      effect: read
      questions:
      - How do I verify the signature on OpenDSR responses?
      - Where is the processor certificate that signs GDPR responses?
      instructions:
      - text: Download the OpenDSR processor certificate.
      - text: Get the public certificate used to sign data subject responses.
      method: generated
      generated: '2026-10-01'