# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for BOF Config Consumer Management API
  version: 1.0.0
extends: openapi/mediamath-consumer-management-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 13
- target: $.paths['/consumers'].get
  update:
    x-apievangelist-phrasing:
      intent: List my opportunity firehose consumers
      effect: read
      questions:
      - Which opportunity firehose consumers do I have access to?
      - How can I find the names of my bid opportunity feed consumers?
      instructions:
      - text: List the firehose consumers I can access.
      - text: Show the names of all my opportunity firehose consumers.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/consumers/{name}/filters/{filter}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one filter type's values for a consumer
      effect: read
      questions:
      - What values are set for a single filter type, like channel type, on my consumer?
      - Can I check which channel types a consumer is currently filtering on?
      instructions:
      - text: Show the {filter} filter values on consumer {name}.
        slots:
          filter: path.filter
          name: path.name
      - text: Get the channel type filter values for consumer {name} under filter {filter}.
        slots:
          name: path.name
          filter: path.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/consumers/{name}/filters/{filter}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update one filter type's values for a consumer
      effect: write
      questions:
      - How do I change the values of one specific filter type on my firehose consumer?
      - Do I need permission before adding values to a consumer filter?
      instructions:
      - text: Update the {filter} filter values on consumer {name}.
        slots:
          filter: path.filter
          name: path.name
      - text: Set new channel type values for filter {filter} on consumer {name}.
        slots:
          filter: path.filter
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: See which filters I can change myself
      effect: read
      questions:
      - Which firehose filters and parameters am I allowed to update without contacting MediaMath?
      - What permissions do I have for editing consumer filters?
      instructions:
      - text: Show the filters and parameters I have permission to update.
      - text: List my firehose filter permissions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/consumers/{name}/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List all active filters on a consumer
      effect: read
      questions:
      - What filters are currently applied to my firehose consumer?
      - Can I see every active filter for one consumer at once?
      instructions:
      - text: List all active filters on consumer {name}.
        slots:
          name: path.name
      - text: Show every filter currently configured for firehose consumer {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/consumers/{name}/samplesettings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a consumer's sample rate and enabled status
      effect: read
      questions:
      - Is my firehose consumer enabled, and what sample rate is it using?
      - How can I check the current sample rate on a consumer?
      instructions:
      - text: Show the sample settings for consumer {name}.
        slots:
          name: path.name
      - text: Check whether consumer {name} is disabled and what its sample rate is.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/consumers/{name}/samplesettings'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a consumer's sample rate or disable it
      effect: write
      questions:
      - How do I lower the sample rate on my opportunity firehose consumer?
      - Can I temporarily disable a consumer without deleting it?
      instructions:
      - text: Set the sample rate on consumer {name}.
        slots:
          name: path.name
      - text: Disable firehose consumer {name} via its sample settings.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/consumers/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a consumer's full configuration
      effect: read
      questions:
      - How do I see the complete configuration of a firehose consumer?
      - Can I export a consumer's whole config so I can edit it?
      instructions:
      - text: Get the full configuration of consumer {name}.
        slots:
          name: path.name
      - text: Show consumer {name}'s complete config including its filters.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/consumers/{name}'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace a consumer's entire configuration
      effect: write
      questions:
      - Can I edit a consumer's whole config in one request instead of piece by piece?
      - How do I post back a modified consumer configuration?
      instructions:
      - text: Replace the entire configuration of consumer {name} with my edited version.
        slots:
          name: path.name
      - text: Post the full updated config back to consumer {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/consumers/{name}/websettings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a consumer's web settings
      effect: read
      questions:
      - What web delivery settings does my firehose consumer have?
      - How can I check a consumer's web settings?
      instructions:
      - text: Show the web settings for consumer {name}.
        slots:
          name: path.name
      - text: Get consumer {name}'s current web settings.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/consumers/{name}/websettings'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a consumer's web settings
      effect: write
      questions:
      - How do I change the web settings for my firehose consumer?
      - Can I update where a consumer delivers over the web?
      instructions:
      - text: Update the web settings for consumer {name}.
        slots:
          name: path.name
      - text: Set new web settings on firehose consumer {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/consumers/{name}/awssettings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a consumer's AWS settings
      effect: read
      questions:
      - Which AWS settings, like role ARN, are configured on my consumer?
      - How can I view the AWS delivery config for a firehose consumer?
      instructions:
      - text: Show the AWS settings for consumer {name}.
        slots:
          name: path.name
      - text: Get consumer {name}'s AWS delivery configuration.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/consumers/{name}/awssettings'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a consumer's AWS settings
      effect: write
      questions:
      - How do I change the AWS settings on my firehose consumer?
      - Can I change the RoleARN or ExternalID on a consumer's AWS settings?
      instructions:
      - text: Update the AWS settings for consumer {name}.
        slots:
          name: path.name
      - text: Set new AWS delivery settings on consumer {name}, keeping the role ARN as is.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'