AppsFlyer · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenDSR Stub & Testing API

9 actions 9 updates phrasing extends openapi/appsflyer-stub-testing-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/stub/{subject_request_id}'].get
$.paths['/api/gdpr/v1/stub/{subject_request_id}'].delete
$.paths['/api/gdpr/v1/stub/batch'].post
$.paths['/api/gdpr/v1/stub'].post
$.paths['/api/gdpr/v1/stub/download/{subject_request_id}'].get
$.paths['/api/gdpr/v1/stub/batch/{batch_id}'].get
$.paths['/api/gdpr/v1/stub/certificate'].get
$.paths['/api/gdpr/v1/stub/discovery'].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 Stub & Testing API
  version: 1.0.0
extends: openapi/appsflyer-stub-testing-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/stub/{subject_request_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a stub OpenDSR request's status
      effect: read
      questions:
      - While testing my GDPR integration, what status did my stub request get?
      - Can I poll a test-mode data subject request without touching real data?
      instructions:
      - text: Get the status of stub request {subject_request_id}.
        slots:
          subject_request_id: path.subject_request_id
      - text: Check my test-mode OpenDSR submission {subject_request_id}.
        slots:
          subject_request_id: path.subject_request_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/gdpr/v1/stub/{subject_request_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a stub OpenDSR request
      effect: destructive
      questions:
      - Can I test canceling a data subject request in stub mode?
      - How do I cancel a test-mode GDPR submission?
      instructions:
      - text: Cancel stub request {subject_request_id}.
        slots:
          subject_request_id: path.subject_request_id
      - text: Withdraw my test-mode OpenDSR submission {subject_request_id}.
        slots:
          subject_request_id: path.subject_request_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/gdpr/v1/stub/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a stub batch of OpenDSR requests
      effect: write
      questions:
      - Can I try out batch GDPR submissions in a test mode first?
      - How do I send a batch of test data subject requests?
      instructions:
      - text: Submit a stub batch of test requests {requests}.
        slots:
          requests: requestBody.requests
      - text: Send test-mode batch {requests} with metadata {meta}.
        slots:
          requests: requestBody.requests
          meta: requestBody.meta
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/gdpr/v1/stub'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a stub OpenDSR request
      effect: write
      questions:
      - How can I test a single GDPR request submission without processing real user data?
      - Does the stub endpoint accept the same fields as a real data subject request?
      instructions:
      - text: Submit a stub {subject_request_type} request for app {property_id} with identities {subject_identities}.
        slots:
          subject_request_type: requestBody.subject_request_type
          property_id: requestBody.property_id
          subject_identities: requestBody.subject_identities
      - text: Create test-mode request {subject_request_id} and call back {status_callback_urls}.
        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/stub/download/{subject_request_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a stub request report
      effect: read
      questions:
      - Can I download a sample report for a stub access request?
      - What does the report for a test-mode request look like?
      instructions:
      - text: Download the stub report for {subject_request_id}.
        slots:
          subject_request_id: path.subject_request_id
      - text: Fetch the test-mode report of request {subject_request_id}.
        slots:
          subject_request_id: path.subject_request_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/gdpr/v1/stub/batch/{batch_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check statuses of a stub OpenDSR batch
      effect: read
      questions:
      - How are the requests in my stub test batch doing?
      - Can I check every request in a test-mode batch by batch ID?
      instructions:
      - text: Get stub request statuses for batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Show progress of test batch {batch_id}.
        slots:
          batch_id: path.batch_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/gdpr/v1/stub/certificate'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the stub signing certificate
      effect: read
      questions:
      - Where do I get the certificate to verify signatures in stub mode?
      - Is there a test-mode copy of the processor certificate?
      instructions:
      - text: Download the stub processor certificate.
      - text: Get the signing certificate from the test-mode endpoint.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/gdpr/v1/stub/discovery'].get
  update:
    x-apievangelist-phrasing:
      intent: Get stub OpenDSR discovery metadata
      effect: read
      questions:
      - Which identity and request types does the stub GDPR endpoint support?
      - What API version does the test-mode OpenDSR service report?
      instructions:
      - text: Get stub discovery metadata.
      - text: Show the test-mode supported identity types and request types.
      method: generated
      generated: '2026-10-01'