# 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 State Contexts API
  version: 1.0.0
extends: openapi/optimizely-page-state-contexts-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/PageStateContexts'].get
  update:
    x-apievangelist-phrasing:
      intent: List page state contexts
      effect: read
      questions:
      - How can I see every language, persona and device context for my page states?
      - Can I filter page state contexts to those waiting for approval?
      instructions:
      - text: List all page state contexts.
      - text: Show page state contexts matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PageStateContexts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a page state context
      effect: write
      questions:
      - How do I add a language or persona context to a page state?
      - Can I schedule a new page state context to publish on a certain date?
      instructions:
      - text: Create a context for page state {pageStateId} in language {languageId}.
        slots:
          pageStateId: requestBody.pageStateId
          languageId: requestBody.languageId
      - text: Add a page state context for {pageStateId} and persona {personaId} publishing on {publishOn}.
        slots:
          pageStateId: requestBody.pageStateId
          personaId: requestBody.personaId
          publishOn: requestBody.publishOn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PageStateContexts({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one page state context
      effect: read
      questions:
      - How do I look up a single page state context by id?
      - What publishing and rollback dates does one page state context hold?
      instructions:
      - text: Fetch page state context {id}.
        slots:
          id: path.id
      - text: Show the details of page state context {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PageStateContexts({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a page state context
      effect: write
      questions:
      - Can I overwrite a whole page state context record?
      - Does a full replace of a page state context clear fields I omit?
      instructions:
      - text: Replace page state context {id} with device type {deviceType}.
        slots:
          id: path.id
          deviceType: requestBody.deviceType
      - text: Overwrite the full page state context {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PageStateContexts({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single page state context
      effect: destructive
      questions:
      - How do I delete one page state context?
      - Can I guard a page state context delete with an ETag?
      instructions:
      - text: Delete page state context {id}.
        slots:
          id: path.id
      - text: Delete page state context {id} only if the ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PageStateContexts({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Set rollback or approval on a page state context
      effect: write
      questions:
      - Can I schedule a rollback date on an existing page state context?
      - Is there a way to mark a page state context as waiting for approval?
      instructions:
      - text: Schedule page state context {id} to roll back on {rollbackOn}.
        slots:
          id: path.id
          rollbackOn: requestBody.rollbackOn
      - text: Set waiting-for-approval on page state context {id} to {isWaitingForApproval}.
        slots:
          id: path.id
          isWaitingForApproval: requestBody.isWaitingForApproval
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PageStateContexts/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new page state context
      effect: read
      questions:
      - What defaults does a new page state context start with?
      - Is there a blank page state context template?
      instructions:
      - text: Get the default values for a new page state context.
      - text: Show the empty page state context record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/pagestatecontexts/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several page state contexts at once
      effect: destructive
      questions:
      - How do I bulk delete page state contexts?
      - Can I remove multiple page state contexts by id at once?
      instructions:
      - text: Bulk delete page state contexts {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every page state context in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/pagestatecontexts({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a page state context
      effect: read
      questions:
      - How do I read a custom property on a page state context?
      - Can I fetch one custom field from a page state context?
      instructions:
      - text: Get custom property {custompropertyKey} of page state context {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on page state context {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'