# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for dotCMS REST Cache Management API
  version: 1.0.0
extends: openapi/dotcms-cache-management-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/v1/caches/menucache'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear the navigation menu cache
      effect: destructive
      questions:
      - My site navigation is stale — can I clear just the menu cache?
      - Is there a way to reset only the menu cache?
      instructions:
      - text: Delete the menu cache.
      - text: Clear the navigation menu cache now.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/caches/provider/{provider}/flush'].delete
  update:
    x-apievangelist-phrasing:
      intent: Flush all caches
      effect: destructive
      questions:
      - How do I flush every cache in dotCMS at once?
      - Does flushing everything also reload push publishing filters?
      instructions:
      - text: Flush all caches (provider {provider} is ignored).
        slots:
          provider: path.provider
      - text: Flush every cache region across all providers, passing provider {provider}.
        slots:
          provider: path.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/caches/provider/{provider}/flush/{group}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Flush one cache group for a provider
      effect: destructive
      questions:
      - Can I flush a single cache group on one cache provider?
      - How do I clear one group without flushing everything?
      instructions:
      - text: Flush cache group {group} on provider {provider}.
        slots:
          group: path.group
          provider: path.provider
      - text: Clear group {group} in cache provider {provider}.
        slots:
          group: path.group
          provider: path.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/caches/provider/{provider}/flush/{group}/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Evict one object from the cache
      effect: destructive
      questions:
      - Can I evict a single key from a cache group?
      - How do I remove just one cached object?
      instructions:
      - text: Evict key {id} from cache group {group} on provider {provider}.
        slots:
          id: path.id
          group: path.group
          provider: path.provider
      - text: Remove cached object {id} in {group} from provider {provider}.
        slots:
          id: path.id
          group: path.group
          provider: path.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/caches/region/{regionName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Flush a cache region across providers
      effect: destructive
      questions:
      - How do I flush one named cache region on every provider?
      - Can I pass 'all' to flush every region by name?
      instructions:
      - text: Flush cache region {regionName}.
        slots:
          regionName: path.regionName
      - text: Clear the {regionName} region across all cache providers.
        slots:
          regionName: path.regionName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/caches/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get cache statistics
      effect: read
      questions:
      - What are the cache hit and miss rates right now?
      - How much JVM memory are the caches using?
      instructions:
      - text: Show cache statistics.
      - text: Report hit counts, misses and memory per cache region.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/caches/provider/{provider}/keys/{group}'].get
  update:
    x-apievangelist-phrasing:
      intent: List keys in a cache group
      effect: read
      questions:
      - Which keys are stored in a given cache group?
      - Can I see what a cache provider is holding for one group?
      instructions:
      - text: List keys in cache group {group} on provider {provider}.
        slots:
          group: path.group
          provider: path.provider
      - text: Show the cached keys of {group} in {provider}.
        slots:
          group: path.group
          provider: path.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/caches'].get
  update:
    x-apievangelist-phrasing:
      intent: List cache region names
      effect: read
      questions:
      - What cache regions exist that I could flush?
      - Where do I get the names of all cache regions?
      instructions:
      - text: List all cache region names.
      - text: Show the cache regions alphabetically.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/caches/provider/{provider}/object/{group}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Inspect one cached object
      effect: read
      questions:
      - What value is cached under a particular key?
      - Can I look at a single object in a cache group?
      instructions:
      - text: Show cached object {id} in group {group} on provider {provider}.
        slots:
          id: path.id
          group: path.group
          provider: path.provider
      - text: Inspect key {id} of {group} in cache provider {provider}.
        slots:
          id: path.id
          group: path.group
          provider: path.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/caches/provider/{provider}/objects/{group}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show all objects in a cache group
      effect: read
      questions:
      - Can I dump everything cached in one group?
      - What objects does a provider hold for a cache group?
      instructions:
      - text: Show all cached objects in group {group} on provider {provider}.
        slots:
          group: path.group
          provider: path.provider
      - text: Dump the contents of cache group {group} from {provider}.
        slots:
          group: path.group
          provider: path.provider
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/caches/providers/{group}'].get
  update:
    x-apievangelist-phrasing:
      intent: List cache providers for a group
      effect: read
      questions:
      - Which cache providers serve a given cache group?
      - Is a cache group backed by more than one provider?
      instructions:
      - text: List the cache providers for group {group}.
        slots:
          group: path.group
      - text: Show which providers back cache group {group}.
        slots:
          group: path.group
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/caches/provider/{provider}/{group}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show a provider's view of a cache group
      effect: read
      questions:
      - What does one specific cache provider report for a group?
      - Can I check a named provider's details for a cache group?
      instructions:
      - text: Show provider {provider} details for cache group {group}.
        slots:
          provider: path.provider
          group: path.group
      - text: Describe how provider {provider} handles group {group}.
        slots:
          provider: path.provider
          group: path.group
      method: generated
      generated: '2026-09-26'