Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Dealer Categories API

10 actions 10 updates phrasing extends openapi/optimizely-dealer-categories-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/DealerCategories'].get
$.paths['/api/v1/admin/DealerCategories'].post
$.paths['/api/v1/admin/DealerCategories({id})'].get
$.paths['/api/v1/admin/DealerCategories({id})'].put
$.paths['/api/v1/admin/DealerCategories({id})'].delete
$.paths['/api/v1/admin/DealerCategories({id})'].patch
$.paths['/api/v1/admin/DealerCategories/Default.Default()'].get
$.paths['/api/v1/admin/dealercategories/delete'].delete
$.paths['/api/v1/admin/dealercategories({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 Dealer Categories API
  version: 1.0.0
extends: openapi/optimizely-dealer-categories-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/DealerCategories'].get
  update:
    x-apievangelist-phrasing:
      intent: List dealer category assignments
      effect: read
      questions:
      - Which product categories does each dealer carry?
      - Can I filter dealer categories to a single dealer?
      instructions:
      - text: List all dealer category assignments.
      - text: Show dealer categories matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/DealerCategories'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a category to a dealer
      effect: write
      questions:
      - How do I tell the dealer locator that a dealer sells a category?
      - Can I link a product category to a dealer?
      instructions:
      - text: Assign category {categoryId} to dealer {dealerId}.
        slots:
          categoryId: requestBody.categoryId
          dealerId: requestBody.dealerId
      - text: Create a dealer category record for dealer {dealerId} and category {categoryId}.
        slots:
          categoryId: requestBody.categoryId
          dealerId: requestBody.dealerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/DealerCategories({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a dealer category assignment
      effect: read
      questions:
      - Which dealer and category does a given assignment connect?
      - Can I look up one dealer category record by ID?
      instructions:
      - text: Get dealer category {id}.
        slots:
          id: path.id
      - text: Show the dealer and category for assignment {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/DealerCategories({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a dealer category assignment
      effect: write
      questions:
      - How do I overwrite a dealer category record completely?
      - Can I fully replace the dealer and category on an assignment?
      instructions:
      - text: Replace dealer category {id} with dealer {dealerId} and category {categoryId}.
        slots:
          id: path.id
          dealerId: requestBody.dealerId
          categoryId: requestBody.categoryId
      - text: Overwrite all fields of dealer category record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/DealerCategories({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a category from a dealer
      effect: destructive
      questions:
      - How do I stop listing a category for a dealer?
      - Does deleting a dealer category support an If-Match header?
      instructions:
      - text: Delete dealer category {id}.
        slots:
          id: path.id
      - text: Remove dealer category {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/DealerCategories({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the category on a dealer assignment
      effect: write
      questions:
      - How do I switch an existing dealer assignment to another category?
      - Can I move a dealer category record to a different dealer?
      instructions:
      - text: Change the category on dealer assignment {id} to {categoryId}.
        slots:
          id: path.id
          categoryId: requestBody.categoryId
      - text: Move existing dealer category {id} to dealer {dealerId}.
        slots:
          id: path.id
          dealerId: requestBody.dealerId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/DealerCategories/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get defaults for a new dealer category
      effect: read
      questions:
      - What defaults does a new dealer category record start with?
      - Is there a blank dealer category template?
      instructions:
      - text: Get the default field values for a new dealer category.
      - text: Show a blank dealer category record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/dealercategories/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several dealer category assignments
      effect: destructive
      questions:
      - How do I bulk remove dealer category records?
      - Can I delete many dealer categories in one request?
      instructions:
      - text: Bulk delete dealer categories {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every dealer category in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/dealercategories({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a dealer category
      effect: read
      questions:
      - How do I read a custom property on a dealer category?
      - Can I fetch one custom field value from a dealer category record?
      instructions:
      - text: Get custom property {custompropertyKey} of dealer category {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show the {custompropertyKey} custom property on dealer category {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'