# 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 JavaScript API
  version: 1.0.0
extends: openapi/dotcms-javascript-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: 18
- target: $.paths['/api/js/{folder}'].get
  update:
    x-apievangelist-phrasing:
      intent: Call a scripted JS endpoint's GET handler
      effect: read
      questions:
      - How do I call a server-side JavaScript endpoint I've set up in a dotCMS folder?
      - Can I fetch data from a custom JS endpoint with a plain GET?
      instructions:
      - text: Call the GET handler of the JavaScript endpoint in folder {folder}.
        slots:
          folder: path.folder
      - text: Read the output of scripted endpoint {folder}.
        slots:
          folder: path.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/js/{folder}'].put
  update:
    x-apievangelist-phrasing:
      intent: Send a multipart PUT to a scripted JS endpoint
      effect: write
      questions:
      - Can I PUT multipart form data to a custom JavaScript endpoint folder?
      - What happens when I send file parts with PUT to a JS scripting endpoint?
      instructions:
      - text: Send a multipart PUT with these form parts to the JS endpoint in folder {folder}.
        slots:
          folder: path.folder
      - text: Invoke the PUT handler of scripted endpoint {folder} with body parts {bodyParts}.
        slots:
          folder: path.folder
          bodyParts: requestBody.bodyParts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/js/{folder}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a multipart POST to a scripted JS endpoint
      effect: write
      questions:
      - How do I POST a file upload to a server-side JavaScript endpoint?
      - Can a custom JS endpoint folder accept multipart POST submissions?
      instructions:
      - text: POST this multipart form to the JavaScript endpoint in folder {folder}.
        slots:
          folder: path.folder
      - text: Submit multipart body parts {bodyParts} to the POST handler of scripted endpoint {folder}.
        slots:
          bodyParts: requestBody.bodyParts
          folder: path.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/js/{folder}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Call a scripted JS endpoint's DELETE handler
      effect: destructive
      questions:
      - Can I trigger the DELETE logic of a custom JavaScript endpoint folder?
      - What does sending DELETE to a JS scripting endpoint folder do?
      instructions:
      - text: Invoke the DELETE handler of the JavaScript endpoint in folder {folder}.
        slots:
          folder: path.folder
      - text: Send a DELETE request to scripted endpoint {folder}.
        slots:
          folder: path.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/js/{folder}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Send a multipart PATCH to a scripted JS endpoint
      effect: write
      questions:
      - Can I PATCH multipart data to a server-side JavaScript endpoint folder?
      - Does the JS scripting API support partial updates via PATCH on a folder?
      instructions:
      - text: Send a multipart PATCH to the JavaScript endpoint in folder {folder}.
        slots:
          folder: path.folder
      - text: Invoke the PATCH handler of scripted endpoint {folder} with form fields {fields}.
        slots:
          folder: path.folder
          fields: requestBody.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/js/{folder}/{pathParam}'].get
  update:
    x-apievangelist-phrasing:
      intent: Call a scripted JS endpoint's GET handler on a sub-path
      effect: read
      questions:
      - Can I pass an extra path segment when calling a custom JavaScript endpoint?
      - How do I GET a specific resource path under a JS endpoint folder?
      instructions:
      - text: Call the GET handler of JS endpoint {folder} with sub-path {pathParam}.
        slots:
          folder: path.folder
          pathParam: path.pathParam
      - text: Read {pathParam} from the scripted endpoint in folder {folder}.
        slots:
          pathParam: path.pathParam
          folder: path.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/js/{folder}/{pathParam}'].put
  update:
    x-apievangelist-phrasing:
      intent: Send a multipart PUT to a scripted JS endpoint sub-path
      effect: write
      questions:
      - Can I PUT multipart data to a sub-path of a custom JavaScript endpoint?
      - How do I send a PUT with form parts to a specific resource under a JS endpoint folder?
      instructions:
      - text: Send a multipart PUT to sub-path {pathParam} of JS endpoint {folder}.
        slots:
          pathParam: path.pathParam
          folder: path.folder
      - text: PUT body parts {bodyParts} to {pathParam} under scripted endpoint {folder}.
        slots:
          bodyParts: requestBody.bodyParts
          pathParam: path.pathParam
          folder: path.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/js/{folder}/{pathParam}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a multipart POST to a scripted JS endpoint sub-path
      effect: write
      questions:
      - How do I POST a multipart form to a sub-path of a custom JavaScript endpoint?
      - Can a JS endpoint receive file uploads on a nested path segment?
      instructions:
      - text: POST this multipart form to sub-path {pathParam} of JS endpoint {folder}.
        slots:
          pathParam: path.pathParam
          folder: path.folder
      - text: Submit body parts {bodyParts} to {pathParam} under the POST handler of scripted endpoint {folder}.
        slots:
          bodyParts: requestBody.bodyParts
          pathParam: path.pathParam
          folder: path.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/js/{folder}/{pathParam}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Call a scripted JS endpoint's DELETE handler on a sub-path
      effect: destructive
      questions:
      - Can I send DELETE to a specific resource path under a custom JavaScript endpoint?
      - What does DELETE on a sub-path of a JS scripting endpoint do?
      instructions:
      - text: Invoke the DELETE handler of JS endpoint {folder} for sub-path {pathParam}.
        slots:
          folder: path.folder
          pathParam: path.pathParam
      - text: Send DELETE to {pathParam} under scripted endpoint {folder}.
        slots:
          pathParam: path.pathParam
          folder: path.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/js/{folder}/{pathParam}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Send a multipart PATCH to a scripted JS endpoint sub-path
      effect: write
      questions:
      - Can I PATCH multipart data to a nested path of a custom JavaScript endpoint?
      - How do I partially update a resource at a sub-path of a JS endpoint folder?
      instructions:
      - text: Send a multipart PATCH to sub-path {pathParam} of JS endpoint {folder}.
        slots:
          pathParam: path.pathParam
          folder: path.folder
      - text: PATCH form fields {fields} onto {pathParam} under scripted endpoint {folder}.
        slots:
          fields: requestBody.fields
          pathParam: path.pathParam
          folder: path.folder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/js/dynamic/{pathParam}'].get
  update:
    x-apievangelist-phrasing:
      intent: Run dynamic JavaScript via GET with a path
      effect: read
      questions:
      - Can I execute dynamic JavaScript through a GET request with a path segment?
      - How do I run ad hoc server-side JS on a dynamic sub-path using GET?
      instructions:
      - text: Run the dynamic JavaScript GET endpoint for path {pathParam}.
        slots:
          pathParam: path.pathParam
      - text: Execute dynamic JS with a GET on sub-path {pathParam}.
        slots:
          pathParam: path.pathParam
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/js/dynamic/{pathParam}'].put
  update:
    x-apievangelist-phrasing:
      intent: Run dynamic JavaScript via PUT with a path
      effect: write
      questions:
      - Can I send a PUT to the dynamic JavaScript endpoint with a path segment?
      - How do I execute dynamic server-side JS as a PUT on a specific sub-path?
      instructions:
      - text: Run dynamic JavaScript as a PUT on path {pathParam}.
        slots:
          pathParam: path.pathParam
      - text: Execute my dynamic JS PUT against sub-path {pathParam}.
        slots:
          pathParam: path.pathParam
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/js/dynamic/{pathParam}'].post
  update:
    x-apievangelist-phrasing:
      intent: Run dynamic JavaScript via POST with a path
      effect: write
      questions:
      - Can I POST dynamic JavaScript to run against a particular sub-path?
      - How do I execute ad hoc server-side JS with POST on a dynamic path?
      instructions:
      - text: Run dynamic JavaScript as a POST on path {pathParam}.
        slots:
          pathParam: path.pathParam
      - text: POST my dynamic JS for execution at sub-path {pathParam}.
        slots:
          pathParam: path.pathParam
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/js/dynamic/{pathParam}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Run dynamic JavaScript via DELETE with a path
      effect: destructive
      questions:
      - Can the dynamic JavaScript endpoint handle a DELETE on a sub-path?
      - What runs when I send DELETE to a dynamic JS path?
      instructions:
      - text: Run dynamic JavaScript as a DELETE on path {pathParam}.
        slots:
          pathParam: path.pathParam
      - text: Send a dynamic JS DELETE for sub-path {pathParam}.
        slots:
          pathParam: path.pathParam
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/js/dynamic/{pathParam}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Run dynamic JavaScript via PATCH with a path
      effect: write
      questions:
      - Can I PATCH through the dynamic JavaScript endpoint on a sub-path?
      - How do I execute dynamic server-side JS as a PATCH?
      instructions:
      - text: Run dynamic JavaScript as a PATCH on path {pathParam}.
        slots:
          pathParam: path.pathParam
      - text: Send a dynamic JS PATCH to sub-path {pathParam}.
        slots:
          pathParam: path.pathParam
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/js/dynamic'].get
  update:
    x-apievangelist-phrasing:
      intent: Run dynamic JavaScript via GET
      effect: read
      questions:
      - Can I call the dynamic JavaScript endpoint with a GET and no sub-path?
      - What does a bare GET to the dynamic JS scripting endpoint return?
      instructions:
      - text: Call the root dynamic JavaScript endpoint with a GET.
      - text: Run dynamic JS via GET without any path segment.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/js/dynamic'].put
  update:
    x-apievangelist-phrasing:
      intent: Run dynamic JavaScript via PUT
      effect: write
      questions:
      - Can I send a PUT to the root dynamic JavaScript endpoint?
      - Does the dynamic JS endpoint accept PUT requests without a sub-path?
      instructions:
      - text: Send a PUT to the root dynamic JavaScript endpoint.
      - text: Run dynamic JS via PUT without any path segment.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/js/dynamic'].post
  update:
    x-apievangelist-phrasing:
      intent: Run dynamic JavaScript via POST
      effect: write
      questions:
      - How do I POST server-side JavaScript to the dynamic endpoint for execution?
      - Can I run ad hoc JS by posting to the root dynamic scripting endpoint?
      instructions:
      - text: POST my JavaScript to the root dynamic endpoint and run it.
      - text: Run dynamic JS via POST without any path segment.
      method: generated
      generated: '2026-09-26'