Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Analytics Classification Classification Dataset API

6 actions 6 updates phrasing extends openapi/adobe-suite-classification-dataset-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/{globalCompanyId}/classification/datasets/{dataset_id}'].get

$.paths['/{globalCompanyId}/classification/datasets/{dataset_id}'].put

$.paths['/{globalCompanyId}/classification/datasets/{dataset_id}'].delete

$.paths['/{globalCompanyId}/classification/datasets/compatibilityMetrics/{rsid}'].get

$.paths['/{globalCompanyId}/classification/datasets/template/{dataset_id}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Analytics Classification Classification Dataset API
  version: 1.0.0
extends: openapi/adobe-suite-classification-dataset-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: 5
- target: $.paths['/{globalCompanyId}/classification/datasets/{dataset_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a classification dataset
      effect: read
      questions:
      - How do I look up one Analytics classification dataset and its columns?
      - Can I see who owns a classification dataset?
      instructions:
      - text: Show classification dataset {dataset_id} for company {globalCompanyId}.
        slots:
          dataset_id: path.dataset_id
          globalCompanyId: path.globalCompanyId
      - text: Get the columns of classification dataset {dataset_id} in {globalCompanyId}.
        slots:
          dataset_id: path.dataset_id
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/classification/datasets/{dataset_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a classification dataset
      effect: write
      questions:
      - Can I rename a classification dataset or change its columns?
      - How do I update notification settings on a classification dataset?
      instructions:
      - text: Rename classification dataset {dataset_id} in {globalCompanyId} to {name}.
        slots:
          dataset_id: path.dataset_id
          globalCompanyId: path.globalCompanyId
          name: requestBody.name
      - text: Update the columns of dataset {dataset_id} in company {globalCompanyId} to {columns}.
        slots:
          dataset_id: path.dataset_id
          globalCompanyId: path.globalCompanyId
          columns: requestBody.columns
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/classification/datasets/{dataset_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a classification dataset and its data
      effect: destructive
      questions:
      - How do I delete a classification dataset?
      - Does deleting a classification dataset also delete its classification data?
      instructions:
      - text: Delete classification dataset {dataset_id} in company {globalCompanyId}.
        slots:
          dataset_id: path.dataset_id
          globalCompanyId: path.globalCompanyId
      - text: Remove dataset {dataset_id} and all of its classification data from {globalCompanyId}.
        slots:
          dataset_id: path.dataset_id
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/classification/datasets/compatibilityMetrics/{rsid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get classification-compatible metrics for a report suite
      effect: read
      questions:
      - Which metrics in a report suite can be classified?
      - How do I find the classification dataset tied to a report suite's metrics?
      instructions:
      - text: Get compatibility metrics for report suite {rsid} in {globalCompanyId}.
        slots:
          rsid: path.rsid
          globalCompanyId: path.globalCompanyId
      - text: Show which classification datasets go with report suite {rsid} for company {globalCompanyId}.
        slots:
          rsid: path.rsid
          globalCompanyId: path.globalCompanyId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/{globalCompanyId}/classification/datasets/template/{dataset_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a classification dataset template
      effect: read
      questions:
      - How do I get an import template for a classification dataset?
      - Can I choose the file format of the dataset template?
      instructions:
      - text: Get the template for classification dataset {dataset_id} in {globalCompanyId}.
        slots:
          dataset_id: path.dataset_id
          globalCompanyId: path.globalCompanyId
      - text: Download dataset {dataset_id} template from {globalCompanyId} in {format} format.
        slots:
          dataset_id: path.dataset_id
          globalCompanyId: path.globalCompanyId
          format: query.format
      method: generated
      generated: '2026-09-26'