# 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 History Actions API
  version: 1.0.0
extends: openapi/optimizely-version-history-actions-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/VersionHistoryActions'].get
  update:
    x-apievangelist-phrasing:
      intent: List version history actions
      effect: read
      questions:
      - What actions have been recorded against version history entries?
      - Can I filter version history actions to one version history record?
      instructions:
      - text: List version history actions.
      - text: List version history actions matching {filter}, ordered by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VersionHistoryActions'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a version history action
      effect: write
      questions:
      - How do I log a named action against a version history entry?
      - What does a new version history action require?
      instructions:
      - text: Record action {name} on version history {versionHistoryId}.
        slots:
          name: requestBody.name
          versionHistoryId: requestBody.versionHistoryId
      - text: Create a version history action named {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VersionHistoryActions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a version history action
      effect: read
      questions:
      - Can I look up one version history action by its id?
      - Who created a specific version history action and when?
      instructions:
      - text: Get version history action {id}.
        slots:
          id: path.id
      - text: Show the details of version action {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VersionHistoryActions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a version history action
      effect: write
      questions:
      - Is there a way to overwrite a version history action completely?
      - What must I resend to replace a whole version history action?
      instructions:
      - text: Replace version history action {id} with name {name} on version {versionHistoryId}.
        slots:
          id: path.id
          name: requestBody.name
          versionHistoryId: requestBody.versionHistoryId
      - text: Overwrite version history action record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VersionHistoryActions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a version history action
      effect: destructive
      questions:
      - Can I delete one version history action by id?
      - Does removing a single version history action support If-Match?
      instructions:
      - text: Delete version history action {id}.
        slots:
          id: path.id
      - text: Delete version action {id} only if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VersionHistoryActions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a version history action
      effect: write
      questions:
      - How do I rename an existing version history action?
      - Can I patch just the name of a version history action?
      instructions:
      - text: Rename version history action {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Patch version action {id} to belong to version history {versionHistoryId}.
        slots:
          id: path.id
          versionHistoryId: requestBody.versionHistoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/VersionHistoryActions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank version history action template
      effect: read
      questions:
      - What default values does a new version history action start with?
      - Is there an empty version history action template?
      instructions:
      - text: Get the default version history action template.
      - text: Show starting values for a new version history action.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/versionhistoryactions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete version history actions
      effect: destructive
      questions:
      - Can I delete many version history actions at once?
      - Is there a bulk delete that takes a list of version action ids?
      instructions:
      - text: Bulk delete version history actions {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these version actions in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/versionhistoryactions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a version history action
      effect: read
      questions:
      - How can I read a custom property on a version history action?
      - Can extra metadata on a version action be fetched by property id?
      instructions:
      - text: Get custom property {custompropertyKey} on version history action {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Read version action {key}'s custom field {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'