Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Punch Out Order Request Extrinsics API

10 actions 10 updates phrasing extends openapi/optimizely-punch-out-order-request-extrinsics-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/PunchOutOrderRequestExtrinsics'].get
$.paths['/api/v1/admin/PunchOutOrderRequestExtrinsics'].post
$.paths['/api/v1/admin/PunchOutOrderRequestExtrinsics({id})'].get
$.paths['/api/v1/admin/PunchOutOrderRequestExtrinsics({id})'].put
$.paths['/api/v1/admin/PunchOutOrderRequestExtrinsics({id})'].delete
$.paths['/api/v1/admin/PunchOutOrderRequestExtrinsics({id})'].patch
$.paths['/api/v1/admin/PunchOutOrderRequestExtrinsics/Default.Default()'].get
$.paths['/api/v1/admin/punchoutorderrequestextrinsics/delete'].delete
$.paths['/api/v1/admin/punchoutorderrequestextrinsics({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 Punch Out Order Request Extrinsics API
  version: 1.0.0
extends: openapi/optimizely-punch-out-order-request-extrinsics-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/PunchOutOrderRequestExtrinsics'].get
  update:
    x-apievangelist-phrasing:
      intent: List punchout order request extrinsics
      effect: read
      questions:
      - Which extrinsic name-value pairs came in on punchout order requests?
      - Can I filter punchout extrinsics to one order request?
      instructions:
      - text: List all punchout order request extrinsics.
      - text: Show punchout extrinsics matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutOrderRequestExtrinsics'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an extrinsic to a punchout order request
      effect: write
      questions:
      - How do I store a cXML extrinsic on a punchout order request?
      - What fields does a new punchout extrinsic need?
      instructions:
      - text: Add extrinsic {name} with value {value} to punchout order request {punchOutOrderRequestId}.
        slots:
          name: requestBody.name
          value: requestBody.value
          punchOutOrderRequestId: requestBody.punchOutOrderRequestId
      - text: Create punchout extrinsic {name} = {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutOrderRequestExtrinsics({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a punchout order request extrinsic
      effect: read
      questions:
      - What value does a specific punchout extrinsic hold?
      - Can I look up one punchout extrinsic by ID?
      instructions:
      - text: Get punchout extrinsic {id}.
        slots:
          id: path.id
      - text: Show the name and value of punchout extrinsic {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutOrderRequestExtrinsics({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a punchout extrinsic
      effect: write
      questions:
      - How do I overwrite a punchout extrinsic record completely?
      - Can I fully replace an extrinsic's name and value?
      instructions:
      - text: Replace punchout extrinsic {id} with {name} = {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
          id: path.id
      - text: Overwrite all fields of punchout extrinsic {id} using name {name} and value {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutOrderRequestExtrinsics({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a punchout extrinsic
      effect: destructive
      questions:
      - How do I delete one extrinsic from a punchout order request?
      - Does deleting a punchout extrinsic support If-Match?
      instructions:
      - text: Delete punchout extrinsic {id}.
        slots:
          id: path.id
      - text: Remove punchout extrinsic {id} if its ETag is {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutOrderRequestExtrinsics({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a punchout extrinsic's value
      effect: write
      questions:
      - How do I change just the value of an existing punchout extrinsic?
      - Can I correct an extrinsic on a punchout order request after it arrived?
      instructions:
      - text: Set existing punchout extrinsic {id} ({name}) to value {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
          id: path.id
      - text: 'Patch punchout extrinsic {id}: name {name}, value {value}.'
        slots:
          name: requestBody.name
          value: requestBody.value
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutOrderRequestExtrinsics/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get defaults for a new punchout extrinsic
      effect: read
      questions:
      - What defaults does a new punchout extrinsic start with?
      - Is there a blank punchout extrinsic template?
      instructions:
      - text: Get the default field values for a new punchout extrinsic.
      - text: Show a blank punchout extrinsic record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/punchoutorderrequestextrinsics/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several punchout extrinsics
      effect: destructive
      questions:
      - How do I bulk delete punchout order request extrinsics?
      - Can I remove many punchout extrinsics in one request?
      instructions:
      - text: Bulk delete punchout extrinsics {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every punchout extrinsic in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/punchoutorderrequestextrinsics({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a punchout extrinsic
      effect: read
      questions:
      - How do I read a custom property on a punchout extrinsic?
      - Can I fetch one custom field value from a punchout extrinsic record?
      instructions:
      - text: Get custom property {custompropertyKey} of punchout extrinsic {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on punchout extrinsic {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'