# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Edge Impulse Whitelabels API
  version: 1.0.0
extends: openapi/edge-impulse-white-labels-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: 8
- target: $.paths['/api/whitelabels'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered white labels
      effect: read
      questions:
      - Which white-label instances are registered on Edge Impulse?
      - Can I see every white label set up across the platform?
      instructions:
      - text: List all registered white labels.
      - text: Show me every white-label deployment and its details.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/whitelabels'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new white label
      effect: write
      questions:
      - How do I set up a new white-label instance on its own domain?
      - Can a new white label disable signups or password authentication?
      - What does a white label need when it is first created?
      instructions:
      - text: Create a white label named {name} on domain {domain} owned by organization {ownerOrganizationId}.
        slots:
          name: requestBody.name
          domain: requestBody.domain
          ownerOrganizationId: requestBody.ownerOrganizationId
      - text: Set up white label {name} at {domain} for organization {ownerOrganizationId} with signups set to {allowSignup}.
        slots:
          name: requestBody.name
          domain: requestBody.domain
          ownerOrganizationId: requestBody.ownerOrganizationId
          allowSignup: requestBody.allowSignup
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/whitelabel/{whitelabelIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a white label's full details
      effect: read
      questions:
      - What settings does a specific white label have?
      - Where can I see all the configuration for one white label?
      instructions:
      - text: Show all information about white label {whitelabelIdentifier}.
        slots:
          whitelabelIdentifier: path.whitelabelIdentifier
      - text: Get the configuration of white label {whitelabelIdentifier}.
        slots:
          whitelabelIdentifier: path.whitelabelIdentifier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/whitelabel/{whitelabelIdentifier}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a white label's organization limit
      effect: write
      questions:
      - How do I raise the number of organizations a white label can have?
      - Can I change the organizations limit on an existing white label?
      instructions:
      - text: Set the organizations limit of white label {whitelabelIdentifier} to {organizationsLimit}.
        slots:
          whitelabelIdentifier: path.whitelabelIdentifier
          organizationsLimit: requestBody.organizationsLimit
      - text: Update white label {whitelabelIdentifier} so it allows {organizationsLimit} organizations.
        slots:
          whitelabelIdentifier: path.whitelabelIdentifier
          organizationsLimit: requestBody.organizationsLimit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/whitelabel/{whitelabelIdentifier}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a white label
      effect: destructive
      questions:
      - How do I remove a white label I no longer need?
      - Can a white label be deleted by its id?
      instructions:
      - text: Delete white label {whitelabelIdentifier}.
        slots:
          whitelabelIdentifier: path.whitelabelIdentifier
      - text: Permanently remove the white label with id {whitelabelIdentifier}.
        slots:
          whitelabelIdentifier: path.whitelabelIdentifier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/whitelabel/{whitelabelIdentifier}/domain'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the domain of a white label
      effect: read
      questions:
      - What domain is a particular white label served on?
      - Which hostname belongs to a white label id?
      instructions:
      - text: Get the domain for white label {whitelabelIdentifier}.
        slots:
          whitelabelIdentifier: path.whitelabelIdentifier
      - text: Tell me which domain white label {whitelabelIdentifier} uses.
        slots:
          whitelabelIdentifier: path.whitelabelIdentifier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/whitelabel/{whitelabelIdentifier}/deploymentTargets'].post
  update:
    x-apievangelist-phrasing:
      intent: Choose deployment targets for a white label
      effect: write
      questions:
      - How do I limit which deployment targets users of a white label can build for?
      - Can I enable only some deployment targets on a white label?
      instructions:
      - text: Enable deployment targets {targets} on white label {whitelabelIdentifier}.
        slots:
          targets: requestBody.targets
          whitelabelIdentifier: path.whitelabelIdentifier
      - text: Update the enabled deployment targets for white label {whitelabelIdentifier}.
        slots:
          whitelabelIdentifier: path.whitelabelIdentifier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/whitelabel/{whitelabelIdentifier}/impulse/blocks'].get
  update:
    x-apievangelist-phrasing:
      intent: List DSP and ML blocks for a white label
      effect: read
      questions:
      - Which processing and learning blocks are available on a white label?
      - What DSP blocks can users of a white label add to an impulse?
      instructions:
      - text: List all DSP and ML impulse blocks available on white label {whitelabelIdentifier}.
        slots:
          whitelabelIdentifier: path.whitelabelIdentifier
      - text: Show the impulse blocks white label {whitelabelIdentifier} offers.
        slots:
          whitelabelIdentifier: path.whitelabelIdentifier
      method: generated
      generated: '2026-10-01'