# 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 Version Histories API
  version: 1.0.0
extends: openapi/optimizely-version-histories-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: 10
- target: $.paths['/api/v1/admin/VersionHistories'].get
  update:
    x-apievangelist-phrasing:
      intent: List version history records
      effect: read
      questions:
      - Where can I see the version history entries recorded by my commerce platform?
      - Can I sort version histories by version number or last write time?
      instructions:
      - text: List all version history records.
      - text: List version histories ordered by {orderby}, top {top}.
        slots:
          orderby: query.$orderby
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VersionHistories'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a new version history entry
      effect: write
      questions:
      - How do I log a new version history entry with a version number and type?
      - What fields are required to create a version history record?
      instructions:
      - text: Create a version history entry for version {versionNumber} of type {type}.
        slots:
          versionNumber: requestBody.versionNumber
          type: requestBody.type
      - text: Record version {versionNumber} ({type}) last written at {lastWriteTimeUtc}.
        slots:
          versionNumber: requestBody.versionNumber
          type: requestBody.type
          lastWriteTimeUtc: requestBody.lastWriteTimeUtc
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VersionHistories({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one version history record
      effect: read
      questions:
      - How do I read a single version history entry by ID?
      - Can I expand the actions attached to a version history record?
      instructions:
      - text: Get version history {id}.
        slots:
          id: path.id
      - text: Show version history {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VersionHistories({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a version history record
      effect: write
      questions:
      - How do I overwrite an entire version history entry?
      - Does replacing a version history record need the version number and type again?
      instructions:
      - text: Replace version history {id} with version {versionNumber} of type {type}.
        slots:
          id: path.id
          versionNumber: requestBody.versionNumber
          type: requestBody.type
      - text: Fully overwrite version history record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VersionHistories({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a version history record
      effect: destructive
      questions:
      - How do I remove one version history entry?
      - Can I delete a version history record only if its ETag still matches?
      instructions:
      - text: Delete version history {id}.
        slots:
          id: path.id
      - text: Delete version history {id} guarded by ETag {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VersionHistories({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields on a version history record
      effect: write
      questions:
      - Can I correct just the version number on an existing history entry?
      - How do I update only the last write time of a version history record?
      instructions:
      - text: Set version history {id} to version number {versionNumber}.
        slots:
          id: path.id
          versionNumber: requestBody.versionNumber
      - text: Update the last write time of version history {id} to {lastWriteTimeUtc}.
        slots:
          id: path.id
          lastWriteTimeUtc: requestBody.lastWriteTimeUtc
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VersionHistories/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the Default function on version histories
      effect: read
      questions:
      - What does the Default OData function on version histories return?
      - Is there a default version history entity I can read?
      instructions:
      - text: Call the Default function on version histories.
      - text: Get the default version history entity.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/versionhistories/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete version history records
      effect: destructive
      questions:
      - Can I prune several version history entries in one request?
      - How do I delete a list of version histories by ID?
      instructions:
      - text: Bulk delete version histories {ids}.
        slots:
          ids: query.ids
      - text: 'Prune these version history records: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/versionhistories({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a version history
      effect: read
      questions:
      - How do I read a custom property stored on a version history entry?
      - Can version history records carry custom fields?
      instructions:
      - text: Get custom property {custompropertyKey} of version history {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Read custom field {custompropertyKey} on version history {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/versionhistories({key})/versionhistoryactions({versionhistoryactionKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an action logged in a version history
      effect: read
      questions:
      - What actions were logged as part of a particular version history entry?
      - Can I look up one version history action by its key?
      instructions:
      - text: Get action {versionhistoryactionKey} of version history {key}.
        slots:
          versionhistoryactionKey: path.versionhistoryactionKey
          key: path.key
      - text: Show the logged action {versionhistoryactionKey} in version {key}.
        slots:
          versionhistoryactionKey: path.versionhistoryactionKey
          key: path.key
      method: generated
      generated: '2026-09-26'