Dolby · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OptiView Ads Organizations API

7 actions 7 updates phrasing extends openapi/dolby-organizations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Dolby's API. It is a proposal applied on top of the contract, not a document Dolby publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/api/v1/organizations/integrations'].get
$.paths['/api/v1/organizations/integrations'].post
$.paths['/api/v1/organizations/integrations/{organizationIntegrationId}'].get
$.paths['/api/v1/organizations/integrations/{organizationIntegrationId}'].delete
$.paths['/api/v1/organizations/integrations/{organizationIntegrationId}'].patch
$.paths['/api/v1/organizations/integrations/{organizationIntegrationId}/verify'].post

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 OptiView Ads Organizations API
  version: 1.0.0
extends: openapi/dolby-organizations-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: 6
- target: $.paths['/api/v1/organizations/integrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization ad integrations
      effect: read
      questions:
      - Which ad-system integrations are configured for my whole organization?
      - Can I filter my organization integrations by type?
      instructions:
      - text: List my organization's ad integrations.
      - text: Show organization integrations matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/organizations/integrations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization ad integration
      effect: write
      questions:
      - How do I connect my Google Ad Manager network to OptiView Ads?
      - Can I upload service account credentials when setting up the organization integration?
      - What EABN look-forward and decisioning margins can I configure?
      instructions:
      - text: Create a {type} organization integration with network code {networkCode}.
        slots:
          type: requestBody.type
          networkCode: requestBody.networkCode
      - text: Set up a {type} integration for network {networkCode} with a look-forward time of {eabnLookForwardTimeMs} ms.
        slots:
          type: requestBody.type
          networkCode: requestBody.networkCode
          eabnLookForwardTimeMs: requestBody.eabnLookForwardTimeMs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/organizations/integrations/{organizationIntegrationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one organization integration
      effect: read
      questions:
      - What network code is stored on a particular organization integration?
      - Can I view the EABN timing settings of one integration?
      instructions:
      - text: Show organization integration {organizationIntegrationId}.
        slots:
          organizationIntegrationId: path.organizationIntegrationId
      - text: Get the network code and margins of integration {organizationIntegrationId}.
        slots:
          organizationIntegrationId: path.organizationIntegrationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/organizations/integrations/{organizationIntegrationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization integration
      effect: destructive
      questions:
      - How do I disconnect my organization from its ad server integration?
      - Can I remove an organization-wide integration I set up by mistake?
      instructions:
      - text: Delete organization integration {organizationIntegrationId}.
        slots:
          organizationIntegrationId: path.organizationIntegrationId
      - text: Remove the org-level ad integration {organizationIntegrationId}.
        slots:
          organizationIntegrationId: path.organizationIntegrationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/organizations/integrations/{organizationIntegrationId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an organization integration
      effect: write
      questions:
      - Can I rotate the service account credentials on an existing integration?
      - Is it possible to change an integration's type after creating it?
      instructions:
      - text: Change the network code of integration {organizationIntegrationId} to {networkCode}.
        slots:
          organizationIntegrationId: path.organizationIntegrationId
          networkCode: requestBody.networkCode
      - text: Set the EABN decisioning margin on integration {organizationIntegrationId} to {eabnDecisioningMarginMs} ms.
        slots:
          organizationIntegrationId: path.organizationIntegrationId
          eabnDecisioningMarginMs: requestBody.eabnDecisioningMarginMs
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/organizations/integrations/{organizationIntegrationId}/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify integration credentials
      effect: read
      questions:
      - How can I check that my stored service account credentials actually work?
      - What does it mean when credential verification returns a 422?
      instructions:
      - text: Verify the credentials of organization integration {organizationIntegrationId}.
        slots:
          organizationIntegrationId: path.organizationIntegrationId
      - text: Test whether integration {organizationIntegrationId} can authenticate with the ad system.
        slots:
          organizationIntegrationId: path.organizationIntegrationId
      method: generated
      generated: '2026-10-01'