Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Advanced Compliance API

8 actions 8 updates phrasing extends openapi/optimizely-compliance-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Optimizely's API. It is a proposal applied on top of the contract, not a document Optimizely publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/compliance/gdpr/delete'].post
$.paths['/compliance/ccpa/delete'].post
$.paths['/compliance/ccpa/optout'].post
$.paths['/compliance/lgpd/delete'].post
$.paths['/compliance/gdpr/status/{requestId}'].get
$.paths['/compliance/ccpa/status/{requestId}'].get
$.paths['/compliance/lgpd/status/{requestId}'].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 Advanced Compliance API
  version: 1.0.0
extends: openapi/optimizely-compliance-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: 7
- target: $.paths['/compliance/gdpr/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Request GDPR deletion of a customer's data
      effect: destructive
      questions:
      - How do I honour a GDPR right-to-erasure request for a customer in Optimizely?
      - Can I submit a GDPR delete request through the API instead of by hand?
      instructions:
      - text: Send a GDPR delete request for this customer.
      - text: File a GDPR erasure request to remove the customer's data.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance/ccpa/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Request CCPA deletion of a customer's data
      effect: destructive
      questions:
      - What call deletes a California customer's data under CCPA?
      - Is there a separate endpoint for CCPA deletion requests?
      instructions:
      - text: Send a CCPA delete request for this customer.
      - text: Submit a CCPA request to erase the California customer's data.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance/ccpa/optout'].post
  update:
    x-apievangelist-phrasing:
      intent: Opt a customer out of data sale under CCPA
      effect: write
      questions:
      - How do I record a customer's CCPA opt-out request?
      - Can I opt a customer out under CCPA without deleting their data?
      instructions:
      - text: Send a CCPA opt-out request for this customer.
      - text: Register this customer's CCPA opt-out.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance/lgpd/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Request LGPD deletion of a customer's data
      effect: destructive
      questions:
      - How do I delete a Brazilian customer's data under LGPD?
      - Which endpoint handles LGPD compliance delete requests?
      instructions:
      - text: Send an LGPD delete request for this customer.
      - text: File an LGPD erasure request for the customer's data.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance/gdpr/status/{requestId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a GDPR delete request's status
      effect: read
      questions:
      - Has my earlier GDPR delete request been completed yet?
      - Where do I check progress on a GDPR erasure by request ID?
      instructions:
      - text: Check the status of GDPR request {requestId}.
        slots:
          requestId: path.requestId
      - text: Tell me whether GDPR deletion {requestId} is done.
        slots:
          requestId: path.requestId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance/ccpa/status/{requestId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a CCPA delete or opt-out request's status
      effect: read
      questions:
      - Is my CCPA delete or opt-out request still pending?
      - Can I look up the outcome of a CCPA request by its ID?
      instructions:
      - text: Check the status of CCPA request {requestId}.
        slots:
          requestId: path.requestId
      - text: Tell me where CCPA opt-out or deletion {requestId} stands.
        slots:
          requestId: path.requestId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/compliance/lgpd/status/{requestId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an LGPD delete request's status
      effect: read
      questions:
      - Has my LGPD delete request finished processing?
      - Where can I track an LGPD erasure request by ID?
      instructions:
      - text: Check the status of LGPD request {requestId}.
        slots:
          requestId: path.requestId
      - text: Tell me whether LGPD deletion {requestId} is complete.
        slots:
          requestId: path.requestId
      method: generated
      generated: '2026-09-26'