Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Optimizely Subject Access Requests API

7 actions 7 updates phrasing extends openapi/optimizely-subject-access-requests-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 7

$.info
$.paths['/internal-subject-access-requests'].get
$.paths['/internal-subject-access-requests/{request_id}'].post
$.paths['/internal-subject-access-requests/{request_id}'].patch
$.paths['/subject-access-requests'].get
$.paths['/subject-access-requests'].post
$.paths['/subject-access-requests/{request_id}'].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 Optimizely Subject Access Requests API
  version: 1.0.0
extends: openapi/optimizely-subject-access-requests-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: 6
- target: $.paths['/internal-subject-access-requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List subject access requests by data source and status
      effect: read
      questions:
      - Which privacy requests are still pending for a given data source?
      - Can internal teams list subject access requests filtered by status?
      instructions:
      - text: List subject access requests for data source {data_source} with status {status}.
        slots:
          data_source: query.data_source
          status: query.status
      - text: Show {per_page} {status} privacy requests from source {data_source}.
        slots:
          per_page: query.per_page
          status: query.status
          data_source: query.data_source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/internal-subject-access-requests/{request_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a subject access request via POST
      effect: write
      questions:
      - Is there a POST form of updating a subject access request's status?
      - Can I record the export location when completing a request using the POST update?
      instructions:
      - text: Use the POST update to set subject access request {request_id} to status {status}.
        slots:
          request_id: path.request_id
          status: requestBody.status
      - text: Post a completion for request {request_id} with status {status} and export location {export_location}.
        slots:
          request_id: path.request_id
          status: requestBody.status
          export_location: requestBody.export_location
      method: generated
      generated: '2026-09-26'
- target: $.paths['/internal-subject-access-requests/{request_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a subject access request via PATCH
      effect: write
      questions:
      - How do I patch the status of a subject access request?
      - Can I record when processing started on a privacy request with a PATCH?
      instructions:
      - text: Patch subject access request {request_id} to status {status}.
        slots:
          request_id: path.request_id
          status: requestBody.status
      - text: Patch request {request_id} to {status} with processing started at {processing_started_time}.
        slots:
          request_id: path.request_id
          status: requestBody.status
          processing_started_time: requestBody.processing_started_time
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subject-access-requests'].get
  update:
    x-apievangelist-phrasing:
      intent: List subject access requests from my account
      effect: read
      questions:
      - What GDPR access or deletion requests has my account submitted to Optimizely?
      - Can I page through my account's subject access requests?
      instructions:
      - text: List the subject access requests my account has submitted.
      - text: Show page {page} of my account's privacy requests.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subject-access-requests'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a data access or deletion request
      effect: write
      questions:
      - How do I request deletion of all data tied to an end user's email?
      - Can I ask for an export of the data held about a visitor?
      - Where does the exported data end up once an access request completes?
      instructions:
      - text: Submit a {request_type} request for {data_type} data identified by {identifier_type} {identifier}.
        slots:
          request_type: requestBody.request_type
          data_type: requestBody.data_type
          identifier_type: requestBody.identifier_type
          identifier: requestBody.identifier
      - text: File a subject access request of type {request_type} for {data_type} with {identifier_type} {identifier}.
        slots:
          identifier: requestBody.identifier
          request_type: requestBody.request_type
          data_type: requestBody.data_type
          identifier_type: requestBody.identifier_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subject-access-requests/{request_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a subject access request
      effect: read
      questions:
      - Has my privacy request finished processing yet?
      - When is the deadline for a particular subject access request?
      instructions:
      - text: Get subject access request {request_id}.
        slots:
          request_id: path.request_id
      - text: Check the status and export link for privacy request {request_id}.
        slots:
          request_id: path.request_id
      method: generated
      generated: '2026-09-26'