# 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 Content Page States API
  version: 1.0.0
extends: openapi/optimizely-content-page-states-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/ContentPageStates'].get
  update:
    x-apievangelist-phrasing:
      intent: List content page states
      effect: read
      questions:
      - How can I see all the saved page states in the CMS?
      - Can I filter content page states by language or persona?
      instructions:
      - text: List all content page states.
      - text: Show content page states matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ContentPageStates'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a content page state
      effect: write
      questions:
      - What is required to create a new content page state?
      - Can I create a page variant for a specific persona or device type?
      instructions:
      - text: Create page state {name} with variant {variantName} at path {path}.
        slots:
          name: requestBody.name
          variantName: requestBody.variantName
          path: requestBody.path
      - text: Add a {deviceType} page state {name} at {path} for variant {variantName}.
        slots:
          deviceType: requestBody.deviceType
          name: requestBody.name
          path: requestBody.path
          variantName: requestBody.variantName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ContentPageStates({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one content page state
      effect: read
      questions:
      - How do I open a single content page state by id?
      - What publishing info is stored on one page state?
      instructions:
      - text: Fetch content page state {id}.
        slots:
          id: path.id
      - text: Show the details of page state {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ContentPageStates({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a content page state
      effect: write
      questions:
      - Can I overwrite a whole content page state record?
      - Does replacing a page state require its name, variant and path again?
      instructions:
      - text: Replace page state {id} with name {name}, variant {variantName} and path {path}.
        slots:
          id: path.id
          name: requestBody.name
          variantName: requestBody.variantName
          path: requestBody.path
      - text: Overwrite the full content page state {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ContentPageStates({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single content page state
      effect: destructive
      questions:
      - How do I delete one content page state?
      - Can I make a page state delete conditional on its ETag?
      instructions:
      - text: Delete content page state {id}.
        slots:
          id: path.id
      - text: Delete page state {id} if the ETag is still {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ContentPageStates({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Schedule or edit part of a content page state
      effect: write
      questions:
      - Can I schedule an existing page state to publish later?
      - Is there a way to unpublish a page state without deleting it?
      instructions:
      - text: Schedule page state {id} to publish on {futurePublishOn}.
        slots:
          id: path.id
          futurePublishOn: requestBody.futurePublishOn
      - text: Set the unpublished flag on page state {id} to {isUnpublished}.
        slots:
          id: path.id
          isUnpublished: requestBody.isUnpublished
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ContentPageStates/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new page state
      effect: read
      questions:
      - What defaults does a new content page state start with?
      - Is there a blank page state record I can use as a template?
      instructions:
      - text: Get the default values for a new content page state.
      - text: Show the empty content page state record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/contentpagestates/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several content page states at once
      effect: destructive
      questions:
      - How do I bulk delete content page states?
      - Can I remove a list of page states by id in one request?
      instructions:
      - text: Bulk delete content page states {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every page state in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/contentpagestates({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a content page state
      effect: read
      questions:
      - How do I read a custom property on a content page state?
      - Can I fetch one custom field from a page state?
      instructions:
      - text: Get custom property {custompropertyKey} of page state {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on content page state {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'