Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Episerver Cloud Database Exports API

3 actions 3 updates phrasing extends openapi/optimizely-databaseexports-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 3

$.info
$.paths['/api/v1.0/projects/{projectId}/environments/{environment}/databases/{databaseName}/exports'].post
$.paths['/api/v1.0/projects/{projectId}/environments/{environment}/databases/{databaseName}/exports/{exportId}'].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 Episerver Cloud Database Exports API
  version: 1.0.0
extends: openapi/optimizely-databaseexports-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: 2
- target: $.paths['/api/v1.0/projects/{projectId}/environments/{environment}/databases/{databaseName}/exports'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a DXP database
      effect: write
      questions:
      - How do I export my CMS or Commerce database from a DXP environment as a bacpac?
      - Can I keep the exported database file longer than 24 hours?
      instructions:
      - text: Export database {databaseName} from {environment} in project {projectId}.
        slots:
          projectId: path.projectId
          environment: path.environment
          databaseName: path.databaseName
      - text: Export {databaseName} from {environment} in project {projectId} and keep it for {retentionHours} hours.
        slots:
          projectId: path.projectId
          environment: path.environment
          databaseName: path.databaseName
          retentionHours: requestBody.retentionHours
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1.0/projects/{projectId}/environments/{environment}/databases/{databaseName}/exports/{exportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a database export's status
      effect: read
      questions:
      - Is my database export finished, and where do I download the bacpac?
      - How do I get the download link for a completed database export?
      instructions:
      - text: Get status of export {exportId} for {databaseName} in {environment}, project {projectId}.
        slots:
          projectId: path.projectId
          environment: path.environment
          databaseName: path.databaseName
          exportId: path.exportId
      - text: Show the download URI for database export {exportId} of {databaseName} ({environment}, project {projectId}).
        slots:
          projectId: path.projectId
          environment: path.environment
          databaseName: path.databaseName
          exportId: path.exportId
      method: generated
      generated: '2026-09-26'