Optimizely · OpenAPI Overlay 1.0.0

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

10 actions 10 updates phrasing extends openapi/optimizely-punch-out-order-request-item-out-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/PunchOutOrderRequestItemOutExtrinsics'].get
$.paths['/api/v1/admin/PunchOutOrderRequestItemOutExtrinsics'].post
$.paths['/api/v1/admin/PunchOutOrderRequestItemOutExtrinsics({id})'].get
$.paths['/api/v1/admin/PunchOutOrderRequestItemOutExtrinsics({id})'].put
$.paths['/api/v1/admin/PunchOutOrderRequestItemOutExtrinsics({id})'].delete
$.paths['/api/v1/admin/PunchOutOrderRequestItemOutExtrinsics({id})'].patch
$.paths['/api/v1/admin/PunchOutOrderRequestItemOutExtrinsics/Default.Default()'].get
$.paths['/api/v1/admin/punchoutorderrequestitemoutextrinsics/delete'].delete
$.paths['/api/v1/admin/punchoutorderrequestitemoutextrinsics({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 Item Out Extrinsics API
  version: 1.0.0
extends: openapi/optimizely-punch-out-order-request-item-out-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/PunchOutOrderRequestItemOutExtrinsics'].get
  update:
    x-apievangelist-phrasing:
      intent: List punchout item extrinsics
      effect: read
      questions:
      - Which extrinsic name/value pairs are attached to outgoing punchout order request items?
      - Can I filter punchout item extrinsics by name?
      instructions:
      - text: List all punchout order request item extrinsics.
      - text: Find punchout item extrinsics matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutOrderRequestItemOutExtrinsics'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an extrinsic to a punchout item
      effect: write
      questions:
      - How do I attach an extra name/value field to an outgoing punchout item?
      - Can I add custom cXML extrinsic data to a punchout order request line?
      instructions:
      - text: Add extrinsic {name} = {value} to punchout item {itemId}.
        slots:
          name: requestBody.name
          value: requestBody.value
          itemId: requestBody.punchOutOrderRequestItemOutId
      - text: Create a punchout item extrinsic named {name} with value {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutOrderRequestItemOutExtrinsics({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a punchout item extrinsic
      effect: read
      questions:
      - Can I look up one punchout item extrinsic by ID?
      - What name and value does a particular extrinsic hold?
      instructions:
      - text: Show punchout item extrinsic {id}.
        slots:
          id: path.id
      - text: Get the name and value of extrinsic {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutOrderRequestItemOutExtrinsics({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a punchout item extrinsic
      effect: write
      questions:
      - How do I overwrite a punchout item extrinsic entirely?
      - Does replacing an extrinsic require both name and value?
      instructions:
      - text: Replace extrinsic {id} with name {name} and value {value}.
        slots:
          id: path.id
          name: requestBody.name
          value: requestBody.value
      - text: Overwrite punchout item extrinsic {id} in full.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutOrderRequestItemOutExtrinsics({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a punchout item extrinsic
      effect: destructive
      questions:
      - How do I remove one extrinsic from a punchout item?
      - Can an extrinsic delete require a matching ETag?
      instructions:
      - text: Delete punchout item extrinsic {id}.
        slots:
          id: path.id
      - text: Delete extrinsic {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/PunchOutOrderRequestItemOutExtrinsics({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a punchout item extrinsic value
      effect: write
      questions:
      - Can I change only the value of a punchout item extrinsic?
      - How do I rename an existing extrinsic field?
      instructions:
      - text: Set the value of extrinsic {id} to {value}.
        slots:
          id: path.id
          value: requestBody.value
      - text: Rename punchout item extrinsic {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/PunchOutOrderRequestItemOutExtrinsics/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get default values for a new punchout item extrinsic
      effect: read
      questions:
      - What defaults does a new punchout item extrinsic start with?
      - Is there a blank template for a punchout extrinsic?
      instructions:
      - text: Get the default punchout item extrinsic template.
      - text: Show prefilled defaults for a new punchout extrinsic.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/punchoutorderrequestitemoutextrinsics/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete punchout item extrinsics
      effect: destructive
      questions:
      - Can I delete many punchout item extrinsics at once?
      - How do I bulk clear extrinsics by ID?
      instructions:
      - text: Bulk delete punchout item extrinsics {ids}.
        slots:
          ids: query.ids
      - text: Remove the extrinsics with IDs {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/punchoutorderrequestitemoutextrinsics({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a punchout extrinsic
      effect: read
      questions:
      - Can I read a custom property on a punchout item extrinsic?
      - Where are extra fields for an extrinsic record kept?
      instructions:
      - text: Show custom property {property} on punchout extrinsic {key}.
        slots:
          property: path.custompropertyKey
          key: path.key
      - text: Get extrinsic {key}'s custom field {property}.
        slots:
          property: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'