Adobe Analytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Analytics Classification Classification Dataset API

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

Generated by API Evangelist Written by API Evangelist tooling for Adobe Analytics's API. It is a proposal applied on top of the contract, not a document Adobe Analytics 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-analytics-classification-dataset-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: 5
- target: $.paths['/{globalCompanyId}/classification/datasets/{dataset_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a classification dataset
      effect: read
      questions:
      - How do I view the columns and settings of one classification dataset?
      - Who owns a classification dataset and when was it last modified?
      instructions:
      - text: Show classification dataset {dataset_id} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          dataset_id: path.dataset_id
      - text: Get the columns and encoding of classification dataset {dataset_id}.
        slots:
          dataset_id: path.dataset_id
      method: generated
      generated: '2026-10-01'
- 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 default encoding?
      - How do I change the notification settings on an existing classification dataset?
      instructions:
      - text: Rename classification dataset {dataset_id} in company {globalCompanyId} to {name}.
        slots:
          globalCompanyId: path.globalCompanyId
          dataset_id: path.dataset_id
          name: requestBody.name
      - text: Set the default list delimiter on classification dataset {dataset_id} to {default_list_delimiter}.
        slots:
          dataset_id: path.dataset_id
          default_list_delimiter: requestBody.default_list_delimiter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{globalCompanyId}/classification/datasets/{dataset_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a classification dataset and its data
      effect: destructive
      questions:
      - What happens to the classification data when I delete a classification dataset?
      - How do I remove a classification dataset entirely?
      instructions:
      - text: Delete classification dataset {dataset_id} in company {globalCompanyId}, including all its data.
        slots:
          globalCompanyId: path.globalCompanyId
          dataset_id: path.dataset_id
      - text: Remove classification dataset {dataset_id} and every classification value in it.
        slots:
          dataset_id: path.dataset_id
      method: generated
      generated: '2026-10-01'
- 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 can be used with classifications on a given report suite?
      - How do I find the classification dataset ID linked to a report suite's metrics?
      instructions:
      - text: Get compatibility metrics for report suite {rsid} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          rsid: path.rsid
      - text: Show which classification dataset is associated with metrics on {rsid}.
        slots:
          rsid: path.rsid
      method: generated
      generated: '2026-10-01'
- 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 a template file to fill in classification values for a dataset?
      - Can I choose the file format of the classification template?
      instructions:
      - text: Download the template for classification dataset {dataset_id} in company {globalCompanyId}.
        slots:
          globalCompanyId: path.globalCompanyId
          dataset_id: path.dataset_id
      - text: Get the {format} template for classification dataset {dataset_id}.
        slots:
          format: query.format
          dataset_id: path.dataset_id
      method: generated
      generated: '2026-10-01'