# 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 License API
  version: 1.0.0
extends: openapi/dotcms-license-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: 8
- target: $.paths['/api/license/applyLicense'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a license key
      effect: write
      questions:
      - How do I activate dotCMS by pasting in license text?
      - Can I apply a license key through the REST API instead of the admin screen?
      instructions:
      - text: Apply license text {licenseText}.
        slots:
          licenseText: query.licenseText
      - text: Activate this server with license {licenseText} using {params}.
        slots:
          licenseText: query.licenseText
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/license/delete/{params}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a license from the pack
      effect: destructive
      questions:
      - Can I remove a license from the uploaded license pack?
      - Which call deletes a specific license entry?
      instructions:
      - text: Delete the license identified by {params}.
        slots:
          params: path.params
      - text: Remove license {params} from the license pack.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/license/free/{params}'].post
  update:
    x-apievangelist-phrasing:
      intent: Free a license from a server
      effect: destructive
      questions:
      - How do I release a license from a server so another node can use it?
      - Can I free up a license that's assigned to a decommissioned server?
      instructions:
      - text: Free the license given by {params}.
        slots:
          params: path.params
      - text: Release the license held by the server in {params} back to the pool.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/license/all/{params}'].get
  update:
    x-apievangelist-phrasing:
      intent: List all licenses
      effect: read
      questions:
      - Which licenses are in the pack and which servers are using them?
      - Can I see every license installed on this cluster?
      instructions:
      - text: List all licenses using {params}.
        slots:
          params: path.params
      - text: Show every license and its assignment for {params}.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/license/pick/{params}'].post
  update:
    x-apievangelist-phrasing:
      intent: Pick a license for this server
      effect: write
      questions:
      - Can I choose a specific license from the pack for this server?
      - How do I assign one of the uploaded licenses to the current node?
      instructions:
      - text: Pick license {params} for this server.
        slots:
          params: path.params
      - text: Assign the license in {params} from the pack to the current node.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/license/upload/{params}'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a license pack zip
      effect: write
      questions:
      - How do I upload a zip file of cluster licenses?
      - Can I load a whole license pack at once?
      instructions:
      - text: Upload license pack {file}.
        slots:
          file: requestBody.file
      - text: Load the licenses in zip {file} using {params}.
        slots:
          file: requestBody.file
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/license/requestCode/{params}'].post
  update:
    x-apievangelist-phrasing:
      intent: Generate a license request code
      effect: write
      questions:
      - How do I get the request code needed to obtain a license for this server?
      - Can I generate a license request code through the API?
      instructions:
      - text: Generate a license request code using {params}.
        slots:
          params: path.params
      - text: Create the request code for {params} so I can get a license issued.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/license/resetLicense/{params}'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset the server's license
      effect: destructive
      questions:
      - Can I reset this server's license back to an unlicensed state?
      - Which call clears the license currently applied?
      instructions:
      - text: Reset the license using {params}.
        slots:
          params: path.params
      - text: Clear the applied license on the server given by {params}.
        slots:
          params: path.params
      method: generated
      generated: '2026-09-26'