Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Page Temporaries API

10 actions 10 updates phrasing extends openapi/optimizely-page-temporaries-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 10

$.info
$.paths['/api/v1/admin/PageTemporaries'].get
$.paths['/api/v1/admin/PageTemporaries'].post
$.paths['/api/v1/admin/PageTemporaries({id})'].get
$.paths['/api/v1/admin/PageTemporaries({id})'].put
$.paths['/api/v1/admin/PageTemporaries({id})'].delete
$.paths['/api/v1/admin/PageTemporaries({id})'].patch
$.paths['/api/v1/admin/PageTemporaries/Default.Default()'].get
$.paths['/api/v1/admin/pagetemporaries/delete'].delete
$.paths['/api/v1/admin/pagetemporaries({key})/customproperties({custompropertyKey})'].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 Admin API V1 Page Temporaries API
  version: 1.0.0
extends: openapi/optimizely-page-temporaries-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/PageTemporaries'].get
  update:
    x-apievangelist-phrasing:
      intent: List temporary page records
      effect: read
      questions:
      - How do I list the temporary page records stored in the commerce admin?
      - Can I filter page temporaries by when they were created?
      - How many temporary page records exist right now?
      instructions:
      - text: List all temporary page records.
      - text: Find page temporaries matching {filter}.
        slots:
          filter: query.$filter
      - text: Count the page temporaries that match {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PageTemporaries'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a temporary page record
      effect: write
      questions:
      - How do I store a new temporary page value?
      - What does a page temporary record hold besides its value?
      instructions:
      - text: Create a page temporary with value {value}.
        slots:
          value: requestBody.value
      - text: Store the temporary page value {value}.
        slots:
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PageTemporaries({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a temporary page record
      effect: read
      questions:
      - How do I read one temporary page record by ID?
      - What value is saved in a specific page temporary?
      instructions:
      - text: Get page temporary {id}.
        slots:
          id: path.id
      - text: Show the stored value of page temporary {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PageTemporaries({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a temporary page record
      effect: write
      questions:
      - How do I overwrite a temporary page record completely?
      - Does replacing a page temporary reset its other fields?
      instructions:
      - text: Replace page temporary {id} with value {value}.
        slots:
          id: path.id
          value: requestBody.value
      - text: Overwrite every field of page temporary {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PageTemporaries({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a temporary page record
      effect: destructive
      questions:
      - How do I delete one temporary page record?
      - Can I make a page temporary delete conditional on its ETag?
      instructions:
      - text: Delete page temporary {id}.
        slots:
          id: path.id
      - text: Delete page temporary {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/PageTemporaries({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a temporary page record
      effect: write
      questions:
      - How do I change only the value of a page temporary?
      - Can I partially update a temporary page record?
      instructions:
      - text: Set the value of page temporary {id} to {value}.
        slots:
          id: path.id
          value: requestBody.value
      - text: Patch page temporary {id} with new value {value}.
        slots:
          id: path.id
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PageTemporaries/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a default page temporary template
      effect: read
      questions:
      - What default values does a new page temporary start with?
      - Can I fetch a blank page temporary template?
      instructions:
      - text: Fetch the default page temporary template.
      - text: Show me the defaults for a new page temporary.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/pagetemporaries/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete temporary page records
      effect: destructive
      questions:
      - How do I clear out several temporary page records at once?
      - Can I remove page temporaries by a list of IDs?
      instructions:
      - text: Bulk delete page temporaries {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these page temporaries in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/pagetemporaries({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a page temporary
      effect: read
      questions:
      - How do I read a custom property stored on a page temporary?
      - Can I fetch one extra property from a temporary page record?
      instructions:
      - text: Get custom property {custompropertyKey} on page temporary {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show page temporary {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'