# 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 Administration API
  version: 1.0.0
extends: openapi/dotcms-administration-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: 10
- target: $.paths['/api/restexample/layout/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the REST example layout endpoint
      effect: read
      questions:
      - What does the restexample layout endpoint return for given parameters?
      - Can I test the sample REST layout resource with path parameters?
      instructions:
      - text: Call the REST example layout endpoint with parameters {params}.
        slots:
          params: path.params
      - text: Fetch the sample restexample layout for {params}.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/restexample/test/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the REST example JSON test endpoint
      effect: read
      questions:
      - Is there a sample endpoint that returns test JSON?
      - What comes back from the restexample test resource?
      instructions:
      - text: Load the REST example test JSON for parameters {params}.
        slots:
          params: path.params
      - text: Call the restexample test endpoint with {params}.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/util/encodeQueryParamValue/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: Encode a query parameter value
      effect: read
      questions:
      - Can dotCMS URL-encode a value for me to use in a query string?
      - Which utility endpoint encodes query parameter values?
      instructions:
      - text: Encode {params} as a query parameter value.
        slots:
          params: path.params
      - text: Run the query-parameter encoding utility on {params}.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ws/v1/system/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Poll for system events
      effect: read
      questions:
      - How do I poll for dotCMS system events without websockets?
      - Can I get only the system events since my last callback?
      instructions:
      - text: Get system events since callback {lastcallback}.
        slots:
          lastcallback: query.lastcallback
      - text: Poll for new system events.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/ws/v1/system/syncevents'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch system events synchronously
      effect: read
      questions:
      - Is there a synchronous version of the system events feed?
      - Can I pull sync events newer than a given callback timestamp?
      instructions:
      - text: Fetch synchronous system events since callback {lastcallback}.
        slots:
          lastcallback: query.lastcallback
      - text: Pull the sync system events feed.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/jvm'].get
  update:
    x-apievangelist-phrasing:
      intent: Get JVM information
      effect: read
      questions:
      - What JVM is my dotCMS server running on?
      - Can I see the Java runtime details for the instance?
      instructions:
      - text: Show the JVM information for this dotCMS server.
      - text: Get the Java runtime details of the instance.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/toolgroups/{layoutId}/_addtouser'].put
  update:
    x-apievangelist-phrasing:
      intent: Give a user a tool group
      effect: write
      questions:
      - How do I add a tool group (menu layout) to a user?
      - Can I grant someone access to a back-end tool group?
      instructions:
      - text: Add tool group {layoutId} to user {userid}.
        slots:
          layoutId: path.layoutId
          userid: query.userid
      - text: Give me tool group {layoutId}.
        slots:
          layoutId: path.layoutId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/toolgroups/{layoutId}/_removefromuser'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove a tool group from a user
      effect: write
      questions:
      - How do I take a tool group away from a user?
      - Can I revoke a back-end menu layout from someone?
      instructions:
      - text: Remove tool group {layoutId} from user {userid}.
        slots:
          layoutId: path.layoutId
          userid: query.userid
      - text: Take tool group {layoutId} off my account.
        slots:
          layoutId: path.layoutId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/toolgroups/{layoutId}/_userHasLayout'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a user has a tool group
      effect: read
      questions:
      - Does a given user already have a particular tool group?
      - Can I check if someone can see a specific back-end layout?
      instructions:
      - text: Check whether user {userid} has tool group {layoutId}.
        slots:
          userid: query.userid
          layoutId: path.layoutId
      - text: Tell me if I have tool group {layoutId}.
        slots:
          layoutId: path.layoutId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/telemetry/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve telemetry usage metrics
      effect: read
      questions:
      - What telemetry metrics does dotCMS collect about this instance?
      - Can I get a fast minimal telemetry profile instead of all 100+ metrics?
      - How do I force fresh telemetry numbers instead of cached ones?
      instructions:
      - text: Get telemetry stats using the {profile} profile.
        slots:
          profile: query.profile
      - text: 'Fetch telemetry metrics {metricNames}, bypassing the cache: {bypassCache}.'
        slots:
          metricNames: query.metricNames
          bypassCache: query.bypassCache
      method: generated
      generated: '2026-09-26'