# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Datadog Archive API
  version: 1.0.0
extends: openapi/datadog-archive-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: 10
- target: $.paths['/api/v2/cases/{case_id}/archive'].post
  update:
    x-apievangelist-phrasing:
      intent: Archive a case
      effect: write
      questions:
      - How do I archive a case that's no longer active?
      - Can I archive a case using its key instead of its UUID?
      instructions:
      - text: Archive case {case_id}.
        slots:
          case_id: path.case_id
      - text: Move case {case_id} to the archive.
        slots:
          case_id: path.case_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/logs/config/archive-order'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the logs archive order
      effect: read
      questions:
      - In what order are my logs archives processed?
      - Which logs archive gets evaluated first?
      instructions:
      - text: Show the current order of our logs archives.
      - text: Get the processing sequence of logs archives.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/logs/config/archive-order'].put
  update:
    x-apievangelist-phrasing:
      intent: Reorder logs archives
      effect: write
      questions:
      - Can I change which logs archive processes logs first?
      - Does reordering archives change what data each one receives?
      instructions:
      - text: Set the logs archive order to {data}.
        slots:
          data: requestBody.data
      - text: Reorder our logs archives so the compliance archive is first.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/logs/config/archives'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a logs archive
      effect: write
      questions:
      - How do I start archiving logs to cloud storage?
      - Can I set up a new logs archive with a query filter?
      instructions:
      - text: Create a logs archive with definition {data}.
        slots:
          data: requestBody.data
      - text: Set up a new logs archive for long-term retention.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/logs/config/archives/{archive_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a logs archive
      effect: read
      questions:
      - What's the configuration of a specific logs archive?
      - Where is a particular archive storing our logs?
      instructions:
      - text: Show logs archive {archive_id}.
        slots:
          archive_id: path.archive_id
      - text: Get the destination and query of archive {archive_id}.
        slots:
          archive_id: path.archive_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/logs/config/archives/{archive_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a logs archive's configuration
      effect: write
      questions:
      - Can I change the destination bucket of an existing logs archive?
      - Does updating an archive replace its whole configuration?
      instructions:
      - text: Replace the configuration of archive {archive_id} with {data}.
        slots:
          archive_id: path.archive_id
          data: requestBody.data
      - text: Update logs archive {archive_id}.
        slots:
          archive_id: path.archive_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/logs/config/archives/{archive_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a logs archive
      effect: destructive
      questions:
      - Can I remove a logs archive I no longer need?
      - What happens to forwarding when a logs archive is deleted?
      instructions:
      - text: Delete logs archive {archive_id}.
        slots:
          archive_id: path.archive_id
      - text: Remove archive {archive_id} from our org.
        slots:
          archive_id: path.archive_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/logs/config/archives/{archive_id}/readers'].get
  update:
    x-apievangelist-phrasing:
      intent: List roles allowed to read an archive
      effect: read
      questions:
      - Which roles can read a given logs archive?
      - Is access to an archive restricted to certain roles?
      instructions:
      - text: List read roles for archive {archive_id}.
        slots:
          archive_id: path.archive_id
      - text: Show which roles can rehydrate from archive {archive_id}.
        slots:
          archive_id: path.archive_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/logs/config/archives/{archive_id}/readers'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant a role read access to an archive
      effect: write
      questions:
      - How do I let a role read from a logs archive?
      - Can I restrict archive access by adding specific roles?
      instructions:
      - text: Grant role {data} read access to archive {archive_id}.
        slots:
          archive_id: path.archive_id
          data: requestBody.data
      - text: Add a read role to logs archive {archive_id}.
        slots:
          archive_id: path.archive_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/logs/config/archives/{archive_id}/readers'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a role's read access to an archive
      effect: destructive
      questions:
      - Can I take away a role's access to a logs archive?
      - How do I stop a team's role from reading an archive?
      instructions:
      - text: Revoke role {data} from archive {archive_id}.
        slots:
          archive_id: path.archive_id
          data: requestBody.data
      - text: Remove a read role from logs archive {archive_id}.
        slots:
          archive_id: path.archive_id
      method: generated
      generated: '2026-10-01'