# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Soda Cloud API v4 Data Standards API
  version: 1.0.0
extends: openapi/soda-data-data-standards-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: 13
- target: $.paths['/api/v1/dataStandards'].get
  update:
    x-apievangelist-phrasing:
      intent: List data standards
      effect: read
      questions:
      - Which data standards are defined in my organization?
      - Can I filter my data standards by status or search them by name?
      - What data standards are currently active?
      instructions:
      - text: List all data standards.
      - text: Search data standards for {search}.
        slots:
          search: query.search
      - text: Show data standards with status {status}.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/dataStandards'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a data standard
      effect: write
      questions:
      - How do I define a new data standard that applies checks across many datasets?
      - Can I give a new data standard owners, a scope and a schedule when I create it?
      instructions:
      - text: Create data standard {name} with status {status}, owners {owners} and YAML {contents}.
        slots:
          name: requestBody.name
          status: requestBody.status
          owners: requestBody.owners
          contents: requestBody.contents
      - text: Create standard {name} owned by {owners}, scoped to {scope}, status {status}, YAML {contents}.
        slots:
          name: requestBody.name
          owners: requestBody.owners
          scope: requestBody.scope
          status: requestBody.status
          contents: requestBody.contents
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/dataStandards/actions/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a dataset's active data standards
      effect: write
      questions:
      - Can I trigger a scan of all active data standards linked to one dataset?
      - What scan ID comes back when I execute data standards on a dataset?
      instructions:
      - text: Execute the active data standards for dataset {datasetId}.
        slots:
          datasetId: requestBody.datasetId
      - text: Start a data standards scan on dataset {datasetId}.
        slots:
          datasetId: requestBody.datasetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/dataStandards/actions/previewScope'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview datasets matching a scope
      effect: read
      questions:
      - Which datasets would a draft data standard scope match before I save it?
      - What does an empty scope match when previewing a data standard?
      instructions:
      - text: Preview which datasets match the scope {scope}.
        slots:
          scope: requestBody.scope
      - text: Show the datasets a candidate standard scope {scope} would cover, without saving anything.
        slots:
          scope: requestBody.scope
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/dataStandards/actions/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test an unsaved data standard on a dataset
      effect: read
      questions:
      - Can I dry-run a draft data standard against one dataset's live data?
      - Does testing a data standard save any checks or results?
      instructions:
      - text: Test the draft standard YAML {contents} against dataset {datasetId}.
        slots:
          contents: requestBody.contents
          datasetId: requestBody.datasetId
      - text: Dry-run standard {contents} on dataset {datasetId} without saving it.
        slots:
          contents: requestBody.contents
          datasetId: requestBody.datasetId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/dataStandards/activity'].get
  update:
    x-apievangelist-phrasing:
      intent: Get organization data standards activity
      effect: read
      questions:
      - How many data standards are active and how many datasets do they cover?
      - What does the overall rollup of data standard check results look like?
      instructions:
      - text: Show the organization-wide data standards activity summary.
      - text: Give me counts of active standards, matched datasets and check results.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/dataStandards/{dataStandardId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a data standard
      effect: read
      questions:
      - What YAML and scope does a specific data standard use?
      - Can I view the full definition of one data standard?
      instructions:
      - text: Show data standard {dataStandardId}.
        slots:
          dataStandardId: path.dataStandardId
      - text: Fetch the YAML and scope of data standard {dataStandardId}.
        slots:
          dataStandardId: path.dataStandardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/dataStandards/{dataStandardId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Replace a data standard's definition
      effect: write
      questions:
      - How do I change the YAML or owners of an existing data standard?
      - Does updating a data standard replace its whole scope and schedule?
      instructions:
      - text: 'Update data standard {dataStandardId}: name {name}, status {status}, owners {owners}, YAML {contents}.'
        slots:
          dataStandardId: path.dataStandardId
          name: requestBody.name
          status: requestBody.status
          owners: requestBody.owners
          contents: requestBody.contents
      - text: Change the schedule of standard {dataStandardId} ({name}, {status}, owners {owners}, YAML {contents}) to {schedule}.
        slots:
          dataStandardId: path.dataStandardId
          name: requestBody.name
          status: requestBody.status
          owners: requestBody.owners
          contents: requestBody.contents
          schedule: requestBody.schedule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/dataStandards/{dataStandardId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a data standard
      effect: destructive
      questions:
      - How do I get rid of a data standard I no longer need?
      - Is deleting a data standard immediate or processed in the background?
      instructions:
      - text: Delete data standard {dataStandardId}.
        slots:
          dataStandardId: path.dataStandardId
      - text: Schedule standard {dataStandardId} and its dataset associations for removal.
        slots:
          dataStandardId: path.dataStandardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/dataStandards/{dataStandardId}/actions/evaluateScope'].post
  update:
    x-apievangelist-phrasing:
      intent: Re-evaluate a saved standard's scope
      effect: read
      questions:
      - Which datasets does my saved data standard match right now?
      - Can I refresh the dataset matches of an existing standard's scope?
      instructions:
      - text: Re-evaluate the scope of data standard {dataStandardId}.
        slots:
          dataStandardId: path.dataStandardId
      - text: Return the dataset IDs currently matched by saved standard {dataStandardId}.
        slots:
          dataStandardId: path.dataStandardId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/dataStandards/{dataStandardId}/actions/status'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a data standard's status
      effect: write
      questions:
      - Can I activate or pause a data standard without touching its contents?
      - Which status transitions are allowed for a data standard?
      instructions:
      - text: Set the status of data standard {dataStandardId} to {status}.
        slots:
          dataStandardId: path.dataStandardId
          status: requestBody.status
      - text: Transition standard {dataStandardId} to {status} and leave everything else unchanged.
        slots:
          dataStandardId: path.dataStandardId
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/dataStandards/{dataStandardId}/checks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a data standard's checks
      effect: read
      questions:
      - What aggregated checks does a data standard run?
      - Which checks come from one particular standard?
      instructions:
      - text: List the aggregated checks of data standard {dataStandardId}.
        slots:
          dataStandardId: path.dataStandardId
      - text: Show checks defined by standard {dataStandardId}, {size} per page.
        slots:
          dataStandardId: path.dataStandardId
          size: query.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/dataStandards/{dataStandardId}/datasets'].get
  update:
    x-apievangelist-phrasing:
      intent: List datasets matched by a standard
      effect: read
      questions:
      - Which datasets fall under a given data standard?
      - Can I page through all datasets a standard is applied to?
      instructions:
      - text: List the datasets matched by data standard {dataStandardId}.
        slots:
          dataStandardId: path.dataStandardId
      - text: Show page {page} of datasets covered by standard {dataStandardId}.
        slots:
          page: query.page
          dataStandardId: path.dataStandardId
      method: generated
      generated: '2026-09-26'