API Evangelist conversational phrasing for Consent & Preferences - Cookie Consent Applications API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Consent & Preferences - Cookie Consent Applications API
  version: 1.0.0
extends: openapi/onetrust-applications-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: 12
- target: $.paths['/api/cmp/v1/application'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a mobile or CTV app for scanning
      effect: write
      questions:
      - How do I register a new mobile app so it can be scanned and get the consent SDK?
      - Can I set the platform and solution type when adding an application?
      instructions:
      - text: Create an application called {name} on platform {platform}.
        slots:
          name: requestBody.name
          platform: requestBody.platform
      - text: Register app {name} with solution type {solutionType} under organization {orgId}.
        slots:
          name: requestBody.name
          solutionType: requestBody.solutionType
          orgId: requestBody.orgId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/application/{id}/scan'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload an app build and start a scan
      effect: write
      questions:
      - How do I kick off an SDK scan by uploading my app binary?
      - Can I rescan an existing application with a new build file?
      instructions:
      - text: Upload {file} and start a scan of application {id}.
        slots:
          file: requestBody.file
          id: path.id
      - text: Scan the new build {file} for app {id}.
        slots:
          file: requestBody.file
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered applications
      effect: read
      questions:
      - Which mobile apps have I registered for consent scanning?
      - Can I search my registered applications by name?
      instructions:
      - text: List my registered applications whose name contains {searchStr}.
        slots:
          searchStr: query.searchStr
      - text: Show all applications sorted by {sortBy} {direction}.
        slots:
          sortBy: query.sortBy
          direction: query.direction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/applications/{id}/branding-attributes'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an application's branding attributes
      effect: read
      questions:
      - What branding settings are configured for my app's consent UI?
      - Where can I see the colors and styling attributes applied to an application?
      instructions:
      - text: Show the branding attributes for application {id}.
        slots:
          id: path.id
      - text: Get the current consent UI styling of app {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/applications/{id}/branding-attributes'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an application's branding attributes
      effect: write
      questions:
      - How do I change the branding of my app's consent experience?
      - Can I update several branding attributes for an application at once?
      instructions:
      - text: Set the branding attributes of application {id} to {attributes}.
        slots:
          id: path.id
          attributes: requestBody.attributes
      - text: Restyle app {id} using branding values {attributes}.
        slots:
          id: path.id
          attributes: requestBody.attributes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/applications/{id}/scans'].get
  update:
    x-apievangelist-phrasing:
      intent: List the scans run on an application
      effect: read
      questions:
      - What scans have been run against my app and what was their status?
      - Can I page through the scan history of one application?
      instructions:
      - text: List all scans for application {id}.
        slots:
          id: path.id
      - text: Show scan history for app {id}, sorted by {sortBy} {direction}.
        slots:
          id: path.id
          sortBy: query.sortBy
          direction: query.direction
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/applications/{id}/scans/{scanId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result summary of one app scan
      effect: read
      questions:
      - What did a particular app scan find in terms of SDKs and permissions?
      - Did my latest application scan finish successfully?
      instructions:
      - text: Show the summary of scan {scanId} for application {id}.
        slots:
          scanId: path.scanId
          id: path.id
      - text: Tell me the status and date of scan {scanId} on app {id}.
        slots:
          scanId: path.scanId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/applications/{id}/scans/{scanId}/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List permissions detected in an app scan
      effect: read
      questions:
      - Which device permissions did the scan detect in my app?
      - Are any sensitive permissions requested by my application build?
      instructions:
      - text: List the permissions found in scan {scanId} of application {id}.
        slots:
          scanId: path.scanId
          id: path.id
      - text: Show sensitive permissions detected by scan {scanId} for app {id}.
        slots:
          scanId: path.scanId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/applications/{id}/scans/{scanId}/privacy-manifest'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the iOS privacy manifest analysis for a scan
      effect: read
      questions:
      - Does my iOS app's privacy manifest match what the scan detected?
      - How many data types does the privacy manifest analysis cover?
      instructions:
      - text: Show the iOS privacy manifest summary for scan {scanId} of app {id}.
        slots:
          scanId: path.scanId
          id: path.id
      - text: Get manifest version {version} analysis for scan {scanId} on application {id}.
        slots:
          version: query.version
          scanId: path.scanId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/applications/{id}/scans/{scanId}/privacy-manifest/{dataType}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get manifest mismatches for one data type
      effect: read
      questions:
      - Why is a specific data type flagged as a mismatch in my iOS privacy manifest?
      - What mismatch categories exist for one data type in a manifest scan?
      instructions:
      - text: Show the manifest mismatches for data type {dataType} in scan {scanId} of app {id}.
        slots:
          dataType: path.dataType
          scanId: path.scanId
          id: path.id
      - text: Break down {dataType} mismatches for scan {scanId} of application {id} on manifest version {version}.
        slots:
          dataType: path.dataType
          scanId: path.scanId
          id: path.id
          version: query.version
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/applications/{id}/scans/{scanId}/sdks'].get
  update:
    x-apievangelist-phrasing:
      intent: List SDKs detected in an app scan
      effect: read
      questions:
      - Which third-party SDKs are bundled in my app according to the scan?
      - Can I filter detected SDKs by vendor or default category?
      instructions:
      - text: List the SDKs found in scan {scanId} of application {id}.
        slots:
          scanId: path.scanId
          id: path.id
      - text: Show SDKs from vendor {vendorSearch} in scan {scanId} of app {id}.
        slots:
          vendorSearch: query.vendorSearch
          scanId: path.scanId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/cmp/v1/applications/{id}/scans/{scanId}/sdks/{sdk}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one SDK found in a scan
      effect: read
      questions:
      - What is the package ID and vendor of an SDK the scan found?
      - How is a specific detected SDK categorized by default?
      instructions:
      - text: Show details for SDK {sdk} in scan {scanId} of application {id}.
        slots:
          sdk: path.sdk
          scanId: path.scanId
          id: path.id
      - text: Describe detected SDK {sdk} from app {id} scan {scanId}.
        slots:
          sdk: path.sdk
          id: path.id
          scanId: path.scanId
      method: generated
      generated: '2026-09-26'