# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Database Scripts API
  version: 1.0.0
extends: openapi/optimizely-database-scripts-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: 9
- target: $.paths['/api/v1/admin/DatabaseScripts'].get
  update:
    x-apievangelist-phrasing:
      intent: List applied database scripts
      effect: read
      questions:
      - Which database upgrade scripts have been applied to my commerce instance?
      - Can I sort database scripts by when they were applied?
      instructions:
      - text: List all database scripts.
      - text: List database scripts matching {filter}, ordered by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/DatabaseScripts'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a database script
      effect: write
      questions:
      - How do I record that a database script was applied?
      - Can I log a script's run time when registering it?
      instructions:
      - text: Record database script {scriptName}.
        slots:
          scriptName: requestBody.scriptName
      - text: Record script {scriptName} applied on {appliedOn} with run time {runTime}.
        slots:
          scriptName: requestBody.scriptName
          appliedOn: requestBody.appliedOn
          runTime: requestBody.runTime
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/DatabaseScripts({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a database script record
      effect: read
      questions:
      - How do I check when one database script was applied?
      - How long did a specific database script take to run?
      instructions:
      - text: Get database script {id}.
        slots:
          id: path.id
      - text: Show when database script {id} was applied.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/DatabaseScripts({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a database script record
      effect: write
      questions:
      - How do I overwrite a database script record in full?
      - Does replacing a script record need the script name again?
      instructions:
      - text: Replace database script {id} with name {scriptName}.
        slots:
          id: path.id
          scriptName: requestBody.scriptName
      - text: Fully overwrite script record {id} with applied date {appliedOn}.
        slots:
          id: path.id
          appliedOn: requestBody.appliedOn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/DatabaseScripts({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a database script record
      effect: destructive
      questions:
      - How do I remove a database script record?
      - Can I delete a script record only if its ETag still matches?
      instructions:
      - text: Delete database script {id}.
        slots:
          id: path.id
      - text: Delete database script record {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/DatabaseScripts({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a database script record
      effect: write
      questions:
      - How do I correct the run time logged for a database script?
      - Can I change just the applied date on a script record?
      instructions:
      - text: Set run time of database script {id} to {runTime}.
        slots:
          id: path.id
          runTime: requestBody.runTime
      - text: Change applied date of script record {id} to {appliedOn}.
        slots:
          id: path.id
          appliedOn: requestBody.appliedOn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/DatabaseScripts/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default database script template
      effect: read
      questions:
      - What default values does a new database script record start with?
      - Where can I get a blank database script record?
      instructions:
      - text: Get the default database script template.
      - text: Show default values for a new database script record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/databasescripts/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete database script records
      effect: destructive
      questions:
      - How do I delete several database script records at once?
      - Can I bulk remove script records by id?
      instructions:
      - text: Delete database scripts {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove database script records {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/databasescripts({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a database script custom property
      effect: read
      questions:
      - How do I read a custom property on a database script record?
      - Where is one custom property value for a database script?
      instructions:
      - text: Get custom property {custompropertyKey} of database script {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show database script {key}'s custom property {custompropertyKey}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'