Optimizely · OpenAPI Overlay 1.0.0

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

10 actions 10 updates phrasing extends openapi/optimizely-order-line-rfqs-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/OrderLineRfqs'].get
$.paths['/api/v1/admin/OrderLineRfqs'].post
$.paths['/api/v1/admin/OrderLineRfqs({id})'].get
$.paths['/api/v1/admin/OrderLineRfqs({id})'].put
$.paths['/api/v1/admin/OrderLineRfqs({id})'].delete
$.paths['/api/v1/admin/OrderLineRfqs({id})'].patch
$.paths['/api/v1/admin/OrderLineRfqs/Default.Default()'].get
$.paths['/api/v1/admin/orderlinerfqs/delete'].delete
$.paths['/api/v1/admin/orderlinerfqs({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 Rfqs API
  version: 1.0.0
extends: openapi/optimizely-order-line-rfqs-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/OrderLineRfqs'].get
  update:
    x-apievangelist-phrasing:
      intent: List order line RFQ quotes
      effect: read
      questions:
      - Which order lines have RFQ quantity-break pricing on them?
      - Can I filter order line RFQs to one order line?
      - How many order line RFQ records exist?
      instructions:
      - text: List all order line RFQs.
      - text: List order line RFQs matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} order line RFQs sorted by {orderby}.
        slots:
          top: query.$top
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLineRfqs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create quantity-break pricing for an order line
      effect: write
      questions:
      - How do I quote tiered pricing on an order line for a request for quote?
      - Can an order line RFQ hold up to eleven quantity breaks with their amounts?
      instructions:
      - text: Create an RFQ for order line {orderLineId} with break quantity {breakQty01} at {amount01}.
        slots:
          orderLineId: requestBody.orderLineId
          breakQty01: requestBody.breakQty01
          amount01: requestBody.amount01
      - text: Quote order line {orderLineId} with a maximum quantity of {maxQty}.
        slots:
          orderLineId: requestBody.orderLineId
          maxQty: requestBody.maxQty
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLineRfqs({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order line RFQ
      effect: read
      questions:
      - What quantity breaks and prices were quoted on one order line RFQ?
      - Can I fetch a single order line RFQ by its ID?
      instructions:
      - text: Get order line RFQ {id}.
        slots:
          id: path.id
      - text: Show the quantity breaks of order line RFQ {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLineRfqs({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an order line RFQ
      effect: write
      questions:
      - How do I overwrite all the price breaks on an order line RFQ?
      - Does replacing an order line RFQ clear the breaks I leave out?
      instructions:
      - text: Replace order line RFQ {id} with a first break of {breakQty01} at {amount01}.
        slots:
          id: path.id
          breakQty01: requestBody.breakQty01
          amount01: requestBody.amount01
      - text: Overwrite every field of order line RFQ {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLineRfqs({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an order line RFQ
      effect: destructive
      questions:
      - Can I remove the RFQ pricing from one order line?
      - Is it possible to delete an order line RFQ only if the ETag matches?
      instructions:
      - text: Delete order line RFQ {id}.
        slots:
          id: path.id
      - text: Delete order line RFQ {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/OrderLineRfqs({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an order line RFQ
      effect: write
      questions:
      - How do I change just the second price break on an order line RFQ?
      - Can I raise the maximum quantity on an existing RFQ?
      instructions:
      - text: Set break quantity 2 of order line RFQ {id} to {breakQty02} at {amount02}.
        slots:
          id: path.id
          breakQty02: requestBody.breakQty02
          amount02: requestBody.amount02
      - text: Change the maximum quantity on order line RFQ {id} to {maxQty}.
        slots:
          id: path.id
          maxQty: requestBody.maxQty
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLineRfqs/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank order line RFQ template
      effect: read
      questions:
      - What default values does a new order line RFQ start with?
      - Can I fetch an empty order line RFQ template?
      instructions:
      - text: Fetch the default order line RFQ template.
      - text: Show the starting values for a new order line RFQ.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/orderlinerfqs/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete order line RFQs
      effect: destructive
      questions:
      - Can I delete several order line RFQs at once?
      - How do I remove a batch of RFQ pricing records by ID?
      instructions:
      - text: Bulk delete order line RFQs {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these order line RFQs together: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/orderlinerfqs({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an order line RFQ
      effect: read
      questions:
      - Can I read a custom property stored on an order line RFQ?
      - What extra custom values does an RFQ record carry?
      instructions:
      - text: Get custom property {custompropertyKey} on order line RFQ {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show RFQ {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'