Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Order Line Requisitions API

10 actions 10 updates phrasing extends openapi/optimizely-order-line-requisitions-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/OrderLineRequisitions'].get
$.paths['/api/v1/admin/OrderLineRequisitions'].post
$.paths['/api/v1/admin/OrderLineRequisitions({id})'].get
$.paths['/api/v1/admin/OrderLineRequisitions({id})'].put
$.paths['/api/v1/admin/OrderLineRequisitions({id})'].delete
$.paths['/api/v1/admin/OrderLineRequisitions({id})'].patch
$.paths['/api/v1/admin/OrderLineRequisitions/Default.Default()'].get
$.paths['/api/v1/admin/orderlinerequisitions/delete'].delete
$.paths['/api/v1/admin/orderlinerequisitions({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 Order Line Requisitions API
  version: 1.0.0
extends: openapi/optimizely-order-line-requisitions-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/OrderLineRequisitions'].get
  update:
    x-apievangelist-phrasing:
      intent: List order line requisitions
      effect: read
      questions:
      - Which requisitions have buyers raised against order lines?
      - Can I filter order line requisitions by cost code or user?
      - How many requisition records are pending across all orders?
      instructions:
      - text: List all order line requisitions.
      - text: Find order line requisitions matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} requisitions sorted by {orderby}.
        slots:
          top: query.$top
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLineRequisitions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an order line requisition
      effect: write
      questions:
      - How do I record a requisition for a quantity on an order line?
      - Is a cost code required when I create an order line requisition?
      instructions:
      - text: Create a requisition for {qtyOrdered} units on order line {orderLineId} with cost code {costCode}.
        slots:
          qtyOrdered: requestBody.qtyOrdered
          orderLineId: requestBody.orderLineId
          costCode: requestBody.costCode
      - text: Add a requisition by user {userProfileId} under cost code {costCode}.
        slots:
          userProfileId: requestBody.userProfileId
          costCode: requestBody.costCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLineRequisitions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order line requisition
      effect: read
      questions:
      - Who requested a given requisition and for what quantity?
      - Which order line is a specific requisition attached to?
      instructions:
      - text: Get order line requisition {id}.
        slots:
          id: path.id
      - text: Show the quantity and cost code on requisition {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLineRequisitions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an order line requisition
      effect: write
      questions:
      - How do I overwrite an order line requisition in full?
      - Does replacing a requisition wipe its original order line if omitted?
      instructions:
      - text: Replace requisition {id} with cost code {costCode} and quantity {qtyOrdered}.
        slots:
          id: path.id
          costCode: requestBody.costCode
          qtyOrdered: requestBody.qtyOrdered
      - text: Overwrite order line requisition {id} entirely, linking order line {orderLineId}.
        slots:
          id: path.id
          orderLineId: requestBody.orderLineId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLineRequisitions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an order line requisition
      effect: destructive
      questions:
      - How do I cancel out a requisition record by deleting it?
      - Can deleting a requisition require a matching ETag?
      instructions:
      - text: Delete order line requisition {id}.
        slots:
          id: path.id
      - text: Delete requisition {id} only if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLineRequisitions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an order line requisition
      effect: write
      questions:
      - Can I change just the quantity on an existing requisition?
      - How do I correct the cost code charged on a requisition?
      instructions:
      - text: Change the quantity on requisition {id} to {qtyOrdered}.
        slots:
          id: path.id
          qtyOrdered: requestBody.qtyOrdered
      - text: Update the cost code on order line requisition {id} to {costCode}.
        slots:
          id: path.id
          costCode: requestBody.costCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLineRequisitions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank requisition template
      effect: read
      questions:
      - What default values does a new order line requisition start with?
      - Is there an empty requisition template to fetch first?
      instructions:
      - text: Fetch the default order line requisition template.
      - text: Show default field values for a new requisition.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/orderlinerequisitions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete order line requisitions
      effect: destructive
      questions:
      - How do I delete many requisitions at once?
      - Can I purge a batch of order line requisitions by ID?
      instructions:
      - text: Bulk delete order line requisitions {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these requisitions in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/orderlinerequisitions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a requisition
      effect: read
      questions:
      - What value is stored in a custom property on an order line requisition?
      - Can I read one custom property of a requisition record?
      instructions:
      - text: Get custom property {custompropertyKey} on requisition {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show order line requisition {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'